348 lines
10 KiB
HTML
348 lines
10 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<title>Docs For Class SchemaItem</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: SchemaItem</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></pre><br />
|
||
|
|
<div class="description">Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.</div><br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td valign="top">
|
||
|
|
<h3><a href="#class_vars">Variables</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a href="../lib/SchemaItem.html#var$description">$description</a></li>
|
||
|
|
<li><a href="../lib/SchemaItem.html#var$oid">$oid</a></li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td valign="top">
|
||
|
|
<h3><a href="#class_methods">Methods</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a href="../lib/SchemaItem.html#methodSchemaItem">SchemaItem</a></li>
|
||
|
|
<li><a href="../lib/SchemaItem.html#methodgetDescription">getDescription</a></li>
|
||
|
|
<li><a href="../lib/SchemaItem.html#methodgetOID">getOID</a></li>
|
||
|
|
<li><a href="../lib/SchemaItem.html#methodinitVars">initVars</a></li>
|
||
|
|
<li><a href="../lib/SchemaItem.html#methodsetDescription">setDescription</a></li>
|
||
|
|
<li><a href="../lib/SchemaItem.html#methodsetOID">setOID</a></li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
</tr></table>
|
||
|
|
<hr />
|
||
|
|
|
||
|
|
<table width="100%" border="0"><tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td valign="top">
|
||
|
|
<h3>Child classes:</h3>
|
||
|
|
<div class="tags">
|
||
|
|
<dl>
|
||
|
|
<dt><a href="../lib/ObjectClass.html">ObjectClass</a></dt>
|
||
|
|
<dd>Represents an LDAP objectClass</dd>
|
||
|
|
</dl>
|
||
|
|
<dl>
|
||
|
|
<dt><a href="../lib/AttributeType.html">AttributeType</a></dt>
|
||
|
|
<dd>Represents an LDAP AttributeType</dd>
|
||
|
|
</dl>
|
||
|
|
<dl>
|
||
|
|
<dt><a href="../lib/Syntax.html">Syntax</a></dt>
|
||
|
|
<dd>Represents an LDAP Syntax</dd>
|
||
|
|
</dl>
|
||
|
|
<dl>
|
||
|
|
<dt><a href="../lib/MatchingRule.html">MatchingRule</a></dt>
|
||
|
|
<dd>Represents an LDAP MatchingRule</dd>
|
||
|
|
</dl>
|
||
|
|
<dl>
|
||
|
|
<dt><a href="../lib/MatchingRuleUse.html">MatchingRuleUse</a></dt>
|
||
|
|
<dd>Represents an LDAP schema matchingRuleUse entry</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</tr></table>
|
||
|
|
<hr />
|
||
|
|
|
||
|
|
<a name="class_details"></a>
|
||
|
|
<h3>Class Details</h3>
|
||
|
|
<div class="tags">
|
||
|
|
[line 45]<br />
|
||
|
|
Generic parent class for all schema items. A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.<br /><br /><p>All schema items have at least two things in common: An OID and a description. This class provides an implementation for these two data.</p><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$description"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$description = <span class="value"></span></h4>
|
||
|
|
<p>[line 50]</p>
|
||
|
|
The description of this schema item.<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$oid"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$oid = <span class="value"></span></h4>
|
||
|
|
<p>[line 48]</p>
|
||
|
|
The OID of this schema item.<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="methodSchemaItem"></a>
|
||
|
|
<h3>constructor SchemaItem <span class="smalllinenumber">[line 60]</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>SchemaItem SchemaItem(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Default constructor.<br /><br /><br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodgetDescription"></a>
|
||
|
|
<h3>method getDescription <span class="smalllinenumber">[line 80]</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 getDescription(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodgetOID"></a>
|
||
|
|
<h3>method getOID <span class="smalllinenumber">[line 75]</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 getOID(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodinitVars"></a>
|
||
|
|
<h3>method initVars <span class="smalllinenumber">[line 53]</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 class members to default values.<br /><br /><br /><br />
|
||
|
|
|
||
|
|
<p>Overridden in child classes as:<br />
|
||
|
|
<dl>
|
||
|
|
<dt><a href="../lib/ObjectClass.html#methodinitVars">ObjectClass::initVars()</a></dt>
|
||
|
|
<dd>Initialize the class' member variables</dd>
|
||
|
|
</dl>
|
||
|
|
<dl>
|
||
|
|
<dt><a href="../lib/AttributeType.html#methodinitVars">AttributeType::initVars()</a></dt>
|
||
|
|
<dd>Initialize the class' member variables</dd>
|
||
|
|
</dl>
|
||
|
|
<dl>
|
||
|
|
<dt><a href="../lib/Syntax.html#methodinitVars">Syntax::initVars()</a></dt>
|
||
|
|
<dd>Initializes the class' member variables</dd>
|
||
|
|
</dl>
|
||
|
|
<dl>
|
||
|
|
<dt><a href="../lib/MatchingRule.html#methodinitVars">MatchingRule::initVars()</a></dt>
|
||
|
|
<dd>Initialize the class' member variables</dd>
|
||
|
|
</dl>
|
||
|
|
<dl>
|
||
|
|
<dt><a href="../lib/MatchingRuleUse.html#methodinitVars">MatchingRuleUse::initVars()</a></dt>
|
||
|
|
<dd>Initialize the class' member variables</dd>
|
||
|
|
</dl>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodsetDescription"></a>
|
||
|
|
<h3>method setDescription <span class="smalllinenumber">[line 70]</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 setDescription(
|
||
|
|
mixed
|
||
|
|
$new_desc)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodsetOID"></a>
|
||
|
|
<h3>method setOID <span class="smalllinenumber">[line 65]</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 setOID(
|
||
|
|
mixed
|
||
|
|
$new_oid)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
<br /><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:06 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.2.3</a>
|
||
|
|
</div>
|
||
|
|
</td></tr></table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|