This class provides a base implementation for LDAP nodes

package Default

 Methods

Gets a LDAP attribute.

__get(string $name) : mixed

This is an offline method.

Parameters

$name

string

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

mixed

Checks whether a given attribute exists.

__isset(string $name) : boolean

Empty attributes will be treated as non-existent.

Parameters

$name

string

Returns

boolean

Sets a LDAP attribute.

__set(string $name, mixed $value) 

This is an offline method.

Parameters

$name

string

$value

mixed

Exceptions

\Zend\Ldap\Exception\BadMethodCallException

Cast to string representation {@see toString()}

__toString() : string

Returns

string

Deletes a LDAP attribute.

__unset($name) 

This method deletes the attribute.

This is an offline method.

Parameters

$name

Exceptions

\Zend\Ldap\Exception\BadMethodCallException

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

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

Parameters

$attribName

string

$value

mixedarray

Returns

boolean

Returns the number of attributes in node.

count() : integer

Implements Countable

Returns

integer

Checks whether a given attribute exists.

existsAttribute(string $name, boolean $emptyExists = false) : boolean

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.

Parameters

$name

string

$emptyExists

boolean

Returns

boolean

Gets a LDAP attribute.

getAttribute(string $name, integer $index = null) : mixed

This is an offline method.

Parameters

$name

string

$index

integer

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

mixed

Gets all attributes of node.

getAttributes(boolean $includeSystemAttributes = true) : array

The collection contains all attributes.

This is an offline method.

Parameters

$includeSystemAttributes

boolean

Returns

array

Gets node attributes.

getData(boolean $includeSystemAttributes = true) : array

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

This is an offline method.

Parameters

$includeSystemAttributes

boolean

Returns

array

Gets a LDAP date/time attribute.

getDateTimeAttribute(string $name, integer $index = null) : array | integer

This is an offline method.

Parameters

$name

string

$index

integer

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

arrayinteger

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

getDn() : \Zend\Ldap\Dn

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

This is an offline method.

Returns

\Zend\Ldap\Dn

Gets the DN of the current node as an array.

getDnArray(string $caseFold = null) : array

This is an offline method.

Parameters

$caseFold

string

Returns

array

Gets the DN of the current node as a string.

getDnString(string $caseFold = null) : string

This is an offline method.

Parameters

$caseFold

string

Returns

string

Gets the objectClass of the node

getObjectClass() : array

Returns

array

Gets the RDN of the current node as an array.

getRdnArray(string $caseFold = null) : array

This is an offline method.

Parameters

$caseFold

string

Returns

array

Gets the RDN of the current node as a string.

getRdnString(string $caseFold = null) : string

This is an offline method.

Parameters

$caseFold

string

Returns

string

Checks whether a given attribute exists.

offsetExists(string $name) : boolean

Implements ArrayAccess.

Empty attributes will be treated as non-existent.

Parameters

$name

string

Returns

boolean

Gets a LDAP attribute.

offsetGet(string $name) : mixed

Implements ArrayAccess.

This is an offline method.

Parameters

$name

string

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

mixed

Sets a LDAP attribute.

offsetSet(string $name, mixed $value) 

Implements ArrayAccess.

This is an offline method.

Parameters

$name

string

$value

mixed

Exceptions

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

Deletes a LDAP attribute.

offsetUnset($name) 

Implements ArrayAccess.

This method deletes the attribute.

This is an offline method.

Parameters

$name

Exceptions

\Zend\Ldap\Exception\BadMethodCallException

Reload node attributes from LDAP.

reload(\Zend\Ldap\Ldap $ldap = null) : \Zend\Ldap\Node\AbstractNode

This is an online method.

Parameters

$ldap

\Zend\Ldap\Ldap

Returns

\Zend\Ldap\Node\AbstractNodeProvides a fluid interface

Returns an array representation of the current node

toArray(boolean $includeSystemAttributes = true) : array

Parameters

$includeSystemAttributes

boolean

Returns

array

Returns a JSON representation of the current node

toJson(boolean $includeSystemAttributes = true) : string

Parameters

$includeSystemAttributes

boolean

Returns

string

Returns the DN of the current node. {@see getDnString()}

toString() : string

Returns

string

Constructor.

__construct(\Zend\Ldap\Dn $dn, array $data, boolean $fromDataSource) 

Constructor is protected to enforce the use of factory methods.

Parameters

$dn

\Zend\Ldap\Dn

$data

array

$fromDataSource

boolean

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

_getDn() : \Zend\Ldap\Dn

This is an offline method.

Returns

\Zend\Ldap\Dn

loadData()

loadData(array $data, boolean $fromDataSource) 

Parameters

$data

array

$fromDataSource

boolean

 Properties

 

Holds the node's current data.

$currentData : array

Default

 

Holds the node's DN.

$dn : \Zend\Ldap\Dn

Default

 

$systemAttributes

$systemAttributes 

Default

array('createtimestamp', 'creatorsname', 'entrycsn', 'entrydn', 'entryuuid', 'hassubordinates', 'modifiersname', 'modifytimestamp', 'structuralobjectclass', 'subschemasubentry', 'distinguishedname', 'instancetype', 'name', 'objectcategory', 'objectguid', 'usnchanged', 'usncreated', 'whenchanged', 'whencreated')
Static