Zend\Ldap\Node\Schema\ActiveDirectory provides a simple data-container for the Schema node of an Active Directory server.

 Methods

Gets a LDAP attribute.

__get(string $name) : mixed
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::__get()
inherited_from \Zend\Ldap\Node\Schema::__get()

Parameters

$name

string

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

mixed

Checks whether a given attribute exists.

__isset(string $name) : bool
Inherited

Empty attributes will be treated as non-existent.

inherited_from \Zend\Ldap\Node\AbstractNode::__isset()
inherited_from \Zend\Ldap\Node\Schema::__isset()

Parameters

$name

string

Returns

bool

Sets a LDAP attribute.

__set(string $name, mixed $value) 
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::__set()
inherited_from \Zend\Ldap\Node\Schema::__set()

Parameters

$name

string

$value

mixed

Exceptions

\Zend\Ldap\Exception\BadMethodCallException

Cast to string representation {@see toString()}

__toString() : string
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::__toString()
inherited_from \Zend\Ldap\Node\Schema::__toString()

Returns

string

Deletes a LDAP attribute.

__unset($name) 
Inherited

This method deletes the attribute.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::__unset()
inherited_from \Zend\Ldap\Node\Schema::__unset()

Parameters

$name

Exceptions

\Zend\Ldap\Exception\BadMethodCallException

Checks if the given value(s) exist in the attribute

attributeHasValue(string $attribName, mixed | array $value) : bool
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::attributeHasValue()
inherited_from \Zend\Ldap\Node\Schema::attributeHasValue()

Parameters

$attribName

string

$value

mixedarray

Returns

bool

Returns the number of attributes in node.

count() : int
Inherited

Implements Countable

inherited_from \Zend\Ldap\Node\AbstractNode::count()
inherited_from \Zend\Ldap\Node\Schema::count()

Returns

int

Factory method to create the Schema node.

create(\Zend\Ldap\Ldap $ldap) : \Zend\Ldap\Node\Schema
Inherited

inherited_from \Zend\Ldap\Node\Schema::create()

Parameters

Returns

Checks whether a given attribute exists.

existsAttribute(string $name, bool $emptyExists) : bool
Inherited

If $emptyExists is false empty attributes (containing only array()) are treated as non-existent returning false. If $emptyExists is true empty attributes are treated as existent returning true. In this case method returns false only if the attribute name is missing in the key-collection.

inherited_from \Zend\Ldap\Node\AbstractNode::existsAttribute()
inherited_from \Zend\Ldap\Node\Schema::existsAttribute()

Parameters

$name

string

$emptyExists

bool

Returns

bool

Gets a LDAP attribute.

getAttribute(string $name, int $index) : mixed
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getAttribute()
inherited_from \Zend\Ldap\Node\Schema::getAttribute()

Parameters

$name

string

$index

int

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

mixed

Gets the attribute Types

getAttributeTypes() : array

Returns

array

Gets all attributes of node.

getAttributes(bool $includeSystemAttributes) : array
Inherited

The collection contains all attributes.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getAttributes()
inherited_from \Zend\Ldap\Node\Schema::getAttributes()

Parameters

$includeSystemAttributes

bool

Returns

array

Gets node attributes.

getData(bool $includeSystemAttributes) : array
Inherited

The array contains all attributes in its internal format (no conversion).

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getData()
inherited_from \Zend\Ldap\Node\Schema::getData()

Parameters

$includeSystemAttributes

bool

Returns

array

Gets a LDAP date/time attribute.

getDateTimeAttribute(string $name, int $index) : array | int
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getDateTimeAttribute()
inherited_from \Zend\Ldap\Node\Schema::getDateTimeAttribute()

Parameters

$name

string

$index

int

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

arrayint

Gets the DN of the current node as a Zend\Ldap\Dn.

getDn() : \Zend\Ldap\Dn
Inherited

The method returns a clone of the node's DN to prohibit modification.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getDn()
inherited_from \Zend\Ldap\Node\Schema::getDn()

Returns

Gets the DN of the current node as an array.

getDnArray(string $caseFold) : array
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getDnArray()
inherited_from \Zend\Ldap\Node\Schema::getDnArray()

Parameters

$caseFold

string

Returns

array

Gets the DN of the current node as a string.

getDnString(string $caseFold) : string
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getDnString()
inherited_from \Zend\Ldap\Node\Schema::getDnString()

Parameters

$caseFold

string

Returns

string

Gets the objectClass of the node

getObjectClass() : array
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::getObjectClass()
inherited_from \Zend\Ldap\Node\Schema::getObjectClass()

Returns

array

Gets the object classes

getObjectClasses() : array

Returns

array

Gets the RDN of the current node as an array.

getRdnArray(string $caseFold) : array
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getRdnArray()
inherited_from \Zend\Ldap\Node\Schema::getRdnArray()

Parameters

$caseFold

string

Returns

array

Gets the RDN of the current node as a string.

getRdnString(string $caseFold) : string
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getRdnString()
inherited_from \Zend\Ldap\Node\Schema::getRdnString()

Parameters

$caseFold

string

Returns

string

Checks whether a given attribute exists.

offsetExists(string $name) : bool
Inherited

Implements ArrayAccess.

Empty attributes will be treated as non-existent.

inherited_from \Zend\Ldap\Node\AbstractNode::offsetExists()
inherited_from \Zend\Ldap\Node\Schema::offsetExists()

Parameters

$name

string

Returns

bool

Gets a LDAP attribute.

offsetGet(string $name) : mixed
Inherited

Implements ArrayAccess.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::offsetGet()
inherited_from \Zend\Ldap\Node\Schema::offsetGet()

Parameters

$name

string

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

mixed

Sets a LDAP attribute.

offsetSet(string $name, mixed $value) 
Inherited

Implements ArrayAccess.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::offsetSet()
inherited_from \Zend\Ldap\Node\Schema::offsetSet()

Parameters

$name

string

$value

mixed

Exceptions

\Zend\Ldap\Exception\BadMethodCallException
\Zend\Ldap\Exception\BadMethodCallException

Deletes a LDAP attribute.

offsetUnset($name) 
Inherited

Implements ArrayAccess.

This method deletes the attribute.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::offsetUnset()
inherited_from \Zend\Ldap\Node\Schema::offsetUnset()

Parameters

$name

Exceptions

\Zend\Ldap\Exception\BadMethodCallException

Reload node attributes from LDAP.

reload(\Zend\Ldap\Ldap $ldap) : \Zend\Ldap\Node\AbstractNode
Inherited

This is an online method.

inherited_from \Zend\Ldap\Node\AbstractNode::reload()
inherited_from \Zend\Ldap\Node\Schema::reload()

Parameters

Returns

\Zend\Ldap\Node\AbstractNodeProvides a fluid interface

Returns an array representation of the current node

toArray(bool $includeSystemAttributes) : array
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::toArray()
inherited_from \Zend\Ldap\Node\Schema::toArray()

Parameters

$includeSystemAttributes

bool

Returns

array

Returns a JSON representation of the current node

toJson(bool $includeSystemAttributes) : string
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::toJson()
inherited_from \Zend\Ldap\Node\Schema::toJson()

Parameters

$includeSystemAttributes

bool

Returns

string

Returns the DN of the current node.

toString() : string
Inherited

{@see getDnString()}

inherited_from \Zend\Ldap\Node\AbstractNode::toString()
inherited_from \Zend\Ldap\Node\Schema::toString()

Returns

string

Constructor.

__construct(\Zend\Ldap\Dn $dn, array $data, \Zend\Ldap\Ldap $ldap) 
Inherited

Constructor is protected to enforce the use of factory methods.

inherited_from \Zend\Ldap\Node\Schema::__construct()

Parameters

$data

array

Gets the DN of the current node as a Zend\Ldap\Dn.

_getDn() : \Zend\Ldap\Dn
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::_getDn()
inherited_from \Zend\Ldap\Node\Schema::_getDn()

Returns

loadData()

loadData(array $data, bool $fromDataSource) 
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::loadData()
inherited_from \Zend\Ldap\Node\Schema::loadData()

Parameters

$data

array

$fromDataSource

bool

Parses the schema

parseSchema(\Zend\Ldap\Dn $dn, \Zend\Ldap\Ldap $ldap) : \Zend\Ldap\Node\Schema\ActiveDirectory

Parameters

Returns

\Zend\Ldap\Node\Schema\ActiveDirectoryProvides a fluid interface

 Properties

 

The attribute Types

$attributeTypes : array

 

Holds the node's current data.

$currentData : array
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::$$currentData
inherited_from \Zend\Ldap\Node\Schema::$$currentData
 

Holds the node's DN.

$dn : \Zend\Ldap\Dn
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::$$dn
inherited_from \Zend\Ldap\Node\Schema::$$dn
 

The object classes

$objectClasses : array

 

$systemAttributes

$systemAttributes 
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::$$systemAttributes
inherited_from \Zend\Ldap\Node\Schema::$$systemAttributes

 Constants

 

OBJECTCLASS_TYPE_ABSTRACT

OBJECTCLASS_TYPE_ABSTRACT 
Inherited

inherited_from \Zend\Ldap\Node\Schema::OBJECTCLASS_TYPE_ABSTRACT
 

OBJECTCLASS_TYPE_AUXILIARY

OBJECTCLASS_TYPE_AUXILIARY 
Inherited

inherited_from \Zend\Ldap\Node\Schema::OBJECTCLASS_TYPE_AUXILIARY
 

OBJECTCLASS_TYPE_STRUCTURAL

OBJECTCLASS_TYPE_STRUCTURAL 
Inherited

inherited_from \Zend\Ldap\Node\Schema::OBJECTCLASS_TYPE_STRUCTURAL
 

OBJECTCLASS_TYPE_UNKNOWN

OBJECTCLASS_TYPE_UNKNOWN 
Inherited

inherited_from \Zend\Ldap\Node\Schema::OBJECTCLASS_TYPE_UNKNOWN