Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Zend_Ldap_Node_RootDse provides a simple data-container for the RootDSE node of an OpenLDAP server.

__construct(
\Zend_Ldap_Dn $dn, array $data
)
:
void
Constructor.
Inherited from: \Zend_Ldap_Node_RootDse::__construct()Constructor is protected to enforce the use of factory methods.
Name | Type | Description |
---|---|---|
$dn | \Zend_Ldap_Dn | |
$data | array |

__get(
string $name
)
:
array
Gets a LDAP attribute.
Inherited from: \Zend_Ldap_Node_Abstract::__get()This is an offline method.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
array |
Exception | Description |
---|---|
\Zend_Ldap_Exception |

__isset(
string $name
)
:
boolean
Checks whether a given attribute exists.
Inherited from: \Zend_Ldap_Node_Abstract::__isset()Empty attributes will be treated as non-existent.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |

__set(
string $name, mixed $value
)
:
null
Sets a LDAP attribute.
Inherited from: \Zend_Ldap_Node_Abstract::__set()This is an offline method.
Name | Type | Description |
---|---|---|
$name | string | |
$value | mixed |
Type | Description |
---|---|
null |
Exception | Description |
---|---|
\BadMethodCallException |

__toString(
)
:
string
Cast to string representation {@see toString()}
Inherited from: \Zend_Ldap_Node_Abstract::__toString()Type | Description |
---|---|
string |

__unset(
string $name
)
:
null
Deletes a LDAP attribute.
Inherited from: \Zend_Ldap_Node_Abstract::__unset()This method deletes the attribute.
This is an offline method.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
null |
Exception | Description |
---|---|
\BadMethodCallException |

_getDn(
)
:
\Zend_Ldap_Dn
Gets the DN of the current node as a Zend_Ldap_Dn.
Inherited from: \Zend_Ldap_Node_Abstract::_getDn()This is an offline method.
Type | Description |
---|---|
\Zend_Ldap_Dn |

_loadData(
array $data, boolean $fromDataSource
)
:
void
Name | Type | Description |
---|---|---|
$data | array | |
$fromDataSource | boolean |
Exception | Description |
---|---|
\Zend_Ldap_Exception |

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

count(
)
:
int
Returns the number of attributes in node.
Inherited from: \Zend_Ldap_Node_Abstract::count()Implements Countable
Type | Description |
---|---|
int |

create(
\Zend_Ldap $ldap
)
:
\Zend_Ldap_Node_RootDse
Name | Type | Description |
---|---|---|
$ldap | \Zend_Ldap |
Type | Description |
---|---|
\Zend_Ldap_Node_RootDse |
Exception | Description |
---|---|
\Zend_Ldap_Exception |

existsAttribute(
string $name, boolean $emptyExists
=
false
)
:
boolean
Checks whether a given attribute exists.
Inherited from: \Zend_Ldap_Node_Abstract::existsAttribute()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.
Name | Type | Description |
---|---|---|
$name | string | |
$emptyExists | boolean |
Type | Description |
---|---|
boolean |

getAttribute(
string $name, integer $index
=
null
)
:
mixed
Gets a LDAP attribute.
Inherited from: \Zend_Ldap_Node_Abstract::getAttribute()This is an offline method.
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.
Inherited from: \Zend_Ldap_Node_Abstract::getAttributes()The collection contains all attributes.
This is an offline method.
Name | Type | Description |
---|---|---|
$includeSystemAttributes | boolean |
Type | Description |
---|---|
array |

getData(
boolean $includeSystemAttributes
=
true
)
:
array
Gets node attributes.
Inherited from: \Zend_Ldap_Node_Abstract::getData()The array contains all attributes in its internal format (no conversion).
This is an offline method.
Name | Type | Description |
---|---|---|
$includeSystemAttributes | boolean |
Type | Description |
---|---|
array |

getDateTimeAttribute(
string $name, integer $index
=
null
)
:
array|integer
Gets a LDAP date/time attribute.
Inherited from: \Zend_Ldap_Node_Abstract::getDateTimeAttribute()This is an offline method.
Name | Type | Description |
---|---|---|
$name | string | |
$index | integer |
Type | Description |
---|---|
arrayinteger |
Exception | Description |
---|---|
\Zend_Ldap_Exception |

getDn(
)
:
\Zend_Ldap_Dn
Gets the DN of the current node as a Zend_Ldap_Dn.
Inherited from: \Zend_Ldap_Node_Abstract::getDn()The method returns a clone of the node's DN to prohibit modification.
This is an offline method.
Type | Description |
---|---|
\Zend_Ldap_Dn |

getDnArray(
string $caseFold
=
null
)
:
array
Gets the DN of the current node as an array.
Inherited from: \Zend_Ldap_Node_Abstract::getDnArray()This is an offline method.
Name | Type | Description |
---|---|---|
$caseFold | string |
Type | Description |
---|---|
array |

getDnString(
string $caseFold
=
null
)
:
string
Gets the DN of the current node as a string.
Inherited from: \Zend_Ldap_Node_Abstract::getDnString()This is an offline method.
Name | Type | Description |
---|---|---|
$caseFold | string |
Type | Description |
---|---|
string |

getNamingContexts(
)
:
array
Gets the namingContexts.
Inherited from: \Zend_Ldap_Node_RootDse::getNamingContexts()Type | Description |
---|---|
array |

getObjectClass(
)
:
array
Gets the objectClass of the node
Inherited from: \Zend_Ldap_Node_Abstract::getObjectClass()Type | Description |
---|---|
array |

getRdnArray(
string $caseFold
=
null
)
:
array
Gets the RDN of the current node as an array.
Inherited from: \Zend_Ldap_Node_Abstract::getRdnArray()This is an offline method.
Name | Type | Description |
---|---|---|
$caseFold | string |
Type | Description |
---|---|
array |

getRdnString(
string $caseFold
=
null
)
:
string
Gets the RDN of the current node as a string.
Inherited from: \Zend_Ldap_Node_Abstract::getRdnString()This is an offline method.
Name | Type | Description |
---|---|---|
$caseFold | string |
Type | Description |
---|---|
string |

getSchemaDn(
)
:
\Zend_Ldap_Dn
Returns the schema DN
Inherited from: \Zend_Ldap_Node_RootDse::getSchemaDn()Type | Description |
---|---|
\Zend_Ldap_Dn |

getSubschemaSubentry(
)
:
string|null
Gets the subschemaSubentry.
Inherited from: \Zend_Ldap_Node_RootDse::getSubschemaSubentry()Type | Description |
---|---|
stringnull |

offsetExists(
string $name
)
:
boolean
Checks whether a given attribute exists.
Inherited from: \Zend_Ldap_Node_Abstract::offsetExists()Implements ArrayAccess.
Empty attributes will be treated as non-existent.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |

offsetGet(
string $name
)
:
array
Gets a LDAP attribute.
Inherited from: \Zend_Ldap_Node_Abstract::offsetGet()Implements ArrayAccess.
This is an offline method.
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
array |
Exception | Description |
---|---|
\Zend_Ldap_Exception |

offsetSet(
string $name, mixed $value
)
:
null
Sets a LDAP attribute.
Inherited from: \Zend_Ldap_Node_Abstract::offsetSet()Implements ArrayAccess.
This is an offline method.
Name | Type | Description |
---|---|---|
$name | string | |
$value | mixed |
Type | Description |
---|---|
null |
Exception | Description |
---|---|
\BadMethodCallException |

offsetUnset(
string $name
)
:
null
Deletes a LDAP attribute.
Inherited from: \Zend_Ldap_Node_Abstract::offsetUnset()Implements ArrayAccess.
This method deletes the attribute.
This is an offline method.
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.
Inherited from: \Zend_Ldap_Node_Abstract::reload()This is an online method.
Name | Type | Description |
---|---|---|
$ldap | \Zend_Ldap |
Type | Description |
---|---|
\Zend_Ldap_Node_Abstract | Provides a fluid interface |
Exception | Description |
---|---|
\Zend_Ldap_Exception |

supportsControl(
string|array $oids
)
:
boolean
Determines if the control is supported
Name | Type | Description |
---|---|---|
$oids | string|array | control oid(s) to check |
Type | Description |
---|---|
boolean |

supportsExtension(
string|array $oids
)
:
boolean
Determines if the extension is supported
Name | Type | Description |
---|---|---|
$oids | string|array | oid(s) to check |
Type | Description |
---|---|
boolean |

supportsFeature(
string|array $oids
)
:
boolean
Determines if the feature is supported
Name | Type | Description |
---|---|---|
$oids | string|array | feature oid(s) to check |
Type | Description |
---|---|
boolean |

supportsSaslMechanism(
string|array $mechlist
)
:
boolean
Determines if the sasl mechanism is supported
Inherited from: \Zend_Ldap_Node_RootDse::supportsSaslMechanism()Name | Type | Description |
---|---|---|
$mechlist | string|array | SASL mechanisms to check |
Type | Description |
---|---|
boolean |

supportsVersion(
string|int|array $versions
)
:
boolean
Determines if the version is supported
Inherited from: \Zend_Ldap_Node_RootDse::supportsVersion()Name | Type | Description |
---|---|---|
$versions | string|int|array | version(s) to check |
Type | Description |
---|---|
boolean |

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

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

toString(
)
:
string
Returns the DN of the current node. {@see getDnString()}
Inherited from: \Zend_Ldap_Node_Abstract::toString()Type | Description |
---|---|
string |