WMDE
/
LDAPAccountManager
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
LDAPAccountManager/lam-web/developers/phpdoc/lib/MatchingRule.html

473 lines
13 KiB
HTML
Raw Blame History

<html>
<head>
<title>Docs For Class MatchingRule</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_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_tests.html">tests</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: MatchingRule</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>
|
--MatchingRule</pre><br />
<div class="description">Represents an LDAP MatchingRule</div><br /><br />
</td>
<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
<li><a href="../lib/MatchingRule.html#var$is_obsolete">$is_obsolete</a></li>
<li><a href="../lib/MatchingRule.html#var$name">$name</a></li>
<li><a href="../lib/MatchingRule.html#var$syntax">$syntax</a></li>
<li><a href="../lib/MatchingRule.html#var$used_by_attrs">$used_by_attrs</a></li>
</ul>
</td>
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../lib/MatchingRule.html#methodMatchingRule">MatchingRule</a></li>
<li><a href="../lib/MatchingRule.html#methodaddUsedByAttr">addUsedByAttr</a></li>
<li><a href="../lib/MatchingRule.html#methodgetIsObsolete">getIsObsolete</a></li>
<li><a href="../lib/MatchingRule.html#methodgetName">getName</a></li>
<li><a href="../lib/MatchingRule.html#methodgetUsedByAttrs">getUsedByAttrs</a></li>
<li><a href="../lib/MatchingRule.html#methodinitVars">initVars</a></li>
<li><a href="../lib/MatchingRule.html#methodsetUsedByAttrs">setUsedByAttrs</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 1019]<br />
Represents an LDAP MatchingRule<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$is_obsolete"></a>
<p></p>
<h4>$is_obsolete = <span class="value"></span></h4>
<p>[line 1026]</p>
Boolean value indicating whether this MatchingRule is obsolete<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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 1022]</p>
This rule's name<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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 1024]</p>
This rule's syntax OID<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$used_by_attrs"></a>
<p></p>
<h4>$used_by_attrs = <span class="value"></span></h4>
<p>[line 1028]</p>
An array of attribute names who use this MatchingRule<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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="methodMatchingRule"></a>
<h3>constructor MatchingRule <span class="smalllinenumber">[line 1045]</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>MatchingRule MatchingRule(
mixed
$raw_ldap_matching_rule_string)</code>
</td></tr></table>
</td></tr></table><br />
Creates a new MatchingRule object from a raw LDAP MatchingRule string.<br /><br /><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodaddUsedByAttr"></a>
<h3>method addUsedByAttr <span class="smalllinenumber">[line 1115]</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>true addUsedByAttr(
mixed
$new_attr_name)</code>
</td></tr></table>
</td></tr></table><br />
Adds an attribute name to the list of attributes who use this MatchingRule<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>if the attribute was added and false otherwise (already in the list)</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 1137]</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 MatchingRule is flagged as obsolete by the LDAP server.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>True if this MatchingRule is obsolete and false otherwise.</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 1128]</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 MatchingRule's name.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>The name.</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetUsedByAttrs"></a>
<h3>method getUsedByAttrs <span class="smalllinenumber">[line 1146]</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 getUsedByAttrs(
)</code>
</td></tr></table>
</td></tr></table><br />
Gets an array of attribute names (strings) which use this MatchingRule<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>The array of attribute names (strings).</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 1031]</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="methodsetUsedByAttrs"></a>
<h3>method setUsedByAttrs <span class="smalllinenumber">[line 1106]</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 setUsedByAttrs(
array
$attrs)</code>
</td></tr></table>
</td></tr></table><br />
Sets the list of used_by_attrs to the array specified by $attrs;<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$attrs</b>&nbsp;&nbsp;</td>
<td>The array of attribute names (strings) which use this MatchingRule</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div><br />
<div class="credit">
<hr />
Documentation generated on Wed, 15 Nov 2006 18:01:05 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.2.3</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink