Update already documented

This commit is contained in:
Deon George 2009-07-09 21:37:15 +10:00
parent 8c46ecf6c9
commit 88f3c8faa7
4 changed files with 0 additions and 62 deletions

View File

@ -47,12 +47,10 @@ class Config {
*/ */
$this->default->appearance['anonymous_bind_implies_read_only'] = array( $this->default->appearance['anonymous_bind_implies_read_only'] = array(
'desc'=>'Display as read only if user logs in with anonymous bind', 'desc'=>'Display as read only if user logs in with anonymous bind',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->appearance['attr_display_order'] = array( $this->default->appearance['attr_display_order'] = array(
'desc'=>'Custom order to display attributes', 'desc'=>'Custom order to display attributes',
'undocumented'=>true,
'default'=>array()); 'default'=>array());
/* /*
@ -62,7 +60,6 @@ class Config {
*/ */
$this->default->appearance['compress'] = array( $this->default->appearance['compress'] = array(
'desc'=>'Compress Output', 'desc'=>'Compress Output',
'undocumented'=>true,
'untested'=>true, 'untested'=>true,
'default'=>false); 'default'=>false);
@ -73,7 +70,6 @@ class Config {
$this->default->appearance['custom_templates_only'] = array( $this->default->appearance['custom_templates_only'] = array(
'desc'=>'Only display the custom templates.', 'desc'=>'Only display the custom templates.',
'undocumented'=>true,
'default'=>false); 'default'=>false);
$this->default->appearance['date'] = array( $this->default->appearance['date'] = array(
@ -82,17 +78,14 @@ class Config {
$this->default->appearance['date_attrs'] = array( $this->default->appearance['date_attrs'] = array(
'desc'=>'Array of attributes that should show a jscalendar', 'desc'=>'Array of attributes that should show a jscalendar',
'undocumented'=>true,
'default'=>array('shadowExpire'=>'%es','shadowLastChange'=>'%es')); 'default'=>array('shadowExpire'=>'%es','shadowLastChange'=>'%es'));
$this->default->appearance['date_attrs_showtime'] = array( $this->default->appearance['date_attrs_showtime'] = array(
'desc'=>'Array of attributes that should show a the time when showing the jscalendar', 'desc'=>'Array of attributes that should show a the time when showing the jscalendar',
'undocumented'=>true,
'default'=>array('')); 'default'=>array(''));
$this->default->appearance['disable_default_template'] = array( $this->default->appearance['disable_default_template'] = array(
'desc'=>'Disabled the Default Template', 'desc'=>'Disabled the Default Template',
'undocumented'=>true,
'default'=>false); 'default'=>false);
$this->default->appearance['disable_default_leaf'] = array( $this->default->appearance['disable_default_leaf'] = array(
@ -101,22 +94,18 @@ class Config {
$this->default->appearance['friendly_attrs'] = array( $this->default->appearance['friendly_attrs'] = array(
'desc'=>'Friendly names for attributes', 'desc'=>'Friendly names for attributes',
'undocumented'=>true,
'default'=>array()); 'default'=>array());
$this->default->appearance['hide_attrs'] = array( $this->default->appearance['hide_attrs'] = array(
'desc'=>'Hide attributes from display', 'desc'=>'Hide attributes from display',
'undocumented'=>true,
'default'=>array()); 'default'=>array());
$this->default->appearance['hide_attrs_exempt'] = array( $this->default->appearance['hide_attrs_exempt'] = array(
'desc'=>'Group DN, where membership will exempt the users from hide_attrs', 'desc'=>'Group DN, where membership will exempt the users from hide_attrs',
'undocumented'=>true,
'default'=>null); 'default'=>null);
$this->default->appearance['hide_debug_info'] = array( $this->default->appearance['hide_debug_info'] = array(
'desc'=>'Hide the features that may provide sensitive debugging information to the browser', 'desc'=>'Hide the features that may provide sensitive debugging information to the browser',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->appearance['hide_template_warning'] = array( $this->default->appearance['hide_template_warning'] = array(
@ -132,12 +121,10 @@ class Config {
*/ */
$this->default->appearance['language'] = array( $this->default->appearance['language'] = array(
'desc'=>'Language', 'desc'=>'Language',
'undocumented'=>true,
'default'=>'auto'); 'default'=>'auto');
$this->default->appearance['max_add_attrs'] = array( $this->default->appearance['max_add_attrs'] = array(
'desc'=>'Maximum number of attrs to show in the add attr form', 'desc'=>'Maximum number of attrs to show in the add attr form',
'undocumented'=>true,
'default'=>10); 'default'=>10);
/** /**
@ -146,7 +133,6 @@ class Config {
*/ */
$this->default->appearance['multi_line_attributes'] = array( $this->default->appearance['multi_line_attributes'] = array(
'desc'=>'Attributes to show as multiline attributes', 'desc'=>'Attributes to show as multiline attributes',
'undocumented'=>true,
'default'=>array('postalAddress','homePostalAddress','personalSignature','description','mailReplyText')); 'default'=>array('postalAddress','homePostalAddress','personalSignature','description','mailReplyText'));
/** /**
@ -154,7 +140,6 @@ class Config {
*/ */
$this->default->appearance['multi_line_syntax_oids'] = array( $this->default->appearance['multi_line_syntax_oids'] = array(
'desc'=>'Attributes to show as multiline attributes', 'desc'=>'Attributes to show as multiline attributes',
'undocumented'=>true,
'default'=>array( 'default'=>array(
// octet string syntax OID: // octet string syntax OID:
'1.3.6.1.4.1.1466.115.121.1.40', '1.3.6.1.4.1.1466.115.121.1.40',
@ -167,12 +152,10 @@ class Config {
*/ */
$this->default->appearance['obfuscate_password_display'] = array( $this->default->appearance['obfuscate_password_display'] = array(
'desc'=>'Obfuscate the display of passwords', 'desc'=>'Obfuscate the display of passwords',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->appearance['page_title'] = array( $this->default->appearance['page_title'] = array(
'desc'=>'Change the page title to this text', 'desc'=>'Change the page title to this text',
'undocumented'=>true,
'default'=>''); 'default'=>'');
$this->default->appearance['rdn_all_attrs'] = array( $this->default->appearance['rdn_all_attrs'] = array(
@ -197,32 +180,26 @@ class Config {
$this->default->appearance['show_hints'] = array( $this->default->appearance['show_hints'] = array(
'desc'=>'Show helpful hints', 'desc'=>'Show helpful hints',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->appearance['show_top_create'] = array( $this->default->appearance['show_top_create'] = array(
'desc'=>'Show a additional create link on the top of the list if there are more than 10 entries', 'desc'=>'Show a additional create link on the top of the list if there are more than 10 entries',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->appearance['show_schema_link'] = array( $this->default->appearance['show_schema_link'] = array(
'desc'=>'Show the schema link for each attribute', 'desc'=>'Show the schema link for each attribute',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->appearance['show_attribute_notes'] = array( $this->default->appearance['show_attribute_notes'] = array(
'desc'=>'Show notes for each attribute', 'desc'=>'Show notes for each attribute',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->appearance['stylesheet'] = array( $this->default->appearance['stylesheet'] = array(
'desc'=>'Style sheet to use', 'desc'=>'Style sheet to use',
'undocumented'=>true,
'default'=>'style.css'); 'default'=>'style.css');
$this->default->appearance['theme'] = array( $this->default->appearance['theme'] = array(
'desc'=>'Which theme to use', 'desc'=>'Which theme to use',
'undocumented'=>true,
'default'=>'default'); 'default'=>'default');
$this->default->appearance['timezone'] = array( $this->default->appearance['timezone'] = array(
@ -264,17 +241,14 @@ class Config {
*/ */
$this->default->appearance['tree_display_format'] = array( $this->default->appearance['tree_display_format'] = array(
'desc'=>'LDAP attribute to show in the tree', 'desc'=>'LDAP attribute to show in the tree',
'undocumented'=>true,
'default'=>array('%rdn')); 'default'=>array('%rdn'));
$this->default->appearance['tree_height'] = array( $this->default->appearance['tree_height'] = array(
'desc'=>'Pixel height of the tree browser', 'desc'=>'Pixel height of the tree browser',
'undocumented'=>true,
'default'=>null); 'default'=>null);
$this->default->appearance['tree_width'] = array( $this->default->appearance['tree_width'] = array(
'desc'=>'Pixel width of the tree browser', 'desc'=>'Pixel width of the tree browser',
'undocumented'=>true,
'default'=>null); 'default'=>null);
/** Tree display filter /** Tree display filter
@ -282,50 +256,41 @@ class Config {
*/ */
$this->default->appearance['tree_filter'] = array( $this->default->appearance['tree_filter'] = array(
'desc'=>'LDAP search filter for the tree entries', 'desc'=>'LDAP search filter for the tree entries',
'undocumented'=>true,
'default'=>'(objectClass=*)'); 'default'=>'(objectClass=*)');
## Caching ## Caching
$this->default->cache['schema'] = array( $this->default->cache['schema'] = array(
'desc'=>'Cache Schema Activity', 'desc'=>'Cache Schema Activity',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->cache['query'] = array( $this->default->cache['query'] = array(
'desc'=>'Cache Query Configuration', 'desc'=>'Cache Query Configuration',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->cache['query_time'] = array( $this->default->cache['query_time'] = array(
'desc'=>'Cache the query configuration for atleast this amount of time in seconds', 'desc'=>'Cache the query configuration for atleast this amount of time in seconds',
'undocumented'=>true,
'default'=>5); 'default'=>5);
$this->default->cache['template'] = array( $this->default->cache['template'] = array(
'desc'=>'Cache Template Configuration', 'desc'=>'Cache Template Configuration',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->cache['template_time'] = array( $this->default->cache['template_time'] = array(
'desc'=>'Cache the template configuration for atleast this amount of time in seconds', 'desc'=>'Cache the template configuration for atleast this amount of time in seconds',
'undocumented'=>true,
'default'=>60); 'default'=>60);
$this->default->cache['tree'] = array( $this->default->cache['tree'] = array(
'desc'=>'Cache Browser Tree', 'desc'=>'Cache Browser Tree',
'undocumented'=>true,
'default'=>true); 'default'=>true);
/** Confirm actions /** Confirm actions
*/ */
$this->default->confirm['create'] = array( $this->default->confirm['create'] = array(
'desc'=>'Confirm creation actions', 'desc'=>'Confirm creation actions',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->confirm['update'] = array( $this->default->confirm['update'] = array(
'desc'=>'Confirm update actions', 'desc'=>'Confirm update actions',
'undocumented'=>true,
'default'=>true); 'default'=>true);
/** Commands /** Commands
@ -404,17 +369,14 @@ class Config {
*/ */
@$this->default->deref['export'] = array( @$this->default->deref['export'] = array(
'desc'=>'', 'desc'=>'',
'undocumented'=>true,
'default'=>LDAP_DEREF_NEVER); 'default'=>LDAP_DEREF_NEVER);
@$this->default->deref['search'] = array( @$this->default->deref['search'] = array(
'desc'=>'', 'desc'=>'',
'undocumented'=>true,
'default'=>LDAP_DEREF_ALWAYS); 'default'=>LDAP_DEREF_ALWAYS);
@$this->default->deref['tree'] = array( @$this->default->deref['tree'] = array(
'desc'=>'', 'desc'=>'',
'undocumented'=>true,
'default'=>LDAP_DEREF_NEVER); 'default'=>LDAP_DEREF_NEVER);
@$this->default->deref['view'] = array( @$this->default->deref['view'] = array(
@ -425,27 +387,22 @@ class Config {
## Debug Attributes ## Debug Attributes
$this->default->debug['level'] = array( $this->default->debug['level'] = array(
'desc'=>'Debug level verbosity', 'desc'=>'Debug level verbosity',
'undocumented'=>true,
'default'=>0); 'default'=>0);
$this->default->debug['syslog'] = array( $this->default->debug['syslog'] = array(
'desc'=>'Whether to send debug messages to syslog', 'desc'=>'Whether to send debug messages to syslog',
'undocumented'=>true,
'default'=>false); 'default'=>false);
$this->default->debug['file'] = array( $this->default->debug['file'] = array(
'desc'=>'Name of file to send debug output to', 'desc'=>'Name of file to send debug output to',
'undocumented'=>true,
'default'=>null); 'default'=>null);
$this->default->debug['addr'] = array( $this->default->debug['addr'] = array(
'desc'=>'IP address of client to provide debugging info.', 'desc'=>'IP address of client to provide debugging info.',
'undocumented'=>true,
'default'=>null); 'default'=>null);
$this->default->debug['append'] = array( $this->default->debug['append'] = array(
'desc'=>'Whether to append to the debug file, or create it fresh each time', 'desc'=>'Whether to append to the debug file, or create it fresh each time',
'undocumented'=>true,
'default'=>true); 'default'=>true);
## Temp Directories ## Temp Directories
@ -454,13 +411,11 @@ class Config {
*/ */
$this->default->jpeg['tmpdir'] = array( $this->default->jpeg['tmpdir'] = array(
'desc'=>'Temporary directory for jpegPhoto data', 'desc'=>'Temporary directory for jpegPhoto data',
'undocumented'=>true,
'default'=>'/tmp'); 'default'=>'/tmp');
## Mass update commands ## Mass update commands
$this->default->mass['enabled'] = array( $this->default->mass['enabled'] = array(
'desc'=>'Are mass update commands enabled', 'desc'=>'Are mass update commands enabled',
'undocumented'=>true,
'default'=>true); 'default'=>true);
## Modify members feature ## Modify members feature
@ -525,7 +480,6 @@ class Config {
*/ */
$this->default->session['blowfish'] = array( $this->default->session['blowfish'] = array(
'desc'=>'Blowfish key to encrypt cookie details', 'desc'=>'Blowfish key to encrypt cookie details',
'undocumented'=>true,
'default'=>null); 'default'=>null);
$this->default->session['memorylimit'] = array( $this->default->session['memorylimit'] = array(

View File

@ -491,7 +491,6 @@ class Datastore {
# Connectivity Info # Connectivity Info
$this->default->server['host'] = array( $this->default->server['host'] = array(
'desc'=>'Host Name', 'desc'=>'Host Name',
'undocumented'=>true,
'default'=>'127.0.0.1'); 'default'=>'127.0.0.1');
$this->default->server['port'] = array( $this->default->server['port'] = array(
@ -513,7 +512,6 @@ class Datastore {
# Authentication Information # Authentication Information
$this->default->login['auth_type'] = array( $this->default->login['auth_type'] = array(
'desc'=>'Authentication Type', 'desc'=>'Authentication Type',
'undocumented'=>true,
'default'=>'session'); 'default'=>'session');
/* /*

View File

@ -51,28 +51,23 @@ class ldap extends DS {
$this->default->server['base'] = array( $this->default->server['base'] = array(
'desc'=>'LDAP Base DNs', 'desc'=>'LDAP Base DNs',
'undocumented'=>true,
'default'=>array()); 'default'=>array());
$this->default->server['tls'] = array( $this->default->server['tls'] = array(
'desc'=>'Connect using TLS', 'desc'=>'Connect using TLS',
'undocumented'=>true,
'default'=>false); 'default'=>false);
# Login Details # Login Details
$this->default->login['attr'] = array( $this->default->login['attr'] = array(
'desc'=>'Attribute to use to find the users DN', 'desc'=>'Attribute to use to find the users DN',
'undocumented'=>true,
'default'=>'dn'); 'default'=>'dn');
$this->default->login['anon_bind'] = array( $this->default->login['anon_bind'] = array(
'desc'=>'Enable anonymous bind logins', 'desc'=>'Enable anonymous bind logins',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->login['allowed_dns'] = array( $this->default->login['allowed_dns'] = array(
'desc'=>'Limit logins to users who match any of the following LDAP filters', 'desc'=>'Limit logins to users who match any of the following LDAP filters',
'undocumented'=>true,
'default'=>array()); 'default'=>array());
$this->default->login['base'] = array( $this->default->login['base'] = array(
@ -90,7 +85,6 @@ class ldap extends DS {
# SASL configuration # SASL configuration
$this->default->server['sasl'] = array( $this->default->server['sasl'] = array(
'desc'=>'Use SASL authentication when binding LDAP server', 'desc'=>'Use SASL authentication when binding LDAP server',
'undocumented'=>true,
'default'=>false); 'default'=>false);
$this->default->sasl['mech'] = array( $this->default->sasl['mech'] = array(

View File

@ -96,12 +96,10 @@ class ldap_pla extends ldap {
# Settings for auto_number # Settings for auto_number
$this->default->auto_number['enable'] = array( $this->default->auto_number['enable'] = array(
'desc'=>'Enable the AUTO UID feature', 'desc'=>'Enable the AUTO UID feature',
'undocumented'=>true,
'default'=>true); 'default'=>true);
$this->default->auto_number['mechanism'] = array( $this->default->auto_number['mechanism'] = array(
'desc'=>'Mechanism to use to search for automatic numbers', 'desc'=>'Mechanism to use to search for automatic numbers',
'undocumented'=>true,
'default'=>'search'); 'default'=>'search');
$this->default->auto_number['search_base'] = array( $this->default->auto_number['search_base'] = array(
@ -111,32 +109,26 @@ class ldap_pla extends ldap {
$this->default->auto_number['min'] = array( $this->default->auto_number['min'] = array(
'desc'=>'Minimum number to start with', 'desc'=>'Minimum number to start with',
'undocumented'=>true,
'default'=>array('uidNumber'=>1000,'gidNumber'=>500)); 'default'=>array('uidNumber'=>1000,'gidNumber'=>500));
$this->default->auto_number['dn'] = array( $this->default->auto_number['dn'] = array(
'desc'=>'DN to use when evaluating numbers', 'desc'=>'DN to use when evaluating numbers',
'undocumented'=>true,
'default'=>null); 'default'=>null);
$this->default->auto_number['pass'] = array( $this->default->auto_number['pass'] = array(
'desc'=>'Password for DN to use when evaluating numbers', 'desc'=>'Password for DN to use when evaluating numbers',
'undocumented'=>true,
'default'=>null); 'default'=>null);
$this->default->unique['attrs'] = array( $this->default->unique['attrs'] = array(
'desc'=>'Attributes to check for uniqueness before allowing updates', 'desc'=>'Attributes to check for uniqueness before allowing updates',
'undocumented'=>true,
'default'=>array('mail','uid','uidNumber')); 'default'=>array('mail','uid','uidNumber'));
$this->default->unique['dn'] = array( $this->default->unique['dn'] = array(
'desc'=>'DN to use when evaluating attribute uniqueness', 'desc'=>'DN to use when evaluating attribute uniqueness',
'undocumented'=>true,
'default'=>null); 'default'=>null);
$this->default->unique['pass'] = array( $this->default->unique['pass'] = array(
'desc'=>'Password for DN to use when evaluating attribute uniqueness', 'desc'=>'Password for DN to use when evaluating attribute uniqueness',
'undocumented'=>true,
'default'=>null); 'default'=>null);
} }