LDAP Account Manager

ObjectClass extends SchemaItem
in package

Represents an LDAP objectClass

Table of Contents

$children_objectclasses  : mixed
array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)
$description  : mixed
The description of this schema item.
$is_obsolete  : mixed
boolean value indicating whether this objectClass is obsolete
$may_attrs  : mixed
arrays of attribute names that this objectClass allows, but does not require
$must_attrs  : mixed
arrays of attribute names that this objectClass requires
$name  : mixed
This objectClass' name, ie "inetOrgPerson"
$oid  : mixed
The OID of this schema item.
$sup_classes  : mixed
array of objectClass names from which this objectClass inherits
$type  : mixed
one of STRUCTURAL, ABSTRACT, or AUXILIARY
__construct()  : mixed
Creates a new ObjectClass object given a raw LDAP objectClass string.
addChildObjectClass()  : bool
Adds an objectClass to the list of objectClasses that inherit from this objectClass.
addMayAttrs()  : mixed
Behaves identically to addMustAttrs, but it operates on the MAY attributes of this objectClass.
addMustAttrs()  : mixed
Adds the specified array of attributes to this objectClass' list of MUST attributes. The resulting array of must attributes will contain unique members.
getChildObjectClasses()  : array<string|int, mixed>
Returns the array of objectClass names which inherit from this objectClass.
getDescription()  : mixed
getIsObsolete()  : mixed
Gets whether this objectClass is flagged as obsolete by the LDAP server.
getMayAttrNames()  : array<string|int, mixed>
Gets an array of attribute names (strings) that entries of this ObjectClass must define.
getMayAttrs()  : array<string|int, mixed>
Gets an array of AttributeType objects that entries of this ObjectClass may define.
getMustAttrNames()  : array<string|int, mixed>
Gets an array of attribute names (strings) that entries of this ObjectClass must define.
getMustAttrs()  : array<string|int, mixed>
Gets an array of AttributeType objects that entries of this ObjectClass must define.
getName()  : string
Gets the name of this objectClass (ie, "inetOrgPerson")
getOID()  : mixed
getSupClasses()  : array<string|int, mixed>
Gets the objectClass names from which this objectClass inherits.
getType()  : mixed
Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.
initVars()  : mixed
Initialize the class' member variables
setDescription()  : mixed
setOID()  : mixed

Properties

$children_objectclasses

array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)

public mixed $children_objectclasses

$description

The description of this schema item.

public mixed $description

$is_obsolete

boolean value indicating whether this objectClass is obsolete

public mixed $is_obsolete

$may_attrs

arrays of attribute names that this objectClass allows, but does not require

public mixed $may_attrs

$must_attrs

arrays of attribute names that this objectClass requires

public mixed $must_attrs

$name

This objectClass' name, ie "inetOrgPerson"

public mixed $name

$oid

The OID of this schema item.

public mixed $oid

$sup_classes

array of objectClass names from which this objectClass inherits

public mixed $sup_classes

$type

one of STRUCTURAL, ABSTRACT, or AUXILIARY

public mixed $type

Methods

__construct()

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

public __construct(mixed $raw_ldap_schema_string) : mixed
Parameters
$raw_ldap_schema_string : mixed
Return values
mixed —

addChildObjectClass()

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

public addChildObjectClass(string $object_class_name) : bool
Parameters
$object_class_name : string

The name of the objectClass to add

Return values
bool —

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

addMayAttrs()

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

public addMayAttrs(array<string|int, mixed> $new_may_attrs) : mixed
Parameters
$new_may_attrs : array<string|int, mixed>

An array of attribute names (strings) to add.

Return values
mixed —

addMustAttrs()

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

public addMustAttrs(array<string|int, mixed> $new_must_attrs) : mixed
Parameters
$new_must_attrs : array<string|int, mixed>

An array of attribute names (strings) to add.

Return values
mixed —

getChildObjectClasses()

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

public getChildObjectClasses() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Names of objectClasses which inherit from this objectClass.

getDescription()

public getDescription() : mixed
Return values
mixed —

getIsObsolete()

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

public getIsObsolete() : mixed
Return values
mixed —

getMayAttrNames()

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

public getMayAttrNames([array<string|int, mixed> $oclasses = null ]) : array<string|int, mixed>

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

Parameters
$oclasses : array<string|int, mixed> = null

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.

Tags
see
getMustAttrs
see
getMayAttrs
see
getMustAttrNames
Return values
array<string|int, mixed> —

The array of allowed attribute names (strings).

getMayAttrs()

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

public getMayAttrs([array<string|int, mixed> $oclasses = NULL ]) : array<string|int, mixed>

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

Parameters
$oclasses : array<string|int, mixed> = NULL

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.

Tags
see
getMustAttrNames
see
getMustAttrs
see
getMayAttrNames
see
AttributeType
Return values
array<string|int, mixed> —

The array of allowed AttributeType objects.

getMustAttrNames()

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

public getMustAttrNames([array<string|int, mixed> $oclasses = null ]) : array<string|int, mixed>

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

Parameters
$oclasses : array<string|int, mixed> = null

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.

Tags
see
getMustAttrs
see
getMayAttrs
see
getMayAttrNames
Return values
array<string|int, mixed> —

The array of allowed attribute names (strings).

getMustAttrs()

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

public getMustAttrs([array<string|int, mixed> $oclasses = NULL ]) : array<string|int, mixed>

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

Parameters
$oclasses : array<string|int, mixed> = NULL

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.

Tags
see
getMustAttrNames
see
getMayAttrs
see
getMayAttrNames
Return values
array<string|int, mixed> —

The array of required AttributeType objects.

getName()

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

public getName() : string
Return values
string —

The name of the objectClass

getOID()

public getOID() : mixed
Return values
mixed —

getSupClasses()

Gets the objectClass names from which this objectClass inherits.

public getSupClasses() : array<string|int, mixed>
Return values
array<string|int, mixed> —

An array of objectClass names (strings)

getType()

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

public getType() : mixed
Return values
mixed —

initVars()

Initialize the class' member variables

public initVars() : mixed
Return values
mixed —

setDescription()

public setDescription(mixed $new_desc) : mixed
Parameters
$new_desc : mixed
Return values
mixed —

setOID()

public setOID(mixed $new_oid) : mixed
Parameters
$new_oid : mixed
Return values
mixed —

Search results