API Documentation

Ldap/Node/RootDse/ActiveDirectory.php

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.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Ldap  
subpackage
RootDSE  
version
$Id: ActiveDirectory.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Ldap_Node_RootDse_ActiveDirectory

Zend_Ldap_Node_RootDse provides a simple data-container for the RootDSE node of an Active Directory server.

Extends from
\Zend_Ldap_Node_RootDse
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Ldap  
subpackage
RootDSE  

Methods

methodprotected__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.

Parameters
Name Type Description
$dn \Zend_Ldap_Dn
$data array
methodpublic__get( string $name ) : array

Gets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::__get()

This is an offline method.

Parameters
Name Type Description
$name string
Returns
Type Description
array
Throws
Exception Description
\Zend_Ldap_Exception
methodpublic__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.

Parameters
Name Type Description
$name string
Returns
Type Description
boolean
methodpublic__set( string $name, mixed $value ) : null

Sets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::__set()

This is an offline method.

Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
null
Throws
Exception Description
\BadMethodCallException
methodpublic__toString( ) : string

Cast to string representation {@see toString()}

Inherited from: \Zend_Ldap_Node_Abstract::__toString()
Returns
Type Description
string
methodpublic__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.

Parameters
Name Type Description
$name string
Returns
Type Description
null
Throws
Exception Description
\BadMethodCallException
methodprotected_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.

Returns
Type Description
\Zend_Ldap_Dn
methodprotected_loadData( array $data, boolean $fromDataSource ) : void
Parameters
Name Type Description
$data array
$fromDataSource boolean
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicattributeHasValue( string $attribName, mixed|array $value ) : boolean

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

Inherited from: \Zend_Ldap_Node_Abstract::attributeHasValue()
Parameters
Name Type Description
$attribName string
$value mixed|array
Returns
Type Description
boolean
methodpubliccount( ) : int

Returns the number of attributes in node.

Inherited from: \Zend_Ldap_Node_Abstract::count()

Implements Countable

Returns
Type Description
int
methodpubliccreate( \Zend_Ldap $ldap ) : \Zend_Ldap_Node_RootDse
static

Factory method to create the RootDSE.

Inherited from: \Zend_Ldap_Node_RootDse::create()
Parameters
Name Type Description
$ldap \Zend_Ldap
Returns
Type Description
\Zend_Ldap_Node_RootDse
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicexistsAttribute( 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.

Parameters
Name Type Description
$name string
$emptyExists boolean
Returns
Type Description
boolean
methodpublicgetAttribute( string $name, integer $index = null ) : mixed

Gets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::getAttribute()

This is an offline method.

Parameters
Name Type Description
$name string
$index integer
Returns
Type Description
mixed
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicgetAttributes( 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.

Parameters
Name Type Description
$includeSystemAttributes boolean
Returns
Type Description
array
methodpublicgetConfigurationNamingContext( ) : string|null

Gets the configurationNamingContext.

Returns
Type Description
stringnull
methodpublicgetCurrentTime( ) : string|null

Gets the currentTime.

Returns
Type Description
stringnull
methodpublicgetData( 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.

Parameters
Name Type Description
$includeSystemAttributes boolean
Returns
Type Description
array
methodpublicgetDateTimeAttribute( 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.

Parameters
Name Type Description
$name string
$index integer
Returns
Type Description
arrayinteger
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicgetDefaultNamingContext( ) : string|null

Gets the defaultNamingContext.

Returns
Type Description
stringnull
methodpublicgetDn( ) : \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.

Returns
Type Description
\Zend_Ldap_Dn
methodpublicgetDnArray( 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.

Parameters
Name Type Description
$caseFold string
Returns
Type Description
array
methodpublicgetDnString( 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.

Parameters
Name Type Description
$caseFold string
Returns
Type Description
string
methodpublicgetDnsHostName( ) : string|null

Gets the dnsHostName.

Returns
Type Description
stringnull
methodpublicgetDomainControllerFunctionality( ) : string|null

Gets the domainControllerFunctionality.

Returns
Type Description
stringnull
methodpublicgetDomainFunctionality( ) : string|null

Gets the domainFunctionality.

Returns
Type Description
stringnull
methodpublicgetDsServiceName( ) : string|null

Gets the dsServiceName.

Returns
Type Description
stringnull
methodpublicgetForestFunctionality( ) : string|null

Gets the forestFunctionality.

Returns
Type Description
stringnull
methodpublicgetHighestCommittedUSN( ) : string|null

Gets the highestCommittedUSN.

Returns
Type Description
stringnull
methodpublicgetIsGlobalCatalogReady( ) : string|null

Gets the isGlobalCatalogReady.

Returns
Type Description
stringnull
methodpublicgetIsSynchronized( ) : string|null

Gets the isSynchronized.

Returns
Type Description
stringnull
methodpublicgetLdapServiceName( ) : string|null

Gets the ldapServiceName.

Returns
Type Description
stringnull
methodpublicgetNamingContexts( ) : array

Gets the namingContexts.

Inherited from: \Zend_Ldap_Node_RootDse::getNamingContexts()
Returns
Type Description
array
methodpublicgetObjectClass( ) : array

Gets the objectClass of the node

Inherited from: \Zend_Ldap_Node_Abstract::getObjectClass()
Returns
Type Description
array
methodpublicgetRdnArray( 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.

Parameters
Name Type Description
$caseFold string
Returns
Type Description
array
methodpublicgetRdnString( 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.

Parameters
Name Type Description
$caseFold string
Returns
Type Description
string
methodpublicgetRootDomainNamingContext( ) : string|null

Gets the rootDomainNamingContext.

Returns
Type Description
stringnull
methodpublicgetSchemaDn( ) : \Zend_Ldap_Dn

Returns the schema DN

Returns
Type Description
\Zend_Ldap_Dn
methodpublicgetSchemaNamingContext( ) : string|null

Gets the schemaNamingContext.

Returns
Type Description
stringnull
methodpublicgetServerName( ) : string|null

Gets the serverName.

Returns
Type Description
stringnull
methodpublicgetServerType( ) : int

Gets the server type

Returns
Type Description
int
methodpublicgetSubschemaSubentry( ) : string|null

Gets the subschemaSubentry.

Inherited from: \Zend_Ldap_Node_RootDse::getSubschemaSubentry()
Returns
Type Description
stringnull
methodpublicoffsetExists( 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.

Parameters
Name Type Description
$name string
Returns
Type Description
boolean
methodpublicoffsetGet( string $name ) : array

Gets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::offsetGet()

Implements ArrayAccess.

This is an offline method.

Parameters
Name Type Description
$name string
Returns
Type Description
array
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicoffsetSet( string $name, mixed $value ) : null

Sets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::offsetSet()

Implements ArrayAccess.

This is an offline method.

Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
null
Throws
Exception Description
\BadMethodCallException
methodpublicoffsetUnset( 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.

Parameters
Name Type Description
$name string
Returns
Type Description
null
Throws
Exception Description
\BadMethodCallException
methodpublicreload( \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.

Parameters
Name Type Description
$ldap \Zend_Ldap
Returns
Type Description
\Zend_Ldap_Node_Abstract Provides a fluid interface
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicsupportsCapability( string|string|array $oids ) : boolean

Determines if the capability is supported

Parameters
Name Type Description
$oids string|string|array

capability(s) to check

Returns
Type Description
boolean
methodpublicsupportsControl( string|array $oids ) : boolean

Determines if the control is supported

Parameters
Name Type Description
$oids string|array

control oid(s) to check

Returns
Type Description
boolean
methodpublicsupportsPolicy( string|array $policies ) : boolean

Determines if the version is supported

Parameters
Name Type Description
$policies string|array

policy(s) to check

Returns
Type Description
boolean
methodpublicsupportsSaslMechanism( string|array $mechlist ) : boolean

Determines if the sasl mechanism is supported

Inherited from: \Zend_Ldap_Node_RootDse::supportsSaslMechanism()
Parameters
Name Type Description
$mechlist string|array SASL mechanisms to check
Returns
Type Description
boolean
methodpublicsupportsVersion( string|int|array $versions ) : boolean

Determines if the version is supported

Inherited from: \Zend_Ldap_Node_RootDse::supportsVersion()
Parameters
Name Type Description
$versions string|int|array

version(s) to check

Returns
Type Description
boolean
methodpublictoArray( boolean $includeSystemAttributes = true ) : array

Returns an array representation of the current node

Inherited from: \Zend_Ldap_Node_Abstract::toArray()
Parameters
Name Type Description
$includeSystemAttributes boolean
Returns
Type Description
array
methodpublictoJson( boolean $includeSystemAttributes = true ) : string

Returns a JSON representation of the current node

Inherited from: \Zend_Ldap_Node_Abstract::toJson()
Parameters
Name Type Description
$includeSystemAttributes boolean
Returns
Type Description
string
methodpublictoString( ) : string

Returns the DN of the current node. {@see getDnString()}

Inherited from: \Zend_Ldap_Node_Abstract::toString()
Returns
Type Description
string
Documentation was generated by DocBlox 0.13.3.