2006-11-15 17:12:15 +00:00
< html >
< head >
< title > Docs For Class ObjectClass< / 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" >
2007-11-04 11:19:11 +00:00
[ < a href = "../classtrees_lib.html" class = "menu" > class tree: lib< / a > ]
2006-11-15 17:12:15 +00:00
[ < a href = "../elementindex_lib.html" class = "menu" > index: lib< / a > ]
2007-11-04 11:19:11 +00:00
[ < a href = "../elementindex.html" class = "menu" > all elements< / a > ]
2006-11-15 17:12:15 +00:00
< / 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" >
2007-11-04 11:19:11 +00:00
< p > < a href = "../ric_README.html" > README< / a > < / p >
2008-01-06 18:15:35 +00:00
< p > < a href = "../ric_INSTALL.html" > INSTALL< / a > < / p >
2006-11-15 17:12:15 +00:00
< / 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" >
2007-11-04 11:19:11 +00:00
< a href = "../lib/_lib---account.inc.html" > account.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../lib/_lib---cache.inc.html" > cache.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../lib/_lib---schema.inc.html" > schema.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../lib/_lib---security.inc.html" > security.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../lib/_lib---status.inc.html" > status.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
< / div > < br / >
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< / td >
< td >
< table cellpadding = "10" cellspacing = "0" width = "100%" border = "0" > < tr > < td valign = "top" >
< h1 > Class: ObjectClass< / 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 >
|
--ObjectClass< / pre > < br / >
< div class = "description" > Represents an LDAP objectClass< / div > < br / > < br / >
< / td >
< td valign = "top" >
< h3 > < a href = "#class_vars" > Variables< / a > < / h3 >
< ul >
< li > < a href = "../lib/ObjectClass.html#var$children_objectclasses" > $children_objectclasses< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#var$is_obsolete" > $is_obsolete< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#var$may_attrs" > $may_attrs< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#var$must_attrs" > $must_attrs< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#var$name" > $name< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#var$sup_classes" > $sup_classes< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#var$type" > $type< / a > < / li >
< / ul >
< / td >
< td valign = "top" >
< h3 > < a href = "#class_methods" > Methods< / a > < / h3 >
< ul >
< li > < a href = "../lib/ObjectClass.html#methodObjectClass" > ObjectClass< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodaddChildObjectClass" > addChildObjectClass< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodaddMayAttrs" > addMayAttrs< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodaddMustAttrs" > addMustAttrs< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodgetChildObjectClasses" > getChildObjectClasses< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodgetIsObsolete" > getIsObsolete< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodgetMayAttrNames" > getMayAttrNames< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodgetMayAttrs" > getMayAttrs< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodgetMustAttrNames" > getMustAttrNames< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodgetMustAttrs" > getMustAttrs< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodgetName" > getName< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodgetSupClasses" > getSupClasses< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodgetType" > getType< / a > < / li >
< li > < a href = "../lib/ObjectClass.html#methodinitVars" > initVars< / 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 >
2007-11-04 11:19:11 +00:00
< / dt >
2006-11-15 17:12:15 +00:00
< dd >
< / dd >
< dt >
< a href = "../lib/SchemaItem.html#var$oid" > SchemaItem::$oid< / a >
2007-11-04 11:19:11 +00:00
< / dt >
2006-11-15 17:12:15 +00:00
< 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 91]< br / >
Represents an LDAP objectClass< 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$children_objectclasses" > < / a >
< p > < / p >
< h4 > $children_objectclasses = < span class = "value" > < / span > < / h4 >
< p > [line 106]< / p >
array of objectClasses which inherit from this one (must be set at runtime explicitly by the 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 / >
< a name = "var$is_obsolete" > < / a >
< p > < / p >
< h4 > $is_obsolete = < span class = "value" > < / span > < / h4 >
< p > [line 104]< / p >
boolean value indicating whether this objectClass is obsolete< 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$may_attrs" > < / a >
< p > < / p >
< h4 > $may_attrs = < span class = "value" > < / span > < / h4 >
< p > [line 102]< / p >
arrays of attribute names that this objectClass allows, but does not require< 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$must_attrs" > < / a >
< p > < / p >
< h4 > $must_attrs = < span class = "value" > < / span > < / h4 >
< p > [line 100]< / p >
arrays of attribute names that this objectClass requires< 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 94]< / p >
This objectClass' name, ie " inetOrgPerson" < 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_classes" > < / a >
< p > < / p >
< h4 > $sup_classes = < span class = "value" > < / span > < / h4 >
< p > [line 96]< / p >
array of objectClass names from which this objectClass inherits< 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 98]< / p >
one of STRUCTURAL, ABSTRACT, or AUXILIARY< 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 = "methodObjectClass" > < / a >
< h3 > constructor ObjectClass < span class = "smalllinenumber" > [line 126]< / 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 > ObjectClass ObjectClass(
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
$raw_ldap_schema_string)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Creates a new ObjectClass object given a raw LDAP objectClass string.< br / > < br / > < br / > < br / >
2007-11-04 11:19:11 +00:00
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > < / td >
< td > < b > $raw_ldap_schema_string< / b > < / td >
< td > < / td >
< / tr >
< / table >
< / div > < br / >
2006-11-15 17:12:15 +00:00
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodaddChildObjectClass" > < / a >
< h3 > method addChildObjectClass < span class = "smalllinenumber" > [line 376]< / 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 addChildObjectClass(
String
$object_class_name)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Adds an objectClass to the list of objectClasses that inherit from this objectClass.< 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 on success or false on failure (objectclass already existed for example)< / 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 > $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 = "methodaddMayAttrs" > < / a >
< h3 > method addMayAttrs < span class = "smalllinenumber" > [line 454]< / 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 addMayAttrs(
array
$new_may_attrs)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.< 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_may_attrs< / b > < / td >
< td > An array of attribute names (strings) to add.< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodaddMustAttrs" > < / a >
< h3 > method addMustAttrs < span class = "smalllinenumber" > [line 439]< / 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 addMustAttrs(
array
$new_must_attrs)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.< 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_must_attrs< / b > < / td >
< td > An array of attribute names (strings) to add.< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetChildObjectClasses" > < / a >
< h3 > method getChildObjectClasses < span class = "smalllinenumber" > [line 392]< / 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 getChildObjectClasses(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Returns the array of objectClass names which inherit from this objectClass.< br / > < br / > < br / > < br / >
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td > < b > return:< / b > < / td > < td > Names of objectClasses which inherit from this objectClass.< / 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 427]< / 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 getIsObsolete(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Gets whether this objectClass is flagged as obsolete by the LDAP server.< br / > < br / > < br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetMayAttrNames" > < / a >
< h3 > method getMayAttrNames < span class = "smalllinenumber" > [line 361]< / 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 getMayAttrNames(
[array
$oclasses = null])< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Gets an array of attribute names (strings) that entries of this ObjectClass must define.< br / > < br / > < p > This differs from getMayAttrs in that it returns an array of strings rather than array of AttributeType objects< / 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 array of allowed attribute names (strings).< / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMustAttrNames" > ObjectClass::getMustAttrNames()< / a > < / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMayAttrs" > ObjectClass::getMayAttrs()< / a > < / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMustAttrs" > ObjectClass::getMustAttrs()< / a > < / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $oclasses< / b > < / td >
< td > An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetMayAttrs" > < / a >
< h3 > method getMayAttrs < span class = "smalllinenumber" > [line 303]< / 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 getMayAttrs(
[array
$oclasses = NULL])< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Gets an array of AttributeType objects that entries of this ObjectClass may define.< br / > < br / > < p > This differs from getMayAttrNames in that it returns an array of AttributeType objects< / 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 array of allowed AttributeType objects.< / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/AttributeType.html" > AttributeType< / a > < / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMayAttrNames" > ObjectClass::getMayAttrNames()< / a > < / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMustAttrs" > ObjectClass::getMustAttrs()< / a > < / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMustAttrNames" > ObjectClass::getMustAttrNames()< / a > < / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $oclasses< / b > < / td >
< td > An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetMustAttrNames" > < / a >
< h3 > method getMustAttrNames < span class = "smalllinenumber" > [line 337]< / 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 getMustAttrNames(
[array
$oclasses = null])< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Gets an array of attribute names (strings) that entries of this ObjectClass must define.< br / > < br / > < p > This differs from getMustAttrs in that it returns an array of strings rather than array of AttributeType objects< / 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 array of allowed attribute names (strings).< / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMayAttrNames" > ObjectClass::getMayAttrNames()< / a > < / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMayAttrs" > ObjectClass::getMayAttrs()< / a > < / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMustAttrs" > ObjectClass::getMustAttrs()< / a > < / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $oclasses< / b > < / td >
< td > An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides.< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetMustAttrs" > < / a >
< h3 > method getMustAttrs < span class = "smalllinenumber" > [line 269]< / 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 getMustAttrs(
[array
$oclasses = NULL])< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Gets an array of AttributeType objects that entries of this ObjectClass must define.< br / > < br / > < p > This differs from getMustAttrNames in that it returns an array of AttributeType objects< / 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 array of required AttributeType objects.< / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMayAttrNames" > ObjectClass::getMayAttrNames()< / a > < / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMayAttrs" > ObjectClass::getMayAttrs()< / a > < / td >
< / tr >
< tr >
< td > < b > see:< / b > < / td > < td > < a href = "../lib/ObjectClass.html#methodgetMustAttrNames" > ObjectClass::getMustAttrNames()< / a > < / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< h4 > Parameters:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
< td class = "type" > array < / td >
< td > < b > $oclasses< / b > < / td >
< td > An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass requires.< / td >
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetName" > < / a >
< h3 > method getName < span class = "smalllinenumber" > [line 401]< / 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 the name of this objectClass (ie, " inetOrgPerson" )< 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 name of the objectClass< / td >
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodgetSupClasses" > < / a >
< h3 > method getSupClasses < span class = "smalllinenumber" > [line 411]< / 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 getSupClasses(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Gets the objectClass names from which this objectClass inherits.< 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 objectClass names (strings)< / 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 419]< / 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 getType(
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.< br / > < 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 109]< / 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 / >
2007-11-04 11:19:11 +00:00
Overrides < a href = "../lib/SchemaItem.html#methodinitVars" > SchemaItem::initVars()< / a > (Initialize class members to default values.)< br / > < br / >
2006-11-15 17:12:15 +00:00
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< / div > < br / >
< div class = "credit" >
< hr / >
2008-01-06 18:15:35 +00:00
Documentation generated on Sun, 06 Jan 2008 18:59:29 +0100 by < a href = "http://www.phpdoc.org" > phpDocumentor 1.4.0< / a >
2006-11-15 17:12:15 +00:00
< / div >
< / td > < / tr > < / table >
< / td >
< / tr >
< / table >
< / body >
< / html >
