Docs For Class Zend_Ldap_Node

Zend_Ldap_Node_Abstract

Description

Implements interfaces:

ArrayAccess (internal interface)
Countable (internal interface)

Zend_Ldap_Node_Abstract provides a bas eimplementation for LDAP nodes

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
abstract:
license: New BSD License

Located in /Ldap/Node/Abstract.php (line 41)

Direct descendents

Class	Description
Zend_Ldap_Node	Zend_Ldap_Node provides an object oriented view into a LDAP node.
Zend_Ldap_Node_Schema	Zend_Ldap_Node_Schema provides a simple data-container for the Schema node.
Zend_Ldap_Node_RootDse	Zend_Ldap_Node_RootDse provides a simple data-container for the RootDSE node.

Variable Summary

static mixed $_systemAttributes

array $_currentData

Zend_Ldap_Dn $_dn

Method Summary

Zend_Ldap_Node_Abstract __construct (Zend_Ldap_Dn $dn, $data, boolean $fromDataSource)

boolean attributeHasValue (string $attribName, mixed|array $value)

int count ()

boolean existsAttribute (string $name, [boolean $emptyExists = false])

mixed getAttribute (string $name, [integer $index = null])

array getAttributes ([boolean $includeSystemAttributes = true])

array getData ([boolean $includeSystemAttributes = true])

array|integer getDateTimeAttribute (string $name, [integer $index = null])

Zend_Ldap_Dn getDn ()

array getDnArray ([string $caseFold = null])

string getDnString ([string $caseFold = null])

array getObjectClass ()

array getRdnArray ([string $caseFold = null])

string getRdnString ([string $caseFold = null])

boolean offsetExists (string $name)

array offsetGet (string $name)

null offsetSet (string $name, mixed $value)

null offsetUnset (string $name)

Zend_Ldap_Node_Abstract reload ([Zend_Ldap $ldap = null])

array toArray ([boolean $includeSystemAttributes = true])

string toJson ([boolean $includeSystemAttributes = true])

string toString ()

Zend_Ldap_Dn _getDn ()

void _loadData ( $data, boolean $fromDataSource)

array __get (string $name)

boolean __isset (string $name)

null __set (string $name, mixed $value)

string __toString ()

null __unset (string $name)

Variables

static mixed $_systemAttributes = array('createtimestamp', 'creatorsname',
'entrycsn', 'entrydn', 'entryuuid', 'hassubordinates', 'modifiersname',
'modifytimestamp', 'structuralobjectclass', 'subschemasubentry',
'distinguishedname', 'instancetype', 'name', 'objectcategory', 'objectguid',
'usnchanged', 'usncreated', 'whenchanged', 'whencreated') (line 43)

access: protected

array $_currentData (line 61)

Holds the node's current data.

access: protected

Zend_Ldap_Dn $_dn (line 54)

Holds the node's DN.

access: protected

Methods

Constructor __construct (line 72)

Constructor.

Constructor is protected to enforce the use of factory methods.

access: protected

Zend_Ldap_Node_Abstract __construct (Zend_Ldap_Dn $dn, $data, boolean $fromDataSource)

Zend_Ldap_Dn $dn
array $data
boolean $fromDataSource

Redefined in descendants as:

Zend_Ldap_Node::__construct() : Constructor.
Zend_Ldap_Node_Schema::__construct() : Constructor.
Zend_Ldap_Node_RootDse::__construct() : Constructor.

attributeHasValue (line 315)

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

access: public

boolean attributeHasValue (string $attribName, mixed|array $value)

string $attribName
mixed|array $value

count (line 481)

Returns the number of attributes in node.

Implements Countable

access: public

int count ()

Implementation of:

Countable::count

existsAttribute (line 298)

Checks whether a given attribute exists.

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.

access: public

boolean existsAttribute (string $name, [boolean $emptyExists = false])

string $name
boolean $emptyExists

getAttribute (line 330)

Gets a LDAP attribute.

This is an offline method.

throws: Zend_Ldap_Exception
access: public

mixed getAttribute (string $name, [integer $index = null])

string $name
integer $index

getAttributes (line 208)

Gets all attributes of node.

The collection contains all attributes.

This is an offline method.

access: public

array getAttributes ([boolean $includeSystemAttributes = true])

boolean $includeSystemAttributes

getData (line 270)

Gets node attributes.

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

This is an offline method.

access: public

array getData ([boolean $includeSystemAttributes = true])

boolean $includeSystemAttributes

getDateTimeAttribute (line 350)

Gets a LDAP date/time attribute.

This is an offline method.

throws: Zend_Ldap_Exception
access: public

array|integer getDateTimeAttribute (string $name, [integer $index = null])

string $name
integer $index

getDn (line 130)

Gets the DN of the current node as a Zend_Ldap_Dn.

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

This is an offline method.

access: public

Zend_Ldap_Dn getDn ()

getDnArray (line 157)

Gets the DN of the current node as an array.

This is an offline method.

access: public

array getDnArray ([string $caseFold = null])

string $caseFold

getDnString (line 144)

Gets the DN of the current node as a string.

This is an offline method.

access: public

string getDnString ([string $caseFold = null])

string $caseFold

getObjectClass (line 193)

Gets the objectClass of the node

access: public

array getObjectClass ()

getRdnArray (line 183)

Gets the RDN of the current node as an array.

This is an offline method.

access: public

array getRdnArray ([string $caseFold = null])

string $caseFold

getRdnString (line 170)

Gets the RDN of the current node as a string.

This is an offline method.

access: public

string getRdnString ([string $caseFold = null])

string $caseFold

offsetExists (line 470)

Checks whether a given attribute exists.

Implements ArrayAccess.

Empty attributes will be treated as non-existent.

access: public

boolean offsetExists (string $name)

string $name

Implementation of:

ArrayAccess::offsetExists

offsetGet (line 439)

Gets a LDAP attribute.

Implements ArrayAccess.

This is an offline method.

throws: Zend_Ldap_Exception
access: public

array offsetGet (string $name)

string $name

Implementation of:

ArrayAccess::offsetGet

offsetSet (line 424)

Sets a LDAP attribute.

Implements ArrayAccess.

This is an offline method.

throws: BadMethodCallException
access: public

null offsetSet (string $name, mixed $value)

string $name
mixed $value

Implementation of:

ArrayAccess::offsetSet

Redefined in descendants as:

Zend_Ldap_Node::offsetSet() : Sets a LDAP attribute.

offsetUnset (line 456)

Deletes a LDAP attribute.

Implements ArrayAccess.

This method deletes the attribute.

This is an offline method.

throws: BadMethodCallException
access: public

null offsetUnset (string $name)

string $name

Implementation of:

ArrayAccess::offsetUnset

Redefined in descendants as:

Zend_Ldap_Node::offsetUnset() : Deletes a LDAP attribute.

reload (line 101)

Reload node attributes from LDAP.

This is an online method.

return: Provides a fluid interface
throws: Zend_Ldap_Exception
access: public

Zend_Ldap_Node_Abstract reload ([Zend_Ldap $ldap = null])

Zend_Ldap $ldap

Redefined in descendants as:

Zend_Ldap_Node::reload() : Reload node attributes from LDAP.

toArray (line 243)

Returns an array representation of the current node

access: public

array toArray ([boolean $includeSystemAttributes = true])

boolean $includeSystemAttributes

toJson (line 255)

Returns a JSON representation of the current node

access: public

string toJson ([boolean $includeSystemAttributes = true])

boolean $includeSystemAttributes

toString (line 222)

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

access: public

string toString ()

_getDn (line 117)

Gets the DN of the current node as a Zend_Ldap_Dn.

This is an offline method.

access: protected

Zend_Ldap_Dn _getDn ()

Redefined in descendants as:

Zend_Ldap_Node::_getDn() : Gets the DN of the current node as a Zend_Ldap_Dn.

_loadData (line 83)

throws: Zend_Ldap_Exception
access: protected

void _loadData ( $data, boolean $fromDataSource)

array $data
boolean $fromDataSource

Redefined in descendants as:

Zend_Ldap_Node::_loadData()

__get (line 379)

Gets a LDAP attribute.

This is an offline method.

throws: Zend_Ldap_Exception
access: public

array __get (string $name)

string $name

__isset (line 408)

Checks whether a given attribute exists.

Empty attributes will be treated as non-existent.

access: public

boolean __isset (string $name)

string $name

__set (line 365)

Sets a LDAP attribute.

This is an offline method.

throws: BadMethodCallException
access: public

null __set (string $name, mixed $value)

string $name
mixed $value

Redefined in descendants as:

Zend_Ldap_Node::__set() : Sets a LDAP attribute.

__toString (line 232)

Cast to string representation {@see toString()}

access: public

string __toString ()

__unset (line 395)

Deletes a LDAP attribute.

This method deletes the attribute.

This is an offline method.

throws: BadMethodCallException
access: public

null __unset (string $name)

string $name

Redefined in descendants as:

Zend_Ldap_Node::__unset() : Deletes a LDAP attribute.

Documentation generated on Mon, 21 Jun 2010 15:04:45 -0400 by phpDocumentor 1.4.3