Docs For Class ObjectClass

ObjectClass ObjectClass(

$raw_ldap_schema_string, 
$ldapserver)

Creates a new ObjectClass object given a raw LDAP objectClass string.

Parameters:

	$raw_ldap_schema_string
	$ldapserver

[ Top ]

bool addChildObjectClass(
String
$object_class_name)

Adds an objectClass to the list of objectClasses that inherit from this objectClass.

Tags:

return:

Returns true on success or false on failure (objectclass already existed for example)

Parameters:

String

$object_class_name

The name of the objectClass to add

[ Top ]

void addMayAttrs(
array
$new_may_attrs)

Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.

Parameters:

array

$new_may_attrs

An array of attribute names (strings) to add.

[ Top ]

void addMustAttrs(
array
$new_must_attrs)

Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.

Parameters:

array

$new_must_attrs

An array of attribute names (strings) to add.

[ Top ]

Array getChildObjectClasses(
)

Returns the array of objectClass names which inherit from this objectClass.

Tags:

return:

Names of objectClasses which inherit from this objectClass.

[ Top ]

void getIsObsolete(
)

Gets whether this objectClass is flagged as obsolete by the LDAP server.

[ Top ]

array getMayAttrNames(
[array
$oclasses = null])

Gets an array of attribute names (strings) that entries of this ObjectClass must define.

This differs from getMayAttrs in that it returns an array of strings rather than array of AttributeType objects

Tags:

return:	The array of allowed attribute names (strings).
see:	ObjectClass::getMustAttrNames()
see:	ObjectClass::getMayAttrs()
see:	ObjectClass::getMustAttrs()

Parameters:

array

$oclasses

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.

[ Top ]

array getMayAttrs(
[array
$oclasses = null])

Gets an array of AttributeType objects that entries of this ObjectClass may define.

This differs from getMayAttrNames in that it returns an array of AttributeType objects

Tags:

return:	The array of allowed AttributeType objects.
see:	AttributeType
see:	ObjectClass::getMayAttrNames()
see:	ObjectClass::getMustAttrs()
see:	ObjectClass::getMustAttrNames()

Parameters:

array

$oclasses

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.

[ Top ]

array getMustAttrNames(
[array
$oclasses = null])

Gets an array of attribute names (strings) that entries of this ObjectClass must define.

This differs from getMustAttrs in that it returns an array of strings rather than array of AttributeType objects

Tags:

return:	The array of allowed attribute names (strings).
see:	ObjectClass::getMayAttrNames()
see:	ObjectClass::getMayAttrs()
see:	ObjectClass::getMustAttrs()

Parameters:

array

$oclasses

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.

[ Top ]

array getMustAttrs(
[array
$oclasses = null])

Gets an array of AttributeType objects that entries of this ObjectClass must define.

This differs from getMustAttrNames in that it returns an array of AttributeType objects

Tags:

return:	The array of required AttributeType objects.
see:	ObjectClass::getMayAttrNames()
see:	ObjectClass::getMayAttrs()
see:	ObjectClass::getMustAttrNames()

Parameters:

array

$oclasses

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.

[ Top ]

string getName(
)

Gets the name of this objectClass (ie, "inetOrgPerson")

Tags:

return:

The name of the objectClass

[ Top ]

array getSupClasses(
)

Gets the objectClass names from which this objectClass inherits.

Tags:

return:

An array of objectClass names (strings)

[ Top ]

void getType(
)

Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.

[ Top ]

void initVars(

$ldapserver)

Overrides SchemaItem::initVars() (parent method not documented)

Parameters:

$ldapserver

[ Top ]

void _parse_list(

$i, 
$strings, 
&$attrs)

Parameters:

	$i
	$strings
	&$attrs

[ Top ]

Class: ObjectClass

Class Overview

Variables

Methods

Inherited Variables

Class: SchemaItem

Inherited Methods

Class: SchemaItem

Class Details

Class Variables

$children_objectclasses =

$is_obsolete =

$may_attrs =

$must_attrs =

$name =

$sup_classes =

$type =

Class Methods

constructor ObjectClass [line 147]

Parameters:

method addChildObjectClass [line 457]

Tags:

Parameters:

method addMayAttrs [line 538]

Parameters:

method addMustAttrs [line 519]

Parameters:

method getChildObjectClasses [line 477]

Tags:

method getIsObsolete [line 508]

method getMayAttrNames [line 438]

Tags:

Parameters:

method getMayAttrs [line 367]

Tags:

Parameters:

method getMustAttrNames [line 410]

Tags:

Parameters:

method getMustAttrs [line 325]

Tags:

Parameters:

method getName [line 485]

Tags:

method getSupClasses [line 494]

Tags:

method getType [line 501]

method initVars [line 70]

Parameters:

method _parse_list [line 84]

Parameters: