Statistics
Legends
Deprecated
Todos
Classes
Methods
Class fields
Class constants
Inheritances
Files
Overview
FRAMES
NO FRAMES

Class Zend_Ldap_Node
Zend_Ldap
|-Zend_Ldap_Node
|- class Zend_Ldap_Node extends Zend_Ldap_Node_Abstract implements Iterator, RecursiveIterator
Defined in line 41 of file Ldap/Node.php.
Zend_Ldap_Node provides an object oriented view into a LDAP node.
CategoryZend
PackageZend_Ldap
SubpackageNode
CopyrightCopyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
Licensehttp://framework.zend.com/license/new-bsd New BSD License

Summary
Instance fields
# $_children Holds an array of the current node's children
# $_delete This node will be deleted
- $_iteratorRewind Controls iteration status
# $_ldap Holds the connection to the LDAP server if in connected mode
# $_new This node will be added
# $_newDn Holds the node's new DN if node is renamed
# $_originalData Holds the node's orginal attributes (as loaded)
Static methods
+ create() Factory method to create a new detached Zend_Ldap_Node for a given DN
+ fromArray() Factory method to create a detached Zend_Ldap_Node from array data
+ fromLdap() Factory method to create an attached Zend_Ldap_Node for a given DN
Instance methods
# __construct() Constructor.
+ __set() Sets a LDAP attribute.
+ __sleep() Serialization callback
+ __unset() Deletes a LDAP attribute.
+ __wakeup() Deserialization callback
# _assertChangeableAttribute()
# _ensureRdnAttributeValues() Ensures that teh RDN attributes are correctly set
# _getDn() Gets the DN of the current node as a Zend_Ldap_Dn.
# _loadData()
# _markAsNew() Marks this node as new.
# _markAsToBeDeleted() Marks this node as to be deleted.
# _setAttribute() Checks if the attribute can be set and sets it accordingly
# _setDateTimeAttribute() Checks if the attribute can be set and sets it accordingly
+ appendObjectClass() Appends to the objectClass.
+ appendToAttribute() Appends to a LDAP attribute.
+ appendToDateTimeAttribute() Appends to a LDAP date/time attribute.
+ attachLdap() Attach node to an LDAP connection
+ countChildren() Count children of current node.
+ countSubtree() Count items in current subtree found by given filter.
+ current() Return the current attribute.
+ delete() Marks this node as to be deleted
+ deleteAttribute() Deletes a LDAP attribute.
+ detachLdap() Detach node from LDAP connection
+ exists() Check if node exists on LDAP.
+ getChangedData() Gets changed node data.
+ getChanges() Returns all changes made.
+ getChildren() Returns the children for the current node.
+ getCurrentDn() Gets the current DN of the current node as a Zend_Ldap_Dn.
+ getLdap() Gets the current LDAP connection
+ getParent() Returns the parent of the current node
+ hasChildren() Checks if current node has children.
+ isAttached() Checks if the current node is attached to a LDAP server.
+ isNew() Tells if the node is consiedered as new (not present on the server)
+ key() Return the attribute name.
+ move() {@see setDn()}
+ next() Move forward to next attribute.
+ offsetSet() Sets a LDAP attribute.
+ offsetUnset() Deletes a LDAP attribute.
+ reload() Reload node attributes from LDAP.
+ removeDuplicatesFromAttribute() Removes duplicate values from a LDAP attribute
+ removeFromAttribute() Remove given values from a LDAP attribute
+ rename() {@see setDn()}
+ rewind() Rewind the Iterator to the first attribute.
+ searchChildren() Gets children of current node.
+ searchSubtree() Search current subtree with given options.
+ setAttribute() Sets a LDAP attribute.
+ setDateTimeAttribute() Sets a LDAP date/time attribute.
+ setDn() Sets the new DN for this node
+ setObjectClass() Sets the objectClass.
+ setPasswordAttribute() Sets a LDAP password
+ toLdif() Returns a LDIF representation of the current node
+ update() Sends all pending changes to the LDAP server
+ valid() Check if there is a current attribute
+ willBeDeleted() Is this node going to be deleted once update() is called?
+ willBeMoved() Is this node going to be moved once update() is called?

Details

Instance fields

$_children
protected $_children
Holds an array of the current node's children.
Var array
Defined in Ldap/Node.php, line 79
$_delete
protected $_delete
This node will be deleted
Var boolean
Defined in Ldap/Node.php, line 66
$_iteratorRewind
private $_iteratorRewind = false
Controls iteration status
Var boolean
Defined in Ldap/Node.php, line 86
$_ldap
protected $_ldap
Holds the connection to the LDAP server if in connected mode.
Defined in Ldap/Node.php, line 72
$_new
protected $_new
This node will be added
Var boolean
Defined in Ldap/Node.php, line 60
$_newDn
protected $_newDn
Holds the node's new DN if node is renamed.
Defined in Ldap/Node.php, line 48
$_originalData
protected $_originalData
Holds the node's orginal attributes (as loaded).
Var array
Defined in Ldap/Node.php, line 54

Static methods

create()
public static function create( $dn
array $objectClass = array())
Factory method to create a new detached Zend_Ldap_Node for a given DN.
Parameters
string|array|Zend_Ldap_Dn $dn
array $objectClass
Defined in Ldap/Node.php, line 237
fromArray()
public static function fromArray( array $data
$fromDataSource = false)
Factory method to create a detached Zend_Ldap_Node from array data.
Parameters
array $data
boolean $fromDataSource
Defined in Ldap/Node.php, line 290
fromLdap()
public static function fromLdap( $dn
Zend_Ldap $ldap)
Factory method to create an attached Zend_Ldap_Node for a given DN.
Parameters
string|array|Zend_Ldap_Dn $dn
Zend_Ldap $ldap
Defined in Ldap/Node.php, line 264

Instance methods

__construct()
protected function __construct( Zend_Ldap_Dn $dn
array $data
$fromDataSource
Zend_Ldap $ldap = null)
Constructor.

Constructor is protected to enforce the use of factory methods.
Parameters
Zend_Ldap_Dn $dn
array $data
boolean $fromDataSource
Zend_Ldap $ldap
Overrides Zend_Ldap_Node_Abstract->__construct()
Defined in Ldap/Node.php, line 99
__set()
public function __set( $name
$value)
Sets a LDAP attribute.

This is an offline method.
Parameters
string $name
mixed $value
Returns null
Overrides Zend_Ldap_Node_Abstract->__set()
Defined in Ldap/Node.php, line 827
__sleep()
public function __sleep( )
Serialization callback

Only DN and attributes will be serialized.
Returns array
Defined in Ldap/Node.php, line 113
__unset()
public function __unset( $name)
Deletes a LDAP attribute.

This method deletes the attribute.

This is an offline method.
Parameters
string $name
Returns null
Overrides Zend_Ldap_Node_Abstract->__unset()
Defined in Ldap/Node.php, line 843
__wakeup()
public function __wakeup( )
Deserialization callback

Enforces a detached node.
Returns null
Defined in Ldap/Node.php, line 126
_assertChangeableAttribute()
protected function _assertChangeableAttribute( $name)
Parameters
string $name
Returns boolean
Defined in Ldap/Node.php, line 790
_ensureRdnAttributeValues()
protected function _ensureRdnAttributeValues( )
Ensures that teh RDN attributes are correctly set.
Returns void
Defined in Ldap/Node.php, line 321
_getDn()
protected function _getDn( )
Gets the DN of the current node as a Zend_Ldap_Dn.

This is an offline method.
Returns Zend_Ldap_Dn
Overrides Zend_Ldap_Node_Abstract->_getDn()
Defined in Ldap/Node.php, line 466
_loadData()
protected function _loadData( array $data
$fromDataSource)
Parameters
array $data
boolean $fromDataSource
Overrides Zend_Ldap_Node_Abstract->_loadData()
Defined in Ldap/Node.php, line 216
_markAsNew()
protected function _markAsNew( $new)
Marks this node as new.

Node will be added (instead of updated) on calling update() if $new is true.
Parameters
boolean $new
Defined in Ldap/Node.php, line 335
_markAsToBeDeleted()
protected function _markAsToBeDeleted( $delete)
Marks this node as to be deleted.

Node will be deleted on calling update() if $delete is true.
Parameters
boolean $delete
Defined in Ldap/Node.php, line 360
_setAttribute()
protected function _setAttribute( $name
$value
$append)
Checks if the attribute can be set and sets it accordingly.
Parameters
string $name
mixed $value
boolean $append
Defined in Ldap/Node.php, line 671
_setDateTimeAttribute()
protected function _setDateTimeAttribute( $name
$value
$utc
$append)
Checks if the attribute can be set and sets it accordingly.
Parameters
string $name
integer|array $value
boolean $utc
boolean $append
Defined in Ldap/Node.php, line 720
appendObjectClass()
public function appendObjectClass( $value)
Appends to the objectClass.

This is an offline method.
Parameters
array|string $value
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 557
appendToAttribute()
public function appendToAttribute( $name
$value)
Appends to a LDAP attribute.

This is an offline method.
Parameters
string $name
mixed $value
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 657
appendToDateTimeAttribute()
public function appendToDateTimeAttribute( $name
$value
$utc = false)
Appends to a LDAP date/time attribute.

This is an offline method.
Parameters
string $name
integer|array $value
boolean $utc
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 705
attachLdap()
public function attachLdap( Zend_Ldap $ldap)
Attach node to an LDAP connection

This is an offline method.
Parameters
Zend_Ldap $ldap
Returns Zend_Ldap_Node *Provides a fluid interface*
Uses Zend_Ldap_Dn::isChildOf()
Defined in Ldap/Node.php, line 159
countChildren()
public function countChildren( )
Count children of current node.

This is an online method.
Returns integer
Defined in Ldap/Node.php, line 962
countSubtree()
public function countSubtree( $filter
$scope = Zend_Ldap::SEARCH_SCOPE_SUB)
Count items in current subtree found by given filter.

This is an online method.
Parameters
string|Zend_Ldap_Filter_Abstract $filter
integer $scope
Returns integer
Defined in Ldap/Node.php, line 949
current()
public function current( )
Return the current attribute.
Implements Iterator
Returns array
Defined in Ldap/Node.php, line 1053
delete()
public function delete( )
Marks this node as to be deleted

Node will be deleted on calling update() if $delete is true.
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 383
deleteAttribute()
public function deleteAttribute( $name)
Deletes a LDAP attribute.

This method deletes the attribute.

This is an offline method.
Parameters
string $name
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 754
detachLdap()
public function detachLdap( )
Detach node from LDAP connection

This is an offline method.
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 188
exists()
public function exists( Zend_Ldap $ldap = null)
Check if node exists on LDAP.

This is an online method.
Parameters
Zend_Ldap $ldap
Returns boolean
Defined in Ldap/Node.php, line 890
getChangedData()
public function getChangedData( )
Gets changed node data.

The array contains all changed attributes.
This format can be used in Zend_Ldap::add() and Zend_Ldap::update().

This is an offline method.
Returns array
Defined in Ldap/Node.php, line 589
getChanges()
public function getChanges( )
Returns all changes made.

This is an offline method.
Returns array
Defined in Ldap/Node.php, line 609
getChildren()
public function getChildren( )
Returns the children for the current node.

Can be used offline but returns an empty array if children have not been retrieved yet.
Defined in Ldap/Node.php, line 1012
getCurrentDn()
public function getCurrentDn( )
Gets the current DN of the current node as a 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
Defined in Ldap/Node.php, line 479
getLdap()
public function getLdap( )
Gets the current LDAP connection.
Returns Zend_Ldap
Defined in Ldap/Node.php, line 137
getParent()
public function getParent( Zend_Ldap $ldap = null)
Returns the parent of the current node.
Parameters
Zend_Ldap $ldap
Defined in Ldap/Node.php, line 1037
hasChildren()
public function hasChildren( )
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.
Returns boolean
Defined in Ldap/Node.php, line 991
isAttached()
public function isAttached( )
Checks if the current node is attached to a LDAP server.

This is an offline method.
Returns boolean
Defined in Ldap/Node.php, line 206
isNew()
public function isNew( )
Tells if the node is consiedered as new (not present on the server)

Please note, that this doesn't tell you if the node is present on the server.
Use exits() to see if a node is already there.
Returns boolean
Defined in Ldap/Node.php, line 348
key()
public function key( )
Return the attribute name.
Implements Iterator
Returns string
Defined in Ldap/Node.php, line 1064
move()
public function move( $newDn)
{@see setDn()}

This is an offline method.
Parameters
Zend_Ldap_Dn|string|array $newDn
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 514
next()
public function next( )
Move forward to next attribute.
Implements Iterator
Defined in Ldap/Node.php, line 1073
offsetSet()
public function offsetSet( $name
$value)
Sets a LDAP attribute.
Implements ArrayAccess.

This is an offline method.
Parameters
string $name
mixed $value
Returns null
Overrides Zend_Ldap_Node_Abstract->offsetSet()
Defined in Ldap/Node.php, line 859
offsetUnset()
public function offsetUnset( $name)
Deletes a LDAP attribute.
Implements ArrayAccess.

This method deletes the attribute.

This is an offline method.
Parameters
string $name
Returns null
Overrides Zend_Ldap_Node_Abstract->offsetUnset()
Defined in Ldap/Node.php, line 876
reload()
public function reload( Zend_Ldap $ldap = null)
Reload node attributes from LDAP.

This is an online method.
Parameters
Zend_Ldap $ldap
Returns Zend_Ldap_Node *Provides a fluid interface*
Overrides Zend_Ldap_Node_Abstract->reload()
Defined in Ldap/Node.php, line 908
removeDuplicatesFromAttribute()
public function removeDuplicatesFromAttribute( $attribName)
Removes duplicate values from a LDAP attribute
Parameters
string $attribName
Returns void
Defined in Ldap/Node.php, line 768
removeFromAttribute()
public function removeFromAttribute( $attribName
$value)
Remove given values from a LDAP attribute
Parameters
string $attribName
mixed|array $value
Returns void
Defined in Ldap/Node.php, line 780
rename()
public function rename( $newDn)
{@see setDn()}

This is an offline method.
Parameters
Zend_Ldap_Dn|string|array $newDn
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 528
rewind()
public function rewind( )
Rewind the Iterator to the first attribute.
Implements Iterator
Defined in Ldap/Node.php, line 1082
searchChildren()
public function searchChildren( $filter
$sort = null)
Gets children of current node.

This is an online method.
Parameters
string|Zend_Ldap_Filter_Abstract $filter
string $sort
Defined in Ldap/Node.php, line 977
searchSubtree()
public function searchSubtree( $filter
$scope = Zend_Ldap::SEARCH_SCOPE_SUB
$sort = null)
Search current subtree with given options.

This is an online method.
Parameters
string|Zend_Ldap_Filter_Abstract $filter
integer $scope
string $sort
Defined in Ldap/Node.php, line 929
setAttribute()
public function setAttribute( $name
$value)
Sets a LDAP attribute.

This is an offline method.
Parameters
string $name
mixed $value
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 641
setDateTimeAttribute()
public function setDateTimeAttribute( $name
$value
$utc = false)
Sets a LDAP date/time attribute.

This is an offline method.
Parameters
string $name
integer|array $value
boolean $utc
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 688
setDn()
public function setDn( $newDn)
Sets the new DN for this node

This is an offline method.
Parameters
Zend_Ldap_Dn|string|array $newDn
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 494
setObjectClass()
public function setObjectClass( $value)
Sets the objectClass.

This is an offline method.
Parameters
array|string $value
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 542
setPasswordAttribute()
public function setPasswordAttribute( $password
$hashType = Zend_Ldap_Attribute::PASSWORD_HASH_MD5
$attribName = 'userPassword')
Sets a LDAP password.
Parameters
string $password
string $hashType
string $attribName
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 735
toLdif()
public function toLdif( array $options = array())
Returns a LDIF representation of the current node
Parameters
array $options
Returns string
Defined in Ldap/Node.php, line 569
update()
public function update( Zend_Ldap $ldap = null)
Sends all pending changes to the LDAP server
Parameters
Zend_Ldap $ldap
Returns Zend_Ldap_Node *Provides a fluid interface*
Defined in Ldap/Node.php, line 412
valid()
public function valid( )
Check if there is a current attribute
after calls to rewind() or next().
Implements Iterator
Returns boolean
Defined in Ldap/Node.php, line 1094
willBeDeleted()
public function willBeDeleted( )
Is this node going to be deleted once update() is called?
Returns boolean
Defined in Ldap/Node.php, line 371
willBeMoved()
public function willBeMoved( )
Is this node going to be moved once update() is called?
Returns boolean
Defined in Ldap/Node.php, line 394