ZendLdapNode provides an object oriented view into a LDAP node.
Constructor.
Constructor is protected to enforce the use of factory methods.
Parameters: |
|
---|---|
Throws ExceptionLdapException: | |
Serialization callback
Only Dn and attributes will be serialized.
Return type: | array |
---|
Gets the current LDAP connection.
Return type: | Ldap |
---|---|
Throws : | ExceptionLdapException |
Attach node to an LDAP connection
This is an offline method.
Parameters: | Ldap – |
---|---|
Return type: | Node Provides a fluid interface |
Throws : | ExceptionLdapException |
Detach node from LDAP connection
This is an offline method.
Return type: | Node Provides a fluid interface |
---|
Checks if the current node is attached to a LDAP server.
This is an offline method.
Return type: | bool |
---|
Trigger an event
Parameters: |
|
---|
@param array $data
Parameters: | bool – |
---|---|
Throws ExceptionLdapException: | |
Factory method to create a new detached ZendLdapNode for a given DN.
Parameters: |
|
---|---|
Return type: | Node |
Throws : | ExceptionLdapException |
Factory method to create an attached ZendLdapNode for a given DN.
Parameters: |
|
---|---|
Return type: | Node|null |
Throws : | ExceptionLdapException |
Factory method to create a detached ZendLdapNode from array data.
Parameters: |
|
---|---|
Return type: | Node |
Throws : | ExceptionLdapException |
Ensures that teh RDN attributes are correctly set.
Parameters: | bool – True to overwrite the RDN attributes |
---|---|
Return type: | void |
Marks this node as new.
Node will be added (instead of updated) on calling update() if $new is true.
Parameters: | bool – |
---|
Marks this node as to be deleted.
Node will be deleted on calling update() if $delete is true.
Parameters: | bool – |
---|
Is this node going to be deleted once update() is called?
Return type: | bool |
---|
Marks this node as to be deleted
Node will be deleted on calling update() if $delete is true.
Return type: | Node Provides a fluid interface |
---|
Is this node going to be moved once update() is called?
Return type: | bool |
---|
Sends all pending changes to the LDAP server
Parameters: | Ldap – |
---|---|
Return type: | Node Provides a fluid interface |
Throws : | ExceptionLdapException @trigger pre-delete |
@trigger post-delete @trigger pre-add @trigger post-add @trigger pre-rename @trigger post-rename @trigger pre-update @trigger post-update
Gets the DN of the current node as a ZendLdapDn.
This is an offline method.
Return type: | Dn |
---|
Gets the current DN of the current node as a ZendLdapDn. The method returns a clone of the node’s DN to prohibit modification.
This is an offline method.
Return type: | Dn |
---|
Sets the new DN for this node
This is an offline method.
Parameters: | Dn|string|array – |
---|---|
Throws ExceptionLdapException: | |
Return type: | Node Provides a fluid interface |
{@see setDn()}
This is an offline method.
Parameters: | Dn|string|array – |
---|---|
Throws ExceptionLdapException: | |
Return type: | Node Provides a fluid interface |
{@see setDn()}
This is an offline method.
Parameters: | Dn|string|array – |
---|---|
Throws ExceptionLdapException: | |
Return type: | Node Provides a fluid interface |
Sets the objectClass.
This is an offline method.
Parameters: | array|string – |
---|---|
Return type: | Node Provides a fluid interface |
Throws : | ExceptionLdapException |
Appends to the objectClass.
This is an offline method.
Parameters: | array|string – |
---|---|
Return type: | Node Provides a fluid interface |
Throws : | ExceptionLdapException |
Returns a LDIF representation of the current node
Parameters: | array – Additional options used during encoding |
---|---|
Return type: | string |
Returns all changes made.
This is an offline method.
Return type: | array |
---|
Sets a LDAP attribute.
This is an offline method.
Parameters: |
|
---|---|
Return type: | Node Provides a fluid interface |
Throws : | ExceptionLdapException |
Appends to a LDAP attribute.
This is an offline method.
Parameters: |
|
---|---|
Return type: | Node Provides a fluid interface |
Throws : | ExceptionLdapException |
Checks if the attribute can be set and sets it accordingly.
Parameters: |
|
---|---|
Throws ExceptionLdapException: | |
Sets a LDAP date/time attribute.
This is an offline method.
Parameters: |
|
---|---|
Return type: | Node Provides a fluid interface |
Throws : | ExceptionLdapException |
Appends to a LDAP date/time attribute.
This is an offline method.
Parameters: |
|
---|---|
Return type: | Node Provides a fluid interface |
Throws : | ExceptionLdapException |
Checks if the attribute can be set and sets it accordingly.
Parameters: |
|
---|---|
Throws ExceptionLdapException: | |
Sets a LDAP password.
Parameters: |
|
---|---|
Return type: | Node Provides a fluid interface |
Throws : | ExceptionLdapException |
Deletes a LDAP attribute.
This method deletes the attribute.
This is an offline method.
Parameters: | string – |
---|---|
Return type: | Node Provides a fluid interface |
Throws : | ExceptionLdapException |
Removes duplicate values from a LDAP attribute
Parameters: | string – |
---|---|
Return type: | void |
Remove given values from a LDAP attribute
Parameters: |
|
---|---|
Return type: | void |
@param string $name
Return type: | bool |
---|---|
Throws : | ExceptionLdapException |
Sets a LDAP attribute.
This is an offline method.
Parameters: |
|
---|
Deletes a LDAP attribute.
This method deletes the attribute.
This is an offline method.
Parameters: | string – |
---|---|
Throws ExceptionLdapException: | |
Sets a LDAP attribute. Implements ArrayAccess.
This is an offline method.
Parameters: |
|
---|---|
Throws ExceptionLdapException: | |
Deletes a LDAP attribute. Implements ArrayAccess.
This method deletes the attribute.
This is an offline method.
Parameters: | string – |
---|---|
Throws ExceptionLdapException: | |
Check if node exists on LDAP.
This is an online method.
Parameters: | Ldap – |
---|---|
Return type: | bool |
Throws : | ExceptionLdapException |
Reload node attributes from LDAP.
This is an online method.
Parameters: | Ldap – |
---|---|
Return type: | Node Provides a fluid interface |
Throws : | ExceptionLdapException |
Search current subtree with given options.
This is an online method.
Parameters: |
|
---|---|
Return type: | NodeCollection |
Throws : | ExceptionLdapException |
Count items in current subtree found by given filter.
This is an online method.
Parameters: |
|
---|---|
Return type: | integer |
Throws : | ExceptionLdapException |
Count children of current node.
This is an online method.
Return type: | integer |
---|---|
Throws : | ExceptionLdapException |
Gets children of current node.
This is an online method.
Parameters: |
|
---|---|
Return type: | NodeCollection |
Throws : | ExceptionLdapException |
Checks if current node has children. Returns whether the current element has children.
Can be used offline but returns false if children have not been retrieved yet.
Return type: | bool |
---|---|
Throws : | ExceptionLdapException |
Returns the children for the current node.
Can be used offline but returns an empty array if children have not been retrieved yet.
Return type: | NodeChildrenIterator |
---|---|
Throws : | ExceptionLdapException |
Returns the parent of the current node.
Parameters: | Ldap – |
---|---|
Return type: | Node |
Throws : | ExceptionLdapException |
Return the current attribute. Implements Iterator
Return type: | array |
---|
Return the attribute name. Implements Iterator
Return type: | string |
---|
Move forward to next attribute. Implements Iterator
Rewind the Iterator to the first attribute. Implements Iterator
Check if there is a current attribute after calls to rewind() or next(). Implements Iterator
Return type: | bool |
---|