LDAPAccountManager/lam-web/developers/phpdoc/elementindex_lib.html

561 lines
44 KiB
HTML

<html>
<head>
<title>Package lib Element Index</title>
<link rel="stylesheet" type="text/css" href="media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">lib</td>
</tr>
<tr><td class="header_line"><img src="media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="classtrees_lib.html" class="menu">class tree: lib</a> ]
[ <a href="elementindex_lib.html" class="menu">index: lib</a> ]
[ <a href="elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="ric">
<p><a href="ric_README.html">README</a></p>
<p><a href="ric_INSTALL.html">INSTALL</a></p>
</div>
<b>Packages:</b><br />
<a href="li_PDF.html">PDF</a><br />
<a href="li_lists.html">lists</a><br />
<a href="li_profiles.html">profiles</a><br />
<a href="li_LDAP.html">LDAP</a><br />
<a href="li_types.html">types</a><br />
<a href="li_lib.html">lib</a><br />
<a href="li_modules.html">modules</a><br />
<a href="li_selfService.html">selfService</a><br />
<a href="li_configuration.html">configuration</a><br />
<a href="li_tools.html">tools</a><br />
<a href="li_Help.html">Help</a><br />
<a href="li_tests.html">tests</a><br />
<a href="li_main.html">main</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="lib/_lib_account_inc.html"> account.inc
</a><br>
<a href="lib/_lib_cache_inc.html"> cache.inc
</a><br>
<a href="lib/_lib_schema_inc.html"> schema.inc
</a><br>
<a href="lib/_lib_security_inc.html"> security.inc
</a><br>
<a href="lib/_lib_status_inc.html"> status.inc
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="lib/AttributeType.html">AttributeType</a><br />
<a href="lib/cache.html">cache</a><br />
<a href="lib/MatchingRule.html">MatchingRule</a><br />
<a href="lib/MatchingRuleUse.html">MatchingRuleUse</a><br />
<a href="lib/ObjectClass.html">ObjectClass</a><br />
<a href="lib/ObjectClassAttribute.html">ObjectClassAttribute</a><br />
<a href="lib/SchemaItem.html">SchemaItem</a><br />
<a href="lib/Syntax.html">Syntax</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<a name="top"></a>
<h1>Element index for package lib</h1>
[ <a href="elementindex_lib.html#a">a</a> ]
[ <a href="elementindex_lib.html#c">c</a> ]
[ <a href="elementindex_lib.html#d">d</a> ]
[ <a href="elementindex_lib.html#e">e</a> ]
[ <a href="elementindex_lib.html#f">f</a> ]
[ <a href="elementindex_lib.html#g">g</a> ]
[ <a href="elementindex_lib.html#i">i</a> ]
[ <a href="elementindex_lib.html#l">l</a> ]
[ <a href="elementindex_lib.html#m">m</a> ]
[ <a href="elementindex_lib.html#n">n</a> ]
[ <a href="elementindex_lib.html#o">o</a> ]
[ <a href="elementindex_lib.html#p">p</a> ]
[ <a href="elementindex_lib.html#r">r</a> ]
[ <a href="elementindex_lib.html#s">s</a> ]
[ <a href="elementindex_lib.html#t">t</a> ]
[ <a href="elementindex_lib.html#u">u</a> ]
[ <a href="elementindex_lib.html#_">_</a> ]
<hr />
<a name="_"></a>
<div>
<h2>_</h2>
<dl>
<dt><b>_get_raw_schema</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#function_get_raw_schema">_get_raw_schema()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Fetches the raw schema array for the subschemaSubentry of the server. Note, this function has grown many hairs to accomodate more LDAP servers. It is needfully complicated as it now supports many popular LDAP servers that don't necessarily expose their schema &quot;the right way&quot;.</dd>
<dt><b>_get_schema_dn</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#function_get_schema_dn">_get_schema_dn()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Helper for _get_raw_schema() which fetches the DN of the schema object</dd>
<dt><b>__sleep</b></dt>
<dd>in file cache.inc, method <a href="lib/cache.html#method__sleep">cache::__sleep()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Encrypts LDAP cache before saving to session file.</dd>
<dt><b>__wakeup</b></dt>
<dd>in file cache.inc, method <a href="lib/cache.html#method__wakeup">cache::__wakeup()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Decrypts LDAP cache after loading from session file.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="a"></a>
<div>
<h2>a</h2>
<dl>
<dt><b>$aliases</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$aliases">AttributeType::$aliases</a><br>&nbsp;&nbsp;&nbsp;&nbsp;An array of alias attribute names, strings</dd>
<dt><b>$attributes</b></dt>
<dd>in file cache.inc, variable <a href="lib/cache.html#var$attributes">cache::$attributes</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This variable contains a list and their scope of attributes which should be cached</dd>
<dt><b>addAlias</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodaddAlias">AttributeType::addAlias()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Adds an attribute name to the alias array.</dd>
<dt><b>addChildObjectClass</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodaddChildObjectClass">ObjectClass::addChildObjectClass()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Adds an objectClass to the list of objectClasses that inherit from this objectClass.</dd>
<dt><b>addMayAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodaddMayAttrs">ObjectClass::addMayAttrs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.</dd>
<dt><b>addMustAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodaddMustAttrs">ObjectClass::addMustAttrs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.</dd>
<dt><b>addRequiredByObjectClass</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodaddRequiredByObjectClass">AttributeType::addRequiredByObjectClass()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Adds an objectClass name to this attribute's list of &quot;required by&quot; objectClasses, that is the list of objectClasses which must have this attribute.</dd>
<dt><b>addUsedByAttr</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodaddUsedByAttr">MatchingRule::addUsedByAttr()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Adds an attribute name to the list of attributes who use this MatchingRule</dd>
<dt><b>addUsedInObjectClass</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodaddUsedInObjectClass">AttributeType::addUsedInObjectClass()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Adds an objectClass name to this attribute's list of &quot;used in&quot; objectClasses, that is the list of objectClasses which provide this attribute.</dd>
<dt><b>add_aliases_to_attrs</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functionadd_aliases_to_attrs">add_aliases_to_attrs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;For each attribute that has multiple names, this function adds unique entries to the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.</dd>
<dt><b>add_cache</b></dt>
<dd>in file cache.inc, method <a href="lib/cache.html#methodadd_cache">cache::add_cache()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This function adds attributes to the cache.</dd>
<dt><b>add_sup_to_attrs</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functionadd_sup_to_attrs">add_sup_to_attrs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Adds inherited values to each attributeType specified by the SUP directive.</dd>
<dt><b>array_delete</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionarray_delete">array_delete()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This function will return all values from $array without values of $values.</dd>
<dt><b>AttributeType</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodAttributeType">AttributeType::AttributeType()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Creates a new AttributeType objcet from a raw LDAP AttributeType string.</dd>
<dt><b>AttributeType</b></dt>
<dd>in file schema.inc, class <a href="lib/AttributeType.html">AttributeType</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Represents an LDAP AttributeType</dd>
<dt><b>account.inc</b></dt>
<dd>procedural page <a href="lib/_lib_account_inc.html">account.inc</a></dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="c"></a>
<div>
<h2>c</h2>
<dl>
<dt><b>$children_objectclasses</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$children_objectclasses">ObjectClass::$children_objectclasses</a><br>&nbsp;&nbsp;&nbsp;&nbsp;array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)</dd>
<dt><b>cache</b></dt>
<dd>in file cache.inc, class <a href="lib/cache.html">cache</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This class contains all functions which are needed to manage the LDAP cache.</dd>
<dt><b>cache</b></dt>
<dd>in file cache.inc, method <a href="lib/cache.html#methodcache">cache::cache()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</dd>
<dt><b>cached_schema_available</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functioncached_schema_available">cached_schema_available()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the schema for $schema_type has been cached and</dd>
<dt><b>checkClientIP</b></dt>
<dd>in file security.inc, function <a href="lib/_lib_security_inc.html#functioncheckClientIP">checkClientIP()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Checks if the client's IP address is on the list of allowed IPs.</dd>
<dt><b>cmp_domain</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functioncmp_domain">cmp_domain()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Helper function to sort the domains</dd>
<dt><b>cache.inc</b></dt>
<dd>procedural page <a href="lib/_lib_cache_inc.html">cache.inc</a></dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="d"></a>
<div>
<h2>d</h2>
<dl>
<dt><b>$description</b></dt>
<dd>in file schema.inc, variable <a href="lib/SchemaItem.html#var$description">SchemaItem::$description</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The description of this schema item.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="e"></a>
<div>
<h2>e</h2>
<dl>
<dt><b>$equality</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$equality">AttributeType::$equality</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The equality rule used</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="f"></a>
<div>
<h2>f</h2>
<dl>
<dt><b>findgroups</b></dt>
<dd>in file cache.inc, method <a href="lib/cache.html#methodfindgroups">cache::findgroups()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This function returns an array with all group names which were found in the LDAP directory.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="g"></a>
<div>
<h2>g</h2>
<dl>
<dt><b>genpasswd</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functiongenpasswd">genpasswd()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This function will return a password with max. 8 characters.</dd>
<dt><b>getAliases</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetAliases">AttributeType::getAliases()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets the names of attributes that are an alias for this attribute (if any).</dd>
<dt><b>getChildObjectClasses</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetChildObjectClasses">ObjectClass::getChildObjectClasses()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the array of objectClass names which inherit from this objectClass.</dd>
<dt><b>getdays</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functiongetdays">getdays()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This function will return the days from 1.1.1970 until now.</dd>
<dt><b>getDescription</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodgetDescription">SchemaItem::getDescription()</a></dd>
<dt><b>getEquality</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetEquality">AttributeType::getEquality()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this attribute's equality string</dd>
<dt><b>getgid</b></dt>
<dd>in file cache.inc, method <a href="lib/cache.html#methodgetgid">cache::getgid()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This function will return the GID number to an existing group name (using the cache).</dd>
<dt><b>getgrnam</b></dt>
<dd>in file cache.inc, method <a href="lib/cache.html#methodgetgrnam">cache::getgrnam()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This function returns the group name to an existing gidNumber.</dd>
<dt><b>getIsCollective</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetIsCollective">AttributeType::getIsCollective()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets whether this attribute is collective.</dd>
<dt><b>getIsNoUserModification</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetIsNoUserModification">AttributeType::getIsNoUserModification()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets whether this attribute is not modifiable by users.</dd>
<dt><b>getIsObsolete</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetIsObsolete">AttributeType::getIsObsolete()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets whether this attribute has been flagged as obsolete by the LDAP server</dd>
<dt><b>getIsObsolete</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetIsObsolete">ObjectClass::getIsObsolete()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets whether this objectClass is flagged as obsolete by the LDAP server.</dd>
<dt><b>getIsObsolete</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodgetIsObsolete">MatchingRule::getIsObsolete()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets whether this MatchingRule is flagged as obsolete by the LDAP server.</dd>
<dt><b>getIsSingleValue</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetIsSingleValue">AttributeType::getIsSingleValue()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets whether this attribute is single-valued. If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.</dd>
<dt><b>getMaxLength</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetMaxLength">AttributeType::getMaxLength()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.</dd>
<dt><b>getMayAttrNames</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetMayAttrNames">ObjectClass::getMayAttrNames()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets an array of attribute names (strings) that entries of this ObjectClass must define.</dd>
<dt><b>getMayAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetMayAttrs">ObjectClass::getMayAttrs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets an array of AttributeType objects that entries of this ObjectClass may define.</dd>
<dt><b>getMustAttrNames</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetMustAttrNames">ObjectClass::getMustAttrNames()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets an array of attribute names (strings) that entries of this ObjectClass must define.</dd>
<dt><b>getMustAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetMustAttrs">ObjectClass::getMustAttrs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets an array of AttributeType objects that entries of this ObjectClass must define.</dd>
<dt><b>getName</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodgetName">MatchingRule::getName()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this MatchingRule's name.</dd>
<dt><b>getName</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRuleUse.html#methodgetName">MatchingRuleUse::getName()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this MatchingRuleUse's name</dd>
<dt><b>getName</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetName">AttributeType::getName()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this attribute's name</dd>
<dt><b>getName</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetName">ObjectClass::getName()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets the name of this objectClass (ie, &quot;inetOrgPerson&quot;)</dd>
<dt><b>getName</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClassAttribute.html#methodgetName">ObjectClassAttribute::getName()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this attribute's name</dd>
<dt><b>getOID</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodgetOID">SchemaItem::getOID()</a></dd>
<dt><b>getOrdering</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetOrdering">AttributeType::getOrdering()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this attribute's ordering specification.</dd>
<dt><b>getRequiredByObjectClasses</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetRequiredByObjectClasses">AttributeType::getRequiredByObjectClasses()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets the list of &quot;required by&quot; objectClasses, that is the list of objectClasses which provide must have attribute.</dd>
<dt><b>getshells</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functiongetshells">getshells()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of shells listed in config/shells.</dd>
<dt><b>getSource</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClassAttribute.html#methodgetSource">ObjectClassAttribute::getSource()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets the name of the ObjectClass which originally specified this attribute.</dd>
<dt><b>getSubstr</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetSubstr">AttributeType::getSubstr()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this attribute's substring matching specification</dd>
<dt><b>getSupAttribute</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetSupAttribute">AttributeType::getSupAttribute()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.</dd>
<dt><b>getSupClasses</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetSupClasses">ObjectClass::getSupClasses()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets the objectClass names from which this objectClass inherits.</dd>
<dt><b>getSyntaxOID</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetSyntaxOID">AttributeType::getSyntaxOID()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.</dd>
<dt><b>getSyntaxString</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetSyntaxString">AttributeType::getSyntaxString()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this attribute's raw syntax string (ie: &quot;1.2.3.4{16}&quot;).</dd>
<dt><b>getType</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodgetType">ObjectClass::getType()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.</dd>
<dt><b>getType</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetType">AttributeType::getType()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this attribute's type</dd>
<dt><b>getUsage</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetUsage">AttributeType::getUsage()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets this attribute's usage string as defined by the LDAP server</dd>
<dt><b>getUsedByAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRuleUse.html#methodgetUsedByAttrs">MatchingRuleUse::getUsedByAttrs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets an array of attribute names (strings) which use this MatchingRuleUse object.</dd>
<dt><b>getUsedByAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodgetUsedByAttrs">MatchingRule::getUsedByAttrs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets an array of attribute names (strings) which use this MatchingRule</dd>
<dt><b>getUsedInObjectClasses</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodgetUsedInObjectClasses">AttributeType::getUsedInObjectClasses()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets the list of &quot;used in&quot; objectClasses, that is the list of objectClasses which provide this attribute.</dd>
<dt><b>get_cache</b></dt>
<dd>in file cache.inc, method <a href="lib/cache.html#methodget_cache">cache::get_cache()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Queries the cache for a list of LDAP entries and their attributes.</dd>
<dt><b>get_cached_schema</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functionget_cached_schema">get_cached_schema()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the cached array of schemaitem objects for the specified</dd>
<dt><b>get_preg</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionget_preg">get_preg()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Checks if a given value matches the selected regular expression.</dd>
<dt><b>get_schema_attribute</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functionget_schema_attribute">get_schema_attribute()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets a single AttributeType object specified by name.</dd>
<dt><b>get_schema_attributes</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functionget_schema_attributes">get_schema_attributes()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets an associative array of AttributeType objects for the specified server. Each array entry's key is the name of the attributeType in lower-case and the value is an AttributeType object.</dd>
<dt><b>get_schema_matching_rules</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functionget_schema_matching_rules">get_schema_matching_rules()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of MatchingRule objects for the specified server.</dd>
<dt><b>get_schema_objectclass</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functionget_schema_objectclass">get_schema_objectclass()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets a single ObjectClass object specified by name.</dd>
<dt><b>get_schema_objectclasses</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functionget_schema_objectclasses">get_schema_objectclasses()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets an associative array of ObjectClass objects for the specified server. Each array entry's key is the name of the objectClass in lower-case and the value is an ObjectClass object.</dd>
<dt><b>get_schema_syntaxes</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functionget_schema_syntaxes">get_schema_syntaxes()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of Syntax objects that this LDAP server uses mapped to their descriptions. The key of each entry is the OID of the Syntax.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="i"></a>
<div>
<h2>i</h2>
<dl>
<dt><b>$is_collective</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$is_collective">AttributeType::$is_collective</a><br>&nbsp;&nbsp;&nbsp;&nbsp;boolean: is collective?</dd>
<dt><b>$is_no_user_modification</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$is_no_user_modification">AttributeType::$is_no_user_modification</a><br>&nbsp;&nbsp;&nbsp;&nbsp;boolean: can use modify?</dd>
<dt><b>$is_obsolete</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRule.html#var$is_obsolete">MatchingRule::$is_obsolete</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Boolean value indicating whether this MatchingRule is obsolete</dd>
<dt><b>$is_obsolete</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$is_obsolete">ObjectClass::$is_obsolete</a><br>&nbsp;&nbsp;&nbsp;&nbsp;boolean value indicating whether this objectClass is obsolete</dd>
<dt><b>$is_obsolete</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$is_obsolete">AttributeType::$is_obsolete</a><br>&nbsp;&nbsp;&nbsp;&nbsp;string: the description</dd>
<dt><b>$is_single_value</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$is_single_value">AttributeType::$is_single_value</a><br>&nbsp;&nbsp;&nbsp;&nbsp;boolean: is single valued only?</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodinitVars">ObjectClass::initVars()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Initialize the class' member variables</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodinitVars">SchemaItem::initVars()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Initialize class members to default values.</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/Syntax.html#methodinitVars">Syntax::initVars()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Initializes the class' member variables</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodinitVars">AttributeType::initVars()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Initialize the class' member variables</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRuleUse.html#methodinitVars">MatchingRuleUse::initVars()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Initialize the class' member variables</dd>
<dt><b>initVars</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodinitVars">MatchingRule::initVars()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Initialize the class' member variables</dd>
<dt><b>in_array_ignore_case</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionin_array_ignore_case">in_array_ignore_case()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Checks if a string exists in an array, ignoring case.</dd>
<dt><b>in_cache</b></dt>
<dd>in file cache.inc, method <a href="lib/cache.html#methodin_cache">cache::in_cache()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This function returns the DN if an LDAP entry with $attribute=$value is found.</dd>
<dt><b>isAliasFor</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodisAliasFor">AttributeType::isAliasFor()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="l"></a>
<div>
<h2>l</h2>
<dl>
<dt><b>$ldapcache</b></dt>
<dd>in file cache.inc, variable <a href="lib/cache.html#var$ldapcache">cache::$ldapcache</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This variable contains the cache</dd>
<dt><b>lmPassword</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionlmPassword">lmPassword()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Generates the LM hash of a password.</dd>
<dt><b>logNewMessage</b></dt>
<dd>in file security.inc, function <a href="lib/_lib_security_inc.html#functionlogNewMessage">logNewMessage()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Puts a new message in the log file.</dd>
<dt><b>logoffAndBackToLoginPage</b></dt>
<dd>in file security.inc, function <a href="lib/_lib_security_inc.html#functionlogoffAndBackToLoginPage">logoffAndBackToLoginPage()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Logs off the user and displays the login page.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="m"></a>
<div>
<h2>m</h2>
<dl>
<dt><b>$max_length</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$max_length">AttributeType::$max_length</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The max number of characters this attribute can be</dd>
<dt><b>$may_attrs</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$may_attrs">ObjectClass::$may_attrs</a><br>&nbsp;&nbsp;&nbsp;&nbsp;arrays of attribute names that this objectClass allows, but does not require</dd>
<dt><b>$must_attrs</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$must_attrs">ObjectClass::$must_attrs</a><br>&nbsp;&nbsp;&nbsp;&nbsp;arrays of attribute names that this objectClass requires</dd>
<dt><b>MatchingRule</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodMatchingRule">MatchingRule::MatchingRule()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Creates a new MatchingRule object from a raw LDAP MatchingRule string.</dd>
<dt><b>MatchingRule</b></dt>
<dd>in file schema.inc, class <a href="lib/MatchingRule.html">MatchingRule</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Represents an LDAP MatchingRule</dd>
<dt><b>MatchingRuleUse</b></dt>
<dd>in file schema.inc, class <a href="lib/MatchingRuleUse.html">MatchingRuleUse</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Represents an LDAP schema matchingRuleUse entry</dd>
<dt><b>MatchingRuleUse</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRuleUse.html#methodMatchingRuleUse">MatchingRuleUse::MatchingRuleUse()</a></dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="n"></a>
<div>
<h2>n</h2>
<dl>
<dt><b>$name</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$name">ObjectClass::$name</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This objectClass' name, ie &quot;inetOrgPerson&quot;</dd>
<dt><b>$name</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClassAttribute.html#var$name">ObjectClassAttribute::$name</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This Attribute's name</dd>
<dt><b>$name</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRuleUse.html#var$name">MatchingRuleUse::$name</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The name of the MathingRule this applies to</dd>
<dt><b>$name</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRule.html#var$name">MatchingRule::$name</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This rule's name</dd>
<dt><b>$name</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$name">AttributeType::$name</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The name of this attributeType</dd>
<dt><b>ntPassword</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionntPassword">ntPassword()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Generates the NT hash of a password.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="o"></a>
<div>
<h2>o</h2>
<dl>
<dt><b>$oid</b></dt>
<dd>in file schema.inc, variable <a href="lib/SchemaItem.html#var$oid">SchemaItem::$oid</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The OID of this schema item.</dd>
<dt><b>$ordering</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$ordering">AttributeType::$ordering</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The ordering of the attributeType</dd>
<dt><b>ObjectClass</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClass.html#methodObjectClass">ObjectClass::ObjectClass()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Creates a new ObjectClass object given a raw LDAP objectClass string.</dd>
<dt><b>ObjectClass</b></dt>
<dd>in file schema.inc, class <a href="lib/ObjectClass.html">ObjectClass</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Represents an LDAP objectClass</dd>
<dt><b>ObjectClassAttribute</b></dt>
<dd>in file schema.inc, method <a href="lib/ObjectClassAttribute.html#methodObjectClassAttribute">ObjectClassAttribute::ObjectClassAttribute()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Creates a new ObjectClassAttribute with specified name and source objectClass.</dd>
<dt><b>ObjectClassAttribute</b></dt>
<dd>in file schema.inc, class <a href="lib/ObjectClassAttribute.html">ObjectClassAttribute</a><br>&nbsp;&nbsp;&nbsp;&nbsp;A simple class for representing AttributeTypes used only by the ObjectClass class.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="p"></a>
<div>
<h2>p</h2>
<dl>
<dt><b>pwd_disable</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionpwd_disable">pwd_disable()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Marks an password hash as disabled and returns the new hash string</dd>
<dt><b>pwd_enable</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionpwd_enable">pwd_enable()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Marks an password hash as enabled and returns the new hash string</dd>
<dt><b>pwd_hash</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionpwd_hash">pwd_hash()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the hash value of a plain text password the hash algorithm depends on the configuration file</dd>
<dt><b>pwd_is_enabled</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionpwd_is_enabled">pwd_is_enabled()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Checks if a password hash is enabled/disabled</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="r"></a>
<div>
<h2>r</h2>
<dl>
<dt><b>$required_by_object_classes</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$required_by_object_classes">AttributeType::$required_by_object_classes</a><br>&nbsp;&nbsp;&nbsp;&nbsp;A list of object class names that require this attribute type.</dd>
<dt><b>refresh_cache</b></dt>
<dd>in file cache.inc, method <a href="lib/cache.html#methodrefresh_cache">cache::refresh_cache()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This function refreshes the cache.</dd>
<dt><b>removeAlias</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodremoveAlias">AttributeType::removeAlias()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Removes an attribute name from this attribute's alias array.</dd>
<dt><b>RndInt</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionRndInt">RndInt()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;THIS FUNCTION GENERATES A RANDOM NUMBER THAT WILL BE USED TO RANDOMLY SELECT CHARACTERS.</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="s"></a>
<div>
<h2>s</h2>
<dl>
<dt><b>$source</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClassAttribute.html#var$source">ObjectClassAttribute::$source</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This Attribute's root</dd>
<dt><b>$sub_str</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$sub_str">AttributeType::$sub_str</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Boolean: supports substring matching?</dd>
<dt><b>$sup_attribute</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$sup_attribute">AttributeType::$sup_attribute</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The attribute from which this attribute inherits (if any)</dd>
<dt><b>$sup_classes</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$sup_classes">ObjectClass::$sup_classes</a><br>&nbsp;&nbsp;&nbsp;&nbsp;array of objectClass names from which this objectClass inherits</dd>
<dt><b>$syntax</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRule.html#var$syntax">MatchingRule::$syntax</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This rule's syntax OID</dd>
<dt><b>$syntax</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$syntax">AttributeType::$syntax</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The full syntax string, ie 1.2.3.4{16}</dd>
<dt><b>schema.inc</b></dt>
<dd>procedural page <a href="lib/_lib_schema_inc.html">schema.inc</a></dd>
<dt><b>security.inc</b></dt>
<dd>procedural page <a href="lib/_lib_security_inc.html">security.inc</a></dd>
<dt><b>status.inc</b></dt>
<dd>procedural page <a href="lib/_lib_status_inc.html">status.inc</a></dd>
<dt><b>SchemaItem</b></dt>
<dd>in file schema.inc, class <a href="lib/SchemaItem.html">SchemaItem</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.</dd>
<dt><b>SchemaItem</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodSchemaItem">SchemaItem::SchemaItem()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Default constructor.</dd>
<dt><b>SCHEMA_SESSION_CACHE_ENABLED</b></dt>
<dd>in file schema.inc, constant <a href="lib/_lib_schema_inc.html#defineSCHEMA_SESSION_CACHE_ENABLED">SCHEMA_SESSION_CACHE_ENABLED</a><br>&nbsp;&nbsp;&nbsp;&nbsp;To enable/disable session-based schema caching (1: enabled, 0: disabled).</dd>
<dt><b>search_domains</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionsearch_domains">search_domains()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns an array with all Samba 3 domain entries under the given suffix</dd>
<dt><b>setAliases</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodsetAliases">AttributeType::setAliases()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets this attribute's list of aliases.</dd>
<dt><b>setDescription</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodsetDescription">SchemaItem::setDescription()</a></dd>
<dt><b>setIsSingleValue</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodsetIsSingleValue">AttributeType::setIsSingleValue()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets whether this attribute is single-valued.</dd>
<dt><b>setName</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodsetName">AttributeType::setName()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets this attriute's name.</dd>
<dt><b>setOID</b></dt>
<dd>in file schema.inc, method <a href="lib/SchemaItem.html#methodsetOID">SchemaItem::setOID()</a></dd>
<dt><b>setSupAttribute</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodsetSupAttribute">AttributeType::setSupAttribute()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).</dd>
<dt><b>setType</b></dt>
<dd>in file schema.inc, method <a href="lib/AttributeType.html#methodsetType">AttributeType::setType()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets this attribute's type.</dd>
<dt><b>setUsedByAttrs</b></dt>
<dd>in file schema.inc, method <a href="lib/MatchingRule.html#methodsetUsedByAttrs">MatchingRule::setUsedByAttrs()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the list of used_by_attrs to the array specified by $attrs;</dd>
<dt><b>set_cached_schema</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functionset_cached_schema">set_cached_schema()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Caches the specified $schema_type.</dd>
<dt><b>set_schema_cache_unavailable</b></dt>
<dd>in file schema.inc, function <a href="lib/_lib_schema_inc.html#functionset_schema_cache_unavailable">set_schema_cache_unavailable()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the schema entry for the server_id to be &quot;unavailable&quot; so that we realize that we tried to get the schema but could not, so quit trying next time to fetch it from the server.</dd>
<dt><b>smbflag</b></dt>
<dd>in file account.inc, function <a href="lib/_lib_account_inc.html#functionsmbflag">smbflag()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Takes a list of Samba flags and creates the corresponding flag string.</dd>
<dt><b>startSecureSession</b></dt>
<dd>in file security.inc, function <a href="lib/_lib_security_inc.html#functionstartSecureSession">startSecureSession()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Starts a session and checks the environment.</dd>
<dt><b>StatusMessage</b></dt>
<dd>in file status.inc, function <a href="lib/_lib_status_inc.html#functionStatusMessage">StatusMessage()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This function prints a short status message. It can be used to print INFO, WARN and ERROR messages at the moment.</dd>
<dt><b>Syntax</b></dt>
<dd>in file schema.inc, method <a href="lib/Syntax.html#methodSyntax">Syntax::Syntax()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Creates a new Syntax object from a raw LDAP syntax string.</dd>
<dt><b>Syntax</b></dt>
<dd>in file schema.inc, class <a href="lib/Syntax.html">Syntax</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Represents an LDAP Syntax</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="t"></a>
<div>
<h2>t</h2>
<dl>
<dt><b>$time</b></dt>
<dd>in file cache.inc, variable <a href="lib/cache.html#var$time">cache::$time</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This is the last timestamp on which the LDAP cache has been refreshed</dd>
<dt><b>$type</b></dt>
<dd>in file schema.inc, variable <a href="lib/ObjectClass.html#var$type">ObjectClass::$type</a><br>&nbsp;&nbsp;&nbsp;&nbsp;one of STRUCTURAL, ABSTRACT, or AUXILIARY</dd>
<dt><b>$type</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$type">AttributeType::$type</a><br>&nbsp;&nbsp;&nbsp;&nbsp;A string description of the syntax type (taken from the LDAPSyntaxes)</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<hr />
<a name="u"></a>
<div>
<h2>u</h2>
<dl>
<dt><b>$usage</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$usage">AttributeType::$usage</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The usage string set by the LDAP schema</dd>
<dt><b>$used_by_attrs</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRule.html#var$used_by_attrs">MatchingRule::$used_by_attrs</a><br>&nbsp;&nbsp;&nbsp;&nbsp;An array of attribute names who use this MatchingRule</dd>
<dt><b>$used_by_attrs</b></dt>
<dd>in file schema.inc, variable <a href="lib/MatchingRuleUse.html#var$used_by_attrs">MatchingRuleUse::$used_by_attrs</a><br>&nbsp;&nbsp;&nbsp;&nbsp;An array of attributeType names who make use of the mathingRule</dd>
<dt><b>$used_in_object_classes</b></dt>
<dd>in file schema.inc, variable <a href="lib/AttributeType.html#var$used_in_object_classes">AttributeType::$used_in_object_classes</a><br>&nbsp;&nbsp;&nbsp;&nbsp;An array of objectClasses which use this attributeType (must be set by caller)</dd>
</dl>
</div>
<a href="elementindex_lib.html#top">top</a><br>
<div class="credit">
<hr />
Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.2.3</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>