Zend_Ldap_Node provides an object oriented view into a LDAP node.
category | Zend |
---|---|
package | Zend_Ldap |
subpackage | Node |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Ldap_Node_Abstract |
__get(string $name) : array
This is an offline method.
string
\Zend_Ldap_Exception |
---|
array
__isset(string $name) : boolean
Empty attributes will be treated as non-existent.
string
boolean
__set(string $name, mixed $value) : null
This is an offline method.
inherited_from | \Zend_Ldap_Node_Abstract::__set() |
---|
string
mixed
\Zend_Ldap_Exception |
---|
null
__set(string $name, mixed $value) : null
This is an offline method.
string
mixed
\BadMethodCallException |
---|
null
__sleep() : array
Only DN and attributes will be serialized.
array
__toString() : string
string
__unset(string $name) : null
This method deletes the attribute.
This is an offline method.
inherited_from | \Zend_Ldap_Node_Abstract::__unset() |
---|
string
\Zend_Ldap_Exception |
---|
null
__unset(string $name) : null
This method deletes the attribute.
This is an offline method.
string
\BadMethodCallException |
---|
null
__wakeup() : null
Enforces a detached node.
null
appendObjectClass(array|string $value) : \Zend_Ldap_Node
This is an offline method.
array
string
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfaceappendToAttribute(string $name, mixed $value) : \Zend_Ldap_Node
This is an offline method.
string
mixed
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfaceappendToDateTimeAttribute(string $name, integer|array $value, boolean $utc = false
) : \Zend_Ldap_Node
This is an offline method.
string
integer
array
boolean
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfaceattachLdap(\Zend_Ldap $ldap) : \Zend_Ldap_Node
attributeHasValue(string $attribName, mixed|array $value) : boolean
string
mixed
array
boolean
count() : integer
Implements Countable
integer
countChildren() : integer
This is an online method.
\Zend_Ldap_Exception |
---|
integer
countSubtree(string|\Zend_Ldap_Filter_Abstract $filter, integer $scope = \Zend_Ldap::SEARCH_SCOPE_SUB
) : integer
This is an online method.
string
\Zend_Ldap_Filter_Abstract
integer
\Zend_Ldap_Exception |
---|
integer
create(string|array|\Zend_Ldap_Dn $dn, array $objectClass = array()
) : \Zend_Ldap_Node
string
array
\Zend_Ldap_Dn
array
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
current() : array
Implements Iterator
array
delete() : \Zend_Ldap_Node
Node will be deleted on calling update() if $delete is true.
\Zend_Ldap_Node
Provides a fluent interfacedeleteAttribute(string $name) : \Zend_Ldap_Node
This method deletes the attribute.
This is an offline method.
string
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfacedetachLdap() : \Zend_Ldap_Node
This is an offline method.
\Zend_Ldap_Node
Provides a fluent interfaceexists(\Zend_Ldap $ldap = null
) : boolean
This is an online method.
\Zend_Ldap
\Zend_Ldap_Exception |
---|
boolean
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.
string
boolean
boolean
fromArray(array $data, boolean $fromDataSource = false
) : \Zend_Ldap_Node
array
boolean
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
fromLdap(string|array|\Zend_Ldap_Dn $dn, \Zend_Ldap $ldap) : \Zend_Ldap_Node | null
string
array
\Zend_Ldap_Dn
\Zend_Ldap
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
null
getAttribute(string $name, integer $index = null
) : mixed
This is an offline method.
string
integer
\Zend_Ldap_Exception |
---|
mixed
getAttributes(boolean $includeSystemAttributes = true
) : array
The collection contains all attributes.
This is an offline method.
boolean
array
getChangedData() : array
The array contains all changed attributes. This format can be used in Zend_Ldap::add() and Zend_Ldap::update().
This is an offline method.
array
getChanges() : array
This is an offline method.
array
getChildren() : \Zend_Ldap_Node_ChildrenIterator
Can be used offline but returns an empty array if children have not been retrieved yet.
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node_ChildrenIterator
getCurrentDn() : \Zend_Ldap_Dn
The method returns a clone of the node's DN to prohibit modification.
This is an offline method.
\Zend_Ldap_Dn
getData(boolean $includeSystemAttributes = true
) : array
The array contains all attributes in its internal format (no conversion).
This is an offline method.
boolean
array
getDateTimeAttribute(string $name, integer $index = null
) : array | integer
This is an offline method.
string
integer
\Zend_Ldap_Exception |
---|
array
integer
getDn() : \Zend_Ldap_Dn
The method returns a clone of the node's DN to prohibit modification.
This is an offline method.
\Zend_Ldap_Dn
getDnArray(string $caseFold = null
) : array
This is an offline method.
string
array
getDnString(string $caseFold = null
) : string
This is an offline method.
string
string
getLdap() : \Zend_Ldap
\Zend_Ldap_Exception |
---|
\Zend_Ldap
getObjectClass() : array
array
getParent(\Zend_Ldap $ldap = null
) : \Zend_Ldap_Node
\Zend_Ldap
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
getRdnArray(string $caseFold = null
) : array
This is an offline method.
string
array
getRdnString(string $caseFold = null
) : string
This is an offline method.
string
string
hasChildren() : boolean
Returns whether the current element has children.
Can be used offline but returns false if children have not been retrieved yet.
\Zend_Ldap_Exception |
---|
boolean
isAttached() : boolean
This is an offline method.
boolean
isNew() : boolean
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.
boolean
key() : string
Implements Iterator
string
move(\Zend_Ldap_Dn|string|array $newDn) : \Zend_Ldap_Node
This is an offline method.
\Zend_Ldap_Dn
string
array
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfacenext()
Implements Iterator
offsetExists(string $name) : boolean
Implements ArrayAccess.
Empty attributes will be treated as non-existent.
string
boolean
offsetGet(string $name) : array
Implements ArrayAccess.
This is an offline method.
string
\Zend_Ldap_Exception |
---|
array
offsetSet(string $name, mixed $value) : null
Implements ArrayAccess.
This is an offline method.
inherited_from | \Zend_Ldap_Node_Abstract::offsetSet() |
---|
string
mixed
\Zend_Ldap_Exception |
---|
null
offsetSet(string $name, mixed $value) : null
Implements ArrayAccess.
This is an offline method.
string
mixed
\BadMethodCallException |
---|
null
offsetUnset(string $name) : null
Implements ArrayAccess.
This method deletes the attribute.
This is an offline method.
inherited_from | \Zend_Ldap_Node_Abstract::offsetUnset() |
---|
string
\Zend_Ldap_Exception |
---|
null
offsetUnset(string $name) : null
Implements ArrayAccess.
This method deletes the attribute.
This is an offline method.
string
\BadMethodCallException |
---|
null
reload(\Zend_Ldap $ldap = null
) : \Zend_Ldap_Node
This is an online method.
inherited_from | \Zend_Ldap_Node_Abstract::reload() |
---|
\Zend_Ldap
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfacereload(\Zend_Ldap $ldap = null
) : \Zend_Ldap_Node_Abstract
This is an online method.
\Zend_Ldap
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node_Abstract
Provides a fluent interfaceremoveDuplicatesFromAttribute(string $attribName) : void
string
removeFromAttribute(string $attribName, mixed|array $value) : void
string
mixed
array
rename(\Zend_Ldap_Dn|string|array $newDn) : \Zend_Ldap_Node
This is an offline method.
\Zend_Ldap_Dn
string
array
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfacerewind()
Implements Iterator
searchChildren(string|\Zend_Ldap_Filter_Abstract $filter, string $sort = null
) : \Zend_Ldap_Node_Collection
This is an online method.
string
\Zend_Ldap_Filter_Abstract
string
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node_Collection
searchSubtree(string|\Zend_Ldap_Filter_Abstract $filter, integer $scope= \Zend_Ldap::SEARCH_SCOPE_SUB
, string $sort= null
) : \Zend_Ldap_Node_Collection
This is an online method.
string
\Zend_Ldap_Filter_Abstract
integer
string
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node_Collection
setAttribute(string $name, mixed $value) : \Zend_Ldap_Node
This is an offline method.
string
mixed
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfacesetDateTimeAttribute(string $name, integer|array $value, boolean $utc = false
) : \Zend_Ldap_Node
This is an offline method.
string
integer
array
boolean
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfacesetDn(\Zend_Ldap_Dn|string|array $newDn) : \Zend_Ldap_Node
This is an offline method.
\Zend_Ldap_Dn
string
array
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfacesetObjectClass(array|string $value) : \Zend_Ldap_Node
This is an offline method.
array
string
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfacesetPasswordAttribute(string $password, string $hashType= \Zend_Ldap_Attribute::PASSWORD_HASH_MD5
, string $attribName= 'userPassword'
) : \Zend_Ldap_Node
string
string
string
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfacetoArray(boolean $includeSystemAttributes = true
) : array
boolean
array
toJson(boolean $includeSystemAttributes = true
) : string
boolean
string
toLdif(array $options = array()
) : string
array
Additional options used during encoding
string
toString() : string
string
update(\Zend_Ldap $ldap = null
) : \Zend_Ldap_Node
\Zend_Ldap
\Zend_Ldap_Exception |
---|
\Zend_Ldap_Node
Provides a fluent interfacevalid() : boolean
Implements Iterator
boolean
willBeDeleted() : boolean
boolean
willBeMoved() : boolean
boolean
__construct(\Zend_Ldap_Dn $dn, array $data, boolean $fromDataSource, \Zend_Ldap $ldap = null
)
Constructor is protected to enforce the use of factory methods.
inherited_from | \Zend_Ldap_Node_Abstract::__construct() |
---|
\Zend_Ldap_Dn
array
boolean
\Zend_Ldap
\Zend_Ldap_Exception |
---|
__construct(\Zend_Ldap_Dn $dn, array $data, boolean $fromDataSource)
Constructor is protected to enforce the use of factory methods.
\Zend_Ldap_Dn
array
boolean
_assertChangeableAttribute(string $name) : boolean
string
\Zend_Ldap_Exception |
---|
boolean
_ensureRdnAttributeValues(boolean $overwrite = false
) : void
boolean
True to overwrite the RDN attributes
_getDn() : \Zend_Ldap_Dn
This is an offline method.
inherited_from | \Zend_Ldap_Node_Abstract::_getDn() |
---|
\Zend_Ldap_Dn
_getDn() : \Zend_Ldap_Dn
This is an offline method.
\Zend_Ldap_Dn
_loadData(array $data, boolean $fromDataSource)
inherited_from | \Zend_Ldap_Node_Abstract::_loadData() |
---|
array
boolean
\Zend_Ldap_Exception |
---|
_loadData(array $data, boolean $fromDataSource)
array
boolean
\Zend_Ldap_Exception |
---|
_markAsNew(boolean $new)
Node will be added (instead of updated) on calling update() if $new is true.
boolean
_markAsToBeDeleted(boolean $delete)
Node will be deleted on calling update() if $delete is true.
boolean
_postAdd() : void
Subclasses may override this method.
_postDelete() : void
Subclasses may override this method.
_postRename() : void
Subclasses may override this method.
_postUpdate() : void
Subclasses may override this method.
_preAdd() : void
Subclasses may override this method.
_preDelete() : void
Subclasses may override this method.
_preRename() : void
Subclasses may override this method.
_preUpdate() : void
Subclasses may override this method.
_setAttribute(string $name, mixed $value, boolean $append)
string
mixed
boolean
\Zend_Ldap_Exception |
---|
_setDateTimeAttribute(string $name, integer|array $value, boolean $utc, boolean $append)
string
integer
array
boolean
boolean
\Zend_Ldap_Exception |
---|
$_children : array
$_currentData : array
$_delete : boolean
$_dn : \Zend_Ldap_Dn
$_ldap : \Zend_Ldap
$_new : boolean
$_newDn : \Zend_Ldap_Dn
$_originalData : array
$_systemAttributes
array('createtimestamp', 'creatorsname', 'entrycsn', 'entrydn', 'entryuuid', 'hassubordinates', 'modifiersname', 'modifytimestamp', 'structuralobjectclass', 'subschemasubentry', 'distinguishedname', 'instancetype', 'name', 'objectcategory', 'objectguid', 'usnchanged', 'usncreated', 'whenchanged', 'whencreated')
$_iteratorRewind : boolean
false