API Documentation

Zend/Ldap/Node/Abstract.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Ldap  
Subpackage
Node  
Version
$Id: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Ldap_Node_Abstract

Package: Zend\Ldap\Node

Zend_Ldap_Node_Abstract provides a bas eimplementation for LDAP nodes

Implements
Children
\Zend_Ldap_Node
\Zend_Ldap_Node_RootDse
\Zend_Ldap_Node_Schema
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_currentData= ''

Holds the node's current data.

Details
Type
array
Propertyprotected\Zend_Ldap_Dn  $_dn= ''

Holds the node's DN.

Details
Type
\Zend_Ldap_Dn
Propertyprotected  $_systemAttributes= 'array('createtimestamp''
static
Default valuearray('createtimestamp'Details
Type

Methods

methodprotected__construct( \Zend_Ldap_Dn $dn, array $data, boolean $fromDataSource ) : void

Constructor.

Constructor is protected to enforce the use of factory methods.

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

Gets a LDAP attribute.

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.

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.

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()}

Returns
Type Description
string
methodpublic__unset( string $name ) : null

Deletes a LDAP attribute.

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.

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

Parameters
Name Type Description
$attribName string
$value mixed|array
Returns
Type Description
boolean
methodpubliccount( ) : int

Returns the number of attributes in node.

Implements Countable

Returns
Type Description
int
methodpublicexistsAttribute( string $name, boolean $emptyExists = false ) : boolean

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.

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

Gets a LDAP attribute.

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.

The collection contains all attributes.

This is an offline method.

Parameters
Name Type Description
$includeSystemAttributes boolean
Returns
Type Description
array
methodpublicgetData( boolean $includeSystemAttributes = true ) : array

Gets node attributes.

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.

This is an offline method.

Parameters
Name Type Description
$name string
$index integer
Returns
Type Description
array|integer
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicgetDn( ) : \Zend_Ldap_Dn

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.

Returns
Type Description
\Zend_Ldap_Dn
methodpublicgetDnArray( string $caseFold = null ) : array

Gets the DN of the current node as an array.

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.

This is an offline method.

Parameters
Name Type Description
$caseFold string
Returns
Type Description
string
methodpublicgetObjectClass( ) : array

Gets the objectClass of the node

Returns
Type Description
array
methodpublicgetRdnArray( string $caseFold = null ) : array

Gets the RDN of the current node as an array.

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.

This is an offline method.

Parameters
Name Type Description
$caseFold string
Returns
Type Description
string
methodpublicoffsetExists( string $name ) : boolean

Checks whether a given attribute exists.

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.

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.

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.

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.

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
methodpublictoArray( boolean $includeSystemAttributes = true ) : array

Returns an array representation of the current node

Parameters
Name Type Description
$includeSystemAttributes boolean
Returns
Type Description
array
methodpublictoJson( boolean $includeSystemAttributes = true ) : string

Returns a JSON representation of the current node

Parameters
Name Type Description
$includeSystemAttributes boolean
Returns
Type Description
string
methodpublictoString( ) : string

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

Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.