Ldap/Node/Abstract.php
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Ldap
- Subpackage
- Node
- Version
- $Id$
\Zend_Ldap_Node_Abstract
- Implements
- Children
- \Zend_Ldap_Node
- \Zend_Ldap_Node_RootDse
- \Zend_Ldap_Node_Schema
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods


__get(string $name) : array
Gets a LDAP attribute.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
array |
Exception | Description |
---|---|
\Zend_Ldap_Exception |


__isset(string $name) : boolean
Checks whether a given attribute exists.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |


__set(string $name, mixed $value) : null
Sets a LDAP attribute.
Name | Type | Description |
---|---|---|
$name | string | |
$value | mixed |
Type | Description |
---|---|
null |
Exception | Description |
---|---|
\BadMethodCallException |


__unset(string $name) : null
Deletes a LDAP attribute.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
null |
Exception | Description |
---|---|
\BadMethodCallException |


attributeHasValue(string $attribName, mixed | array $value) : boolean
Checks if the given value(s) exist in the attribute
Name | Type | Description |
---|---|---|
$attribName | string | |
$value | mixed | array |
Type | Description |
---|---|
boolean |


existsAttribute(string $name, boolean $emptyExists = false) : boolean
Checks whether a given attribute exists.
Name | Type | Description |
---|---|---|
$name | string | |
$emptyExists | boolean |
Type | Description |
---|---|
boolean |


getAttribute(string $name, integer $index = null) : mixed
Gets a LDAP attribute.
Name | Type | Description |
---|---|---|
$name | string | |
$index | integer |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\Zend_Ldap_Exception |


getAttributes(boolean $includeSystemAttributes = true) : array
Gets all attributes of node.
Name | Type | Description |
---|---|---|
$includeSystemAttributes | boolean |
Type | Description |
---|---|
array |


getData(boolean $includeSystemAttributes = true) : array
Gets node attributes.
Name | Type | Description |
---|---|---|
$includeSystemAttributes | boolean |
Type | Description |
---|---|
array |


getDateTimeAttribute(string $name, integer $index = null) : array | integer
Gets a LDAP date/time attribute.
Name | Type | Description |
---|---|---|
$name | string | |
$index | integer |
Type | Description |
---|---|
array | integer |
Exception | Description |
---|---|
\Zend_Ldap_Exception |


getDn() : \Zend_Ldap_Dn
Gets the DN of the current node as a Zend_Ldap_Dn.
Type | Description |
---|---|
\Zend_Ldap_Dn |


getDnArray(string $caseFold = null) : array
Gets the DN of the current node as an array.
Name | Type | Description |
---|---|---|
$caseFold | string |
Type | Description |
---|---|
array |


getDnString(string $caseFold = null) : string
Gets the DN of the current node as a string.
Name | Type | Description |
---|---|---|
$caseFold | string |
Type | Description |
---|---|
string |


getRdnArray(string $caseFold = null) : array
Gets the RDN of the current node as an array.
Name | Type | Description |
---|---|---|
$caseFold | string |
Type | Description |
---|---|
array |


getRdnString(string $caseFold = null) : string
Gets the RDN of the current node as a string.
Name | Type | Description |
---|---|---|
$caseFold | string |
Type | Description |
---|---|
string |


offsetExists(string $name) : boolean
Checks whether a given attribute exists.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |


offsetGet(string $name) : array
Gets a LDAP attribute.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
array |
Exception | Description |
---|---|
\Zend_Ldap_Exception |


offsetSet(string $name, mixed $value) : null
Sets a LDAP attribute.
Name | Type | Description |
---|---|---|
$name | string | |
$value | mixed |
Type | Description |
---|---|
null |
Exception | Description |
---|---|
\BadMethodCallException |


offsetUnset(string $name) : null
Deletes a LDAP attribute.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
null |
Exception | Description |
---|---|
\BadMethodCallException |


reload(\Zend_Ldap $ldap = null) : \Zend_Ldap_Node_Abstract
Reload node attributes from LDAP.
Name | Type | Description |
---|---|---|
$ldap | \Zend_Ldap |
Type | Description |
---|---|
\Zend_Ldap_Node_Abstract | Provides a fluid interface |
Exception | Description |
---|---|
\Zend_Ldap_Exception |


toArray(boolean $includeSystemAttributes = true) : array
Returns an array representation of the current node
Name | Type | Description |
---|---|---|
$includeSystemAttributes | boolean |
Type | Description |
---|---|
array |


toJson(boolean $includeSystemAttributes = true) : string
Returns a JSON representation of the current node
Name | Type | Description |
---|---|---|
$includeSystemAttributes | boolean |
Type | Description |
---|---|
string |