Overview  Package  Tree cmsdAm 0.8

cmsdAm

Class cmsdam_conf

cmsdAm.cmsdam_conf

class cmsdam_conf

This class is used internally by cmsdam classes, but if you need it you can use it from your templates.

It's used to get all the configuration parameters and the sections super arrays. You shouldn't change any of that parameters from your sections, you are advised.

Class instance: $cms->conf

Author:
dAm2K (Dino Ciuffetti) <dam2k@users.sourceforge.net>

Field Summary
public array$Section_arr

This array contains all the section names.

public array$Section_users_arr

This array contains the list of users that can view each section, comma separed.

public array$Section_groups_arr

This array contains the list of groups that can view each section, comma separed.

public array$Search_users_arr

This array contains all the granted users for each section.

public array$Search_groups_arr

This array contains all the granted groups for each section.

public array$Section_file_arr

This array contains all the section files.

public array$Shortdescription_arr

This array contains all the section short descriptions.

public array$Longdescription_arr

This array contains all the section long descriptions.

public str$DB_servername

This is the database host name.

public str$DB_name

This is the database name.

public str$DB_username

This is the database user name.

public str$DB_password

This is the database password.

public str$DB_tbl_prefix

This is the database table prefix for cmsdam.

public str$DB_type

This is the database type, for now it can be mysql or postgres.

public str$LOG_debug

This is to turn debug on, it should be only YES or NO.

public str$LOG_path

Contains the path, absolute or relative to cmsdam directory for cmsdam loging.

public str$LOG_file

This is the cmsdam log filename.

public int$LOG_level

Logging level, from 0 (no logging) to 10 (high logging).

public int$LOG_debuglevel

Debugging level, from 0 (no debugging) to 10 (high debugging).

public str$site_title

This string is the web site title (<title> HTML tag).

public str$HTML_Meta_description

This string is the web site META description.

public str$HTML_Meta_keywords

This string is the web site META keywords.

public str$HTML_Meta_author

This string is the web site META author.

public str$HTML_Meta_revisit

This string is the web site META revisit after.

public str$HTTP_maxage

This string is the HTTP max-age header.

public str$HTTP_contenttype

This string is the HTTP content-type header (text formatting).

public str$HTTP_charset

This string is the HTTP charset encoding header (text formatting).

public str$cmsdam_admin_email

CMS mail administrator, default "From: " address for mails sent from cmsdam.

public constant$cmsdam_description

cmsdAm software description.

public constant$cmsdam_version

cmsdAm software version.

public constant$cmsdam_verstate

cmsdAm software version state.

public constant$cmsdam_longversion

cmsdAm software long description string.

public int$PHP_time_limit

This is the PHP time_limit parameter, time in seconds for a PHP page timeout.

public var$PHPWarn_on_sectioninclude

PHP Warnings on section include

public str$LDAP_servername

LDAP server name.

public str$LDAP_basedn

LDAP base DN, the ldap base branch to search from.

public str$LDAP_rootdn

LDAP root DN, the ldap administrator DN.

public str$LDAP_rootdnpass

LDAP root DN password, the ldap administrator DN password.

public str$LDAP_groupbasedn

LDAP group base DN, the ldap group base branch to search from.

public str$LDAP_exclusive

LDAP use.

public str$LDAP_filter

LDAP filter to check if a user entry is valid.

public str$LDAP_groupfilter

LDAP filter to check if a group entry is valid.

public str$LDAP_groupstag

LDAP attribute to identify groups entities.

public str$LDAP_groupsuserstag

LDAP attribute to identify groups user DNs.

public str$parsetimecomment

if == "YES" print cmsdam parsing time HTML comment at the bottom of the page It is very useful for debugging informations!

public str$use_memcached

if == "YES" cmsdam will use memcached daemon to implement variable caching mechanism

public str$memcached_servers

memcached servers name and port

public str$memcached_compress_threshold

at how many bytes should we compress?

public str$memcached_persistant

are we using persistant links?

public str$ERROR_reporting_cmsdAm

Error reporting for cmsdam related errors

public str$ERROR_reporting_sections

Error reporting for cmsdam sections related errors

Method Summary
public nullcmsdam_conf

This is the cmsdam_conf constructor, you cannot use it from your sections.

Field Detail

Section_arr

public array $Section_arr

This array contains all the section names.


Section_users_arr

public array $Section_users_arr

This array contains the list of users that can view each section, comma separed.


Section_groups_arr

public array $Section_groups_arr

This array contains the list of groups that can view each section, comma separed.


Search_users_arr

public array $Search_users_arr

This array contains all the granted users for each section.


Search_groups_arr

public array $Search_groups_arr

This array contains all the granted groups for each section.


Section_file_arr

public array $Section_file_arr

This array contains all the section files.


Shortdescription_arr

public array $Shortdescription_arr

This array contains all the section short descriptions.


Longdescription_arr

public array $Longdescription_arr

This array contains all the section long descriptions.


DB_servername

public str $DB_servername

This is the database host name.


DB_name

public str $DB_name

This is the database name.


DB_username

public str $DB_username

This is the database user name.


DB_password

public str $DB_password

This is the database password.


DB_tbl_prefix

public str $DB_tbl_prefix

This is the database table prefix for cmsdam.

This is useful, for example, if your provider give you only a database and you have to share it with other applications.


DB_type

public str $DB_type

This is the database type, for now it can be mysql or postgres.


LOG_debug

public str $LOG_debug

This is to turn debug on, it should be only YES or NO.


LOG_path

public str $LOG_path

Contains the path, absolute or relative to cmsdam directory for cmsdam loging.


LOG_file

public str $LOG_file

This is the cmsdam log filename.

It is relative to the $LOG_debug directory.


LOG_level

public int $LOG_level

Logging level, from 0 (no logging) to 10 (high logging).

Don't set this too high in production environment!! Logfile will grow very very quickly and you could shut down performance on sites with large number of users or templates.


LOG_debuglevel

public int $LOG_debuglevel

Debugging level, from 0 (no debugging) to 10 (high debugging).

You can consider to turn debugging OFF in production environments!! Please consider that even with LOG_debuglevel set very low, you can have an exeption that write a debug line to your template, and that's not so beautiful in production environments!


site_title

public str $site_title

This string is the web site title (<title> HTML tag).


HTML_Meta_description

public str $HTML_Meta_description

This string is the web site META description.

They are used by some web robot, search engine, and so on.


HTML_Meta_keywords

public str $HTML_Meta_keywords

This string is the web site META keywords.

They are used by some web robot, search engine, and so on.


HTML_Meta_author

public str $HTML_Meta_author

This string is the web site META author.

They are used by some web robot, search engine, and so on.


HTML_Meta_revisit

public str $HTML_Meta_revisit

This string is the web site META revisit after.

They are used by some web robot, search engine, and so on.


HTTP_maxage

public str $HTTP_maxage

This string is the HTTP max-age header.

Needed by cache peers to get the page expiration time in seconds.


HTTP_contenttype

public str $HTTP_contenttype

This string is the HTTP content-type header (text formatting).

Needed by http clients to use the proper mime based handler. The default is text/html, change it only if you know what you are doing.


HTTP_charset

public str $HTTP_charset

This string is the HTTP charset encoding header (text formatting).

Needed by http clients to use the proper page formatting charset. The default is iso-8859-1, change it according to your default charset. A valid alternative would be UTF-8 encoding.


cmsdam_admin_email

public str $cmsdam_admin_email

CMS mail administrator, default "From: " address for mails sent from cmsdam.

You can specify the From: address using the cmsdam_mails class, but if you don't specify it this is the default value used.


cmsdam_description

public constant $cmsdam_description

cmsdAm software description.

This is a constant defined in index.php, you cannot modify it!


cmsdam_version

public constant $cmsdam_version

cmsdAm software version.

You cannot modify it!


cmsdam_verstate

public constant $cmsdam_verstate

cmsdAm software version state.

You cannot modify it!


cmsdam_longversion

public constant $cmsdam_longversion

cmsdAm software long description string.

This is a constant defined in index.php, you cannot modify it!


PHP_time_limit

public int $PHP_time_limit

This is the PHP time_limit parameter, time in seconds for a PHP page timeout.


PHPWarn_on_sectioninclude

public var $PHPWarn_on_sectioninclude

PHP Warnings on section include


LDAP_servername

public str $LDAP_servername

LDAP server name.

'null` if you don't want to use LDAP. NOTE: LDAP SUPPORT IS READ ONLY FOR NOW!! You must add users and group in LDAP by yourself. Cmsdam will never touch LDAP directory!


LDAP_basedn

public str $LDAP_basedn

LDAP base DN, the ldap base branch to search from.

NOTE: LDAP SUPPORT IS READ ONLY FOR NOW!! You must add users and group in LDAP by yourself. Cmsdam will never touch LDAP directory!


LDAP_rootdn

public str $LDAP_rootdn

LDAP root DN, the ldap administrator DN.

If you want cmsdam do anonymous bind (it can run with this, check for LDAP server limits first!) leave it blank. NOTE: LDAP SUPPORT IS READ ONLY FOR NOW!! You must add users and group in LDAP by yourself. Cmsdam will never touch LDAP directory!


LDAP_rootdnpass

public str $LDAP_rootdnpass

LDAP root DN password, the ldap administrator DN password.

Leave it blank with anonymous bind. NOTE: LDAP SUPPORT IS READ ONLY FOR NOW!! You must add users and group in LDAP by yourself. Cmsdam will never touch LDAP directory!


LDAP_groupbasedn

public str $LDAP_groupbasedn

LDAP group base DN, the ldap group base branch to search from.

Each entry in this DN is a group for cmsdam, and must contain every user DN for that group. NOTE: LDAP SUPPORT IS READ ONLY FOR NOW!! You must add users and group in LDAP by yourself. Cmsdam will never touch LDAP directory!


LDAP_exclusive

public str $LDAP_exclusive

LDAP use.

0 -> never use LDAP, only use the DB for users login, groups, ecc...
1 -> always use LDAP, don't use DB for readonly users operations: login, groups...
2 -> first use LDAP, if the user is not present in LDAP or the credentials are not ok then use the DB
NOTE: LDAP SUPPORT IS READ ONLY FOR NOW!! You must add users and group in LDAP by yourself. Cmsdam will never touch LDAP directory!


LDAP_filter

public str $LDAP_filter

LDAP filter to check if a user entry is valid.

NOTE: LDAP SUPPORT IS READ ONLY FOR NOW!! You must add users and group in LDAP by yourself. Cmsdam will never touch LDAP directory!


LDAP_groupfilter

public str $LDAP_groupfilter

LDAP filter to check if a group entry is valid.

NOTE: LDAP SUPPORT IS READ ONLY FOR NOW!! You must add users and group in LDAP by yourself. Cmsdam will never touch LDAP directory!


LDAP_groupstag

public str $LDAP_groupstag

LDAP attribute to identify groups entities.

NOTE: LDAP SUPPORT IS READ ONLY FOR NOW!! You must add users and group in LDAP by yourself. Cmsdam will never touch LDAP directory!


LDAP_groupsuserstag

public str $LDAP_groupsuserstag

LDAP attribute to identify groups user DNs.

NOTE: LDAP SUPPORT IS READ ONLY FOR NOW!! You must add users and group in LDAP by yourself. Cmsdam will never touch LDAP directory!


parsetimecomment

public str $parsetimecomment

if == "YES" print cmsdam parsing time HTML comment at the bottom of the page It is very useful for debugging informations!


use_memcached

public str $use_memcached

if == "YES" cmsdam will use memcached daemon to implement variable caching mechanism


memcached_servers

public str $memcached_servers

memcached servers name and port


memcached_compress_threshold

public str $memcached_compress_threshold

at how many bytes should we compress?


memcached_persistant

public str $memcached_persistant

are we using persistant links?


ERROR_reporting_cmsdAm

public str $ERROR_reporting_cmsdAm

Error reporting for cmsdam related errors


ERROR_reporting_sections

public str $ERROR_reporting_sections

Error reporting for cmsdam sections related errors

Method Detail

cmsdam_conf()

public null cmsdam_conf()

This is the cmsdam_conf constructor, you cannot use it from your sections.

Author:
dAm2K (Dino Ciuffetti) <dam2k@users.sourceforge.net>
Returns:
This method doesn't return nothing

Overview  Package  Tree cmsdAm 0.8