Zend\Ldap\Node\RootDse\OpenLdap provides a simple data-container for the RootDse node of an OpenLDAP server.

category Zend
package Zend_Ldap
subpackage RootDse

 Methods

Gets a LDAP attribute.

__get(string $name) : mixed
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::__get()
inherited_from \Zend\Ldap\Node\RootDse::__get()

Parameters

$name

string

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

mixed

Checks whether a given attribute exists.

__isset(string $name) : bool
Inherited

Empty attributes will be treated as non-existent.

inherited_from \Zend\Ldap\Node\AbstractNode::__isset()
inherited_from \Zend\Ldap\Node\RootDse::__isset()

Parameters

$name

string

Returns

bool

Sets a LDAP attribute.

__set(string $name, mixed $value) 
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::__set()
inherited_from \Zend\Ldap\Node\RootDse::__set()

Parameters

$name

string

$value

mixed

Exceptions

\Zend\Ldap\Exception\BadMethodCallException

Cast to string representation {@see toString()}

__toString() : string
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::__toString()
inherited_from \Zend\Ldap\Node\RootDse::__toString()

Returns

string

Deletes a LDAP attribute.

__unset($name) 
Inherited

This method deletes the attribute.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::__unset()
inherited_from \Zend\Ldap\Node\RootDse::__unset()

Parameters

$name

Exceptions

\Zend\Ldap\Exception\BadMethodCallException

Checks if the given value(s) exist in the attribute

attributeHasValue(string $attribName, mixed | array $value) : bool
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::attributeHasValue()
inherited_from \Zend\Ldap\Node\RootDse::attributeHasValue()

Parameters

$attribName

string

$value

mixedarray

Returns

bool

Returns the number of attributes in node.

count() : int
Inherited

Implements Countable

inherited_from \Zend\Ldap\Node\AbstractNode::count()
inherited_from \Zend\Ldap\Node\RootDse::count()

Returns

int

Factory method to create the RootDse.

create(\Zend\Ldap\Ldap $ldap) : \Zend\Ldap\Node\RootDse
Inherited

inherited_from \Zend\Ldap\Node\RootDse::create()

Parameters

Returns

Checks whether a given attribute exists.

existsAttribute(string $name, bool $emptyExists) : bool
Inherited

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.

inherited_from \Zend\Ldap\Node\AbstractNode::existsAttribute()
inherited_from \Zend\Ldap\Node\RootDse::existsAttribute()

Parameters

$name

string

$emptyExists

bool

Returns

bool

Gets a LDAP attribute.

getAttribute(string $name, integer $index) : mixed
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getAttribute()
inherited_from \Zend\Ldap\Node\RootDse::getAttribute()

Parameters

$name

string

$index

integer

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

mixed

Gets all attributes of node.

getAttributes(bool $includeSystemAttributes) : array
Inherited

The collection contains all attributes.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getAttributes()
inherited_from \Zend\Ldap\Node\RootDse::getAttributes()

Parameters

$includeSystemAttributes

bool

Returns

array

Gets the configContext.

getConfigContext() : string | null

Returns

stringnull

Gets node attributes.

getData(bool $includeSystemAttributes) : array
Inherited

The array contains all attributes in its internal format (no conversion).

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getData()
inherited_from \Zend\Ldap\Node\RootDse::getData()

Parameters

$includeSystemAttributes

bool

Returns

array

Gets a LDAP date/time attribute.

getDateTimeAttribute(string $name, integer $index) : array | integer
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getDateTimeAttribute()
inherited_from \Zend\Ldap\Node\RootDse::getDateTimeAttribute()

Parameters

$name

string

$index

integer

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

arrayinteger

Gets the DN of the current node as a Zend\Ldap\Dn.

getDn() : \Zend\Ldap\Dn
Inherited

The method returns a clone of the node's DN to prohibit modification.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getDn()
inherited_from \Zend\Ldap\Node\RootDse::getDn()

Returns

Gets the DN of the current node as an array.

getDnArray(string $caseFold) : array
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getDnArray()
inherited_from \Zend\Ldap\Node\RootDse::getDnArray()

Parameters

$caseFold

string

Returns

array

Gets the DN of the current node as a string.

getDnString(string $caseFold) : string
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getDnString()
inherited_from \Zend\Ldap\Node\RootDse::getDnString()

Parameters

$caseFold

string

Returns

string

Gets the monitorContext.

getMonitorContext() : string | null

Returns

stringnull

Gets the namingContexts.

getNamingContexts() : array
Inherited

inherited_from \Zend\Ldap\Node\RootDse::getNamingContexts()

Returns

array

Gets the objectClass of the node

getObjectClass() : array
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::getObjectClass()
inherited_from \Zend\Ldap\Node\RootDse::getObjectClass()

Returns

array

Gets the RDN of the current node as an array.

getRdnArray(string $caseFold) : array
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getRdnArray()
inherited_from \Zend\Ldap\Node\RootDse::getRdnArray()

Parameters

$caseFold

string

Returns

array

Gets the RDN of the current node as a string.

getRdnString(string $caseFold) : string
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::getRdnString()
inherited_from \Zend\Ldap\Node\RootDse::getRdnString()

Parameters

$caseFold

string

Returns

string

Returns the schema DN

getSchemaDn() : \Zend\Ldap\Dn
Inherited

inherited_from \Zend\Ldap\Node\RootDse::getSchemaDn()

Returns

Gets the server type

getServerType() : int

Returns

int

Gets the subschemaSubentry.

getSubschemaSubentry() : string | null
Inherited

inherited_from \Zend\Ldap\Node\RootDse::getSubschemaSubentry()

Returns

stringnull

Checks whether a given attribute exists.

offsetExists(string $name) : bool
Inherited

Implements ArrayAccess.

Empty attributes will be treated as non-existent.

inherited_from \Zend\Ldap\Node\AbstractNode::offsetExists()
inherited_from \Zend\Ldap\Node\RootDse::offsetExists()

Parameters

$name

string

Returns

bool

Gets a LDAP attribute.

offsetGet(string $name) : mixed
Inherited

Implements ArrayAccess.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::offsetGet()
inherited_from \Zend\Ldap\Node\RootDse::offsetGet()

Parameters

$name

string

Exceptions

\Zend\Ldap\Exception\LdapException

Returns

mixed

Sets a LDAP attribute.

offsetSet(string $name, mixed $value) 
Inherited

Implements ArrayAccess.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::offsetSet()
inherited_from \Zend\Ldap\Node\RootDse::offsetSet()

Parameters

$name

string

$value

mixed

Exceptions

\Zend\Ldap\Exception\BadMethodCallException
\Zend\Ldap\Exception\BadMethodCallException

Deletes a LDAP attribute.

offsetUnset($name) 
Inherited

Implements ArrayAccess.

This method deletes the attribute.

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::offsetUnset()
inherited_from \Zend\Ldap\Node\RootDse::offsetUnset()

Parameters

$name

Exceptions

\Zend\Ldap\Exception\BadMethodCallException

Reload node attributes from LDAP.

reload(\Zend\Ldap\Ldap $ldap) : \Zend\Ldap\Node\AbstractNode
Inherited

This is an online method.

inherited_from \Zend\Ldap\Node\AbstractNode::reload()
inherited_from \Zend\Ldap\Node\RootDse::reload()

Parameters

Returns

\Zend\Ldap\Node\AbstractNodeProvides a fluid interface

Determines if the control is supported

supportsControl(string | array $oids) : bool

Parameters

$oids

stringarray

control oid(s) to check

Returns

bool

Determines if the extension is supported

supportsExtension(string | array $oids) : bool

Parameters

$oids

stringarray

oid(s) to check

Returns

bool

Determines if the feature is supported

supportsFeature(string | array $oids) : bool

Parameters

$oids

stringarray

feature oid(s) to check

Returns

bool

Determines if the sasl mechanism is supported

supportsSaslMechanism(string | array $mechlist) : bool
Inherited

inherited_from \Zend\Ldap\Node\RootDse::supportsSaslMechanism()

Parameters

$mechlist

stringarray

SASL mechanisms to check

Returns

bool

Determines if the version is supported

supportsVersion(string | int | array $versions) : bool
Inherited

inherited_from \Zend\Ldap\Node\RootDse::supportsVersion()

Parameters

$versions

stringintarray

version(s) to check

Returns

bool

Returns an array representation of the current node

toArray(bool $includeSystemAttributes) : array
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::toArray()
inherited_from \Zend\Ldap\Node\RootDse::toArray()

Parameters

$includeSystemAttributes

bool

Returns

array

Returns a JSON representation of the current node

toJson(bool $includeSystemAttributes) : string
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::toJson()
inherited_from \Zend\Ldap\Node\RootDse::toJson()

Parameters

$includeSystemAttributes

bool

Returns

string

Returns the DN of the current node.

toString() : string
Inherited

{@see getDnString()}

inherited_from \Zend\Ldap\Node\AbstractNode::toString()
inherited_from \Zend\Ldap\Node\RootDse::toString()

Returns

string

Constructor.

__construct(\Zend\Ldap\Dn $dn, array $data) 
Inherited

Constructor is protected to enforce the use of factory methods.

inherited_from \Zend\Ldap\Node\RootDse::__construct()

Parameters

$data

array

Gets the DN of the current node as a Zend\Ldap\Dn.

_getDn() : \Zend\Ldap\Dn
Inherited

This is an offline method.

inherited_from \Zend\Ldap\Node\AbstractNode::_getDn()
inherited_from \Zend\Ldap\Node\RootDse::_getDn()

Returns

loadData()

loadData(array $data, bool $fromDataSource) 
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::loadData()
inherited_from \Zend\Ldap\Node\RootDse::loadData()

Parameters

$data

array

$fromDataSource

bool

 Properties

 

Holds the node's current data.

$currentData : array
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::$$currentData
inherited_from \Zend\Ldap\Node\RootDse::$$currentData
 

Holds the node's DN.

$dn : \Zend\Ldap\Dn
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::$$dn
inherited_from \Zend\Ldap\Node\RootDse::$$dn
 

$systemAttributes

$systemAttributes 
Inherited

inherited_from \Zend\Ldap\Node\AbstractNode::$$systemAttributes
inherited_from \Zend\Ldap\Node\RootDse::$$systemAttributes

 Constants

 

SERVER_TYPE_ACTIVEDIRECTORY

SERVER_TYPE_ACTIVEDIRECTORY 
Inherited

inherited_from \Zend\Ldap\Node\RootDse::SERVER_TYPE_ACTIVEDIRECTORY
 

SERVER_TYPE_EDIRECTORY

SERVER_TYPE_EDIRECTORY 
Inherited

inherited_from \Zend\Ldap\Node\RootDse::SERVER_TYPE_EDIRECTORY
 

SERVER_TYPE_GENERIC

SERVER_TYPE_GENERIC 
Inherited

inherited_from \Zend\Ldap\Node\RootDse::SERVER_TYPE_GENERIC
 

SERVER_TYPE_OPENLDAP

SERVER_TYPE_OPENLDAP 
Inherited

inherited_from \Zend\Ldap\Node\RootDse::SERVER_TYPE_OPENLDAP