<html>
<head>
<title>Docs For Class AttributeType</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_INSTALL.html">INSTALL</a></p>
<p><a href="../ric_README.html">README</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_configuration.html">configuration</a><br />
<a href="../li_Help.html">Help</a><br />
<a href="../li_LDAP.html">LDAP</a><br />
<a href="../li_lib.html">lib</a><br />
<a href="../li_lists.html">lists</a><br />
<a href="../li_main.html">main</a><br />
<a href="../li_modules.html">modules</a><br />
<a href="../li_PDF.html">PDF</a><br />
<a href="../li_profiles.html">profiles</a><br />
<a href="../li_selfService.html">selfService</a><br />
<a href="../li_tools.html">tools</a><br />
<a href="../li_types.html">types</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">
<h1>Class: AttributeType</h1>
Source Location: /lib/schema.inc<br /><br />
<table width="100%" border="0">
<tr><td valign="top">
<h3><a href="#class_details">Class Overview</a></h3>
<pre><a href="../lib/SchemaItem.html">SchemaItem</a>
|
--AttributeType</pre><br />
<div class="description">Represents an LDAP AttributeType</div><br /><br />
</td>
<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
<li><a href="../lib/AttributeType.html#var$aliases">$aliases</a></li>
<li><a href="../lib/AttributeType.html#var$equality">$equality</a></li>
<li><a href="../lib/AttributeType.html#var$is_collective">$is_collective</a></li>
<li><a href="../lib/AttributeType.html#var$is_no_user_modification">$is_no_user_modification</a></li>
<li><a href="../lib/AttributeType.html#var$is_obsolete">$is_obsolete</a></li>
<li><a href="../lib/AttributeType.html#var$is_single_value">$is_single_value</a></li>
<li><a href="../lib/AttributeType.html#var$max_length">$max_length</a></li>
<li><a href="../lib/AttributeType.html#var$name">$name</a></li>
<li><a href="../lib/AttributeType.html#var$ordering">$ordering</a></li>
<li><a href="../lib/AttributeType.html#var$required_by_object_classes">$required_by_object_classes</a></li>
<li><a href="../lib/AttributeType.html#var$sub_str">$sub_str</a></li>
<li><a href="../lib/AttributeType.html#var$sup_attribute">$sup_attribute</a></li>
<li><a href="../lib/AttributeType.html#var$syntax">$syntax</a></li>
<li><a href="../lib/AttributeType.html#var$type">$type</a></li>
<li><a href="../lib/AttributeType.html#var$usage">$usage</a></li>
<li><a href="../lib/AttributeType.html#var$used_in_object_classes">$used_in_object_classes</a></li>
</ul>
</td>
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../lib/AttributeType.html#methodAttributeType">AttributeType</a></li>
<li><a href="../lib/AttributeType.html#methodaddAlias">addAlias</a></li>
<li><a href="../lib/AttributeType.html#methodaddRequiredByObjectClass">addRequiredByObjectClass</a></li>
<li><a href="../lib/AttributeType.html#methodaddUsedInObjectClass">addUsedInObjectClass</a></li>
<li><a href="../lib/AttributeType.html#methodgetAliases">getAliases</a></li>
<li><a href="../lib/AttributeType.html#methodgetEquality">getEquality</a></li>
<li><a href="../lib/AttributeType.html#methodgetIsCollective">getIsCollective</a></li>
<li><a href="../lib/AttributeType.html#methodgetIsNoUserModification">getIsNoUserModification</a></li>
<li><a href="../lib/AttributeType.html#methodgetIsObsolete">getIsObsolete</a></li>
<li><a href="../lib/AttributeType.html#methodgetIsSingleValue">getIsSingleValue</a></li>
<li><a href="../lib/AttributeType.html#methodgetMaxLength">getMaxLength</a></li>
<li><a href="../lib/AttributeType.html#methodgetName">getName</a></li>
<li><a href="../lib/AttributeType.html#methodgetOrdering">getOrdering</a></li>
<li><a href="../lib/AttributeType.html#methodgetRequiredByObjectClasses">getRequiredByObjectClasses</a></li>
<li><a href="../lib/AttributeType.html#methodgetSubstr">getSubstr</a></li>
<li><a href="../lib/AttributeType.html#methodgetSupAttribute">getSupAttribute</a></li>
<li><a href="../lib/AttributeType.html#methodgetSyntaxOID">getSyntaxOID</a></li>
<li><a href="../lib/AttributeType.html#methodgetSyntaxString">getSyntaxString</a></li>
<li><a href="../lib/AttributeType.html#methodgetType">getType</a></li>
<li><a href="../lib/AttributeType.html#methodgetUsage">getUsage</a></li>
<li><a href="../lib/AttributeType.html#methodgetUsedInObjectClasses">getUsedInObjectClasses</a></li>
<li><a href="../lib/AttributeType.html#methodinitVars">initVars</a></li>
<li><a href="../lib/AttributeType.html#methodisAliasFor">isAliasFor</a></li>
<li><a href="../lib/AttributeType.html#methodremoveAlias">removeAlias</a></li>
<li><a href="../lib/AttributeType.html#methodsetAliases">setAliases</a></li>
<li><a href="../lib/AttributeType.html#methodsetIsSingleValue">setIsSingleValue</a></li>
<li><a href="../lib/AttributeType.html#methodsetName">setName</a></li>
<li><a href="../lib/AttributeType.html#methodsetSupAttribute">setSupAttribute</a></li>
<li><a href="../lib/AttributeType.html#methodsetType">setType</a></li>
</ul>
</td>
</tr></table>
<hr />
<table width="100%" border="0"><tr>
<td valign="top">
<h3>Inherited Variables</h3>
<div class="tags">
<h4>Class: <a href="../lib/SchemaItem.html">SchemaItem</a></h4>
<dl>
<dt>
<a href="../lib/SchemaItem.html#var$description">SchemaItem::$description</a>
</dt>
<dd>
</dd>
<dt>
<a href="../lib/SchemaItem.html#var$oid">SchemaItem::$oid</a>
</dt>
<dd>
</dd>
</dl>
</div>
</td>
<td valign="top">
<h3>Inherited Methods</h3>
<div class="tags">
<h4>Class: <a href="../lib/SchemaItem.html">SchemaItem</a></h4>
<dl>
<dt>
<a href="../lib/SchemaItem.html#methodSchemaItem">SchemaItem::SchemaItem()</a>
</dt>
<dd>
Default constructor.
</dd>
<dt>
<a href="../lib/SchemaItem.html#methodgetDescription">SchemaItem::getDescription()</a>
</dt>
<dd>
</dd>
<dt>
<a href="../lib/SchemaItem.html#methodgetOID">SchemaItem::getOID()</a>
</dt>
<dd>
</dd>
<dt>
<a href="../lib/SchemaItem.html#methodinitVars">SchemaItem::initVars()</a>
</dt>
<dd>
Initialize class members to default values.
</dd>
<dt>
<a href="../lib/SchemaItem.html#methodsetDescription">SchemaItem::setDescription()</a>
</dt>
<dd>
</dd>
<dt>
<a href="../lib/SchemaItem.html#methodsetOID">SchemaItem::setOID()</a>
</dt>
<dd>
</dd>
</dl>
</div>
</td>
</tr></table>
<hr />
<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 514]<br />
Represents an LDAP AttributeType<br /><br /></div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
<a name="var$aliases"></a>
<p></p>
<h4>$aliases = <span class="value"></span></h4>
<p>[line 539]</p>
An array of alias attribute names, strings<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$equality"></a>
<p></p>
<h4>$equality = <span class="value"></span></h4>
<p>[line 523]</p>
The equality rule used<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$is_collective"></a>
<p></p>
<h4>$is_collective = <span class="value"></span></h4>
<p>[line 533]</p>
boolean: is collective?<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$is_no_user_modification"></a>
<p></p>
<h4>$is_no_user_modification = <span class="value"></span></h4>
<p>[line 535]</p>
boolean: can use modify?<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$is_obsolete"></a>
<p></p>
<h4>$is_obsolete = <span class="value"></span></h4>
<p>[line 519]</p>
string: the description<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$is_single_value"></a>
<p></p>
<h4>$is_single_value = <span class="value"></span></h4>
<p>[line 531]</p>
boolean: is single valued only?<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$max_length"></a>
<p></p>
<h4>$max_length = <span class="value"></span></h4>
<p>[line 541]</p>
The max number of characters this attribute can be<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$name"></a>
<p></p>
<h4>$name = <span class="value"></span></h4>
<p>[line 517]</p>
The name of this attributeType<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$ordering"></a>
<p></p>
<h4>$ordering = <span class="value"></span></h4>
<p>[line 525]</p>
The ordering of the attributeType<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$required_by_object_classes"></a>
<p></p>
<h4>$required_by_object_classes = <span class="value">array()</span></h4>
<p>[line 547]</p>
A list of object class names that require this attribute type.<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$sub_str"></a>
<p></p>
<h4>$sub_str = <span class="value"></span></h4>
<p>[line 527]</p>
Boolean: supports substring matching?<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$sup_attribute"></a>
<p></p>
<h4>$sup_attribute = <span class="value"></span></h4>
<p>[line 521]</p>
The attribute from which this attribute inherits (if any)<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$syntax"></a>
<p></p>
<h4>$syntax = <span class="value"></span></h4>
<p>[line 529]</p>
The full syntax string, ie 1.2.3.4{16}<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$type"></a>
<p></p>
<h4>$type = <span class="value"></span></h4>
<p>[line 543]</p>
A string description of the syntax type (taken from the LDAPSyntaxes)<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$usage"></a>
<p></p>
<h4>$usage = <span class="value"></span></h4>
<p>[line 537]</p>
The usage string set by the LDAP schema<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$used_in_object_classes"></a>
<p></p>
<h4>$used_in_object_classes = <span class="value"></span></h4>
<p>[line 545]</p>
An array of objectClasses which use this attributeType (must be set by caller)<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />
<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
<hr />
<a name="methodAttributeType"></a>
<h3>constructor AttributeType <span class="smalllinenumber">[line 579]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>AttributeType AttributeType(
$raw_ldap_attr_string)</code>
</td></tr></table>
</td></tr></table><br />
Creates a new AttributeType objcet from a raw LDAP AttributeType string.<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$raw_ldap_attr_string</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodaddAlias"></a>
<h3>method addAlias <span class="smalllinenumber">[line 878]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void addAlias(
string
$new_alias_name)</code>
</td></tr></table>
</td></tr></table><br />
Adds an attribute name to the alias array.<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$new_alias_name</b> </td>
<td>The name of a new attribute to add to this attribute's list of aliases.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodaddRequiredByObjectClass"></a>
<h3>method addRequiredByObjectClass <span class="smalllinenumber">[line 948]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void addRequiredByObjectClass(
string
$object_class_name)</code>
</td></tr></table>
</td></tr></table><br />
Adds an objectClass name to this attribute's list of "required by" objectClasses, that is the list of objectClasses which must have this attribute.<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$object_class_name</b> </td>
<td>The name of the objectClass to add.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodaddUsedInObjectClass"></a>
<h3>method addUsedInObjectClass <span class="smalllinenumber">[line 924]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void addUsedInObjectClass(
string
$object_class_name)</code>
</td></tr></table>
</td></tr></table><br />
Adds an objectClass name to this attribute's list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$object_class_name</b> </td>
<td>The name of the objectClass to add.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetAliases"></a>
<h3>method getAliases <span class="smalllinenumber">[line 761]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getAliases(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets the names of attributes that are an alias for this attribute (if any).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>An array of names of attributes which alias this attribute or an empty array if no attribute aliases this object.</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetEquality"></a>
<h3>method getEquality <span class="smalllinenumber">[line 733]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getEquality(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets this attribute's equality string<br /><br /><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetIsCollective"></a>
<h3>method getIsCollective <span class="smalllinenumber">[line 833]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>bool getIsCollective(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets whether this attribute is collective.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Returns true if this attribute is collective and false otherwise.</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetIsNoUserModification"></a>
<h3>method getIsNoUserModification <span class="smalllinenumber">[line 842]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>bool getIsNoUserModification(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets whether this attribute is not modifiable by users.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Returns true if this attribute is not modifiable by users.</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetIsObsolete"></a>
<h3>method getIsObsolete <span class="smalllinenumber">[line 705]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>bool getIsObsolete(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets whether this attribute has been flagged as obsolete by the LDAP server<br /><br /><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetIsSingleValue"></a>
<h3>method getIsSingleValue <span class="smalllinenumber">[line 815]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>bool getIsSingleValue(
)</code>
</td></tr></table>
</td></tr></table><br />
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.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Returns true if this attribute is single-valued or false otherwise.</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetMaxLength"></a>
<h3>method getMaxLength <span class="smalllinenumber">[line 805]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int getMaxLength(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The maximum length (in characters) of this attribute or null if no maximum is specified.</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetName"></a>
<h3>method getName <span class="smalllinenumber">[line 696]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getName(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets this attribute's name<br /><br /><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetOrdering"></a>
<h3>method getOrdering <span class="smalllinenumber">[line 742]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getOrdering(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets this attribute's ordering specification.<br /><br /><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetRequiredByObjectClasses"></a>
<h3>method getRequiredByObjectClasses <span class="smalllinenumber">[line 962]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getRequiredByObjectClasses(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets the list of "required by" objectClasses, that is the list of objectClasses which provide must have attribute.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>An array of names of objectclasses (strings) which provide this attribute</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetSubstr"></a>
<h3>method getSubstr <span class="smalllinenumber">[line 751]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getSubstr(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets this attribute's substring matching specification<br /><br /><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetSupAttribute"></a>
<h3>method getSupAttribute <span class="smalllinenumber">[line 724]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getSupAttribute(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets this attribute's parent attribute (if any). If this attribute does not inherit from another attribute, null is returned.<br /><br /><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetSyntaxOID"></a>
<h3>method getSyntaxOID <span class="smalllinenumber">[line 796]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getSyntaxOID(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets this attribute's syntax OID. Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed.<br /><br /><p>Ie, if the syntax string is "1.2.3.4{16}", this function only retruns "1.2.3.4".</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The syntax OID string.</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetSyntaxString"></a>
<h3>method getSyntaxString <span class="smalllinenumber">[line 784]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getSyntaxString(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The raw syntax string</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetType"></a>
<h3>method getType <span class="smalllinenumber">[line 851]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getType(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets this attribute's type<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The attribute's type.</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetUsage"></a>
<h3>method getUsage <span class="smalllinenumber">[line 714]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getUsage(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets this attribute's usage string as defined by the LDAP server<br /><br /><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetUsedInObjectClasses"></a>
<h3>method getUsedInObjectClasses <span class="smalllinenumber">[line 938]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getUsedInObjectClasses(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets the list of "used in" objectClasses, that is the list of objectClasses which provide this attribute.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>An array of names of objectclasses (strings) which provide this attribute</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodinitVars"></a>
<h3>method initVars <span class="smalllinenumber">[line 552]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void initVars(
)</code>
</td></tr></table>
</td></tr></table><br />
Initialize the class' member variables<br /><br /><br /><br />
Overrides <a href="../lib/SchemaItem.html#methodinitVars">SchemaItem::initVars()</a> (Initialize class members to default values.)<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodisAliasFor"></a>
<h3>method isAliasFor <span class="smalllinenumber">[line 771]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>bool isAliasFor(
string
$attr_name)</code>
</td></tr></table>
</td></tr></table><br />
Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>True if the specified attribute is an alias for this one, or false otherwise.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$attr_name</b> </td>
<td>The name of the attribute to check.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodremoveAlias"></a>
<h3>method removeAlias <span class="smalllinenumber">[line 862]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>bool removeAlias(
string
$remove_alias_name)</code>
</td></tr></table>
</td></tr></table><br />
Removes an attribute name from this attribute's alias array.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>true on success or false on failure (ie, if the specified attribute name is not found in this attribute's list of aliases)</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$remove_alias_name</b> </td>
<td>The name of the attribute to remove.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetAliases"></a>
<h3>method setAliases <span class="smalllinenumber">[line 905]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setAliases(
array
$new_aliases)</code>
</td></tr></table>
</td></tr></table><br />
Sets this attribute's list of aliases.<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array </td>
<td><b>$new_aliases</b> </td>
<td>The array of alias names (strings)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetIsSingleValue"></a>
<h3>method setIsSingleValue <span class="smalllinenumber">[line 824]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setIsSingleValue(
bool
$is_single_value)</code>
</td></tr></table>
</td></tr></table><br />
Sets whether this attribute is single-valued.<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">bool </td>
<td><b>$is_single_value</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetName"></a>
<h3>method setName <span class="smalllinenumber">[line 887]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setName(
string
$new_name)</code>
</td></tr></table>
</td></tr></table><br />
Sets this attriute's name.<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$new_name</b> </td>
<td>The new name to give this attribute.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetSupAttribute"></a>
<h3>method setSupAttribute <span class="smalllinenumber">[line 896]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setSupAttribute(
string
$new_sup_attr)</code>
</td></tr></table>
</td></tr></table><br />
Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$new_sup_attr</b> </td>
<td>The name of the new parent (SUP) attribute</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetType"></a>
<h3>method setType <span class="smalllinenumber">[line 914]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setType(
string
$new_type)</code>
</td></tr></table>
</td></tr></table><br />
Sets this attribute's type.<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$new_type</b> </td>
<td>The new type.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div><br />
<div class="credit">
<hr />
Documentation generated on Mon, 13 Oct 2008 21:03:51 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
50a8f54faec0937919ad812d86f5c9d8
>
files
>
161
