API Documentation

Ldap/Node/Abstract.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Ldap
subpackage
Node
version
$Id: Abstract.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Ldap_Node_Abstract

Description

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_Abstract
jump to top

Implements
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Ldap
subpackage
Node
Properties
$_systemAttributes
$_dn
$_currentData
Methods
__construct
_loadData
reload
_getDn
getDn
getDnString
getDnArray
getRdnString
getRdnArray
getObjectClass
getAttributes
toString
__toString
toArray
toJson
getData
existsAttribute
attributeHasValue
getAttribute
getDateTimeAttribute
__set
__get
__unset
__isset
offsetSet
offsetGet
offsetUnset
offsetExists
count

Description

Zend_Ldap_Node_Abstract provides a bas eimplementation for LDAP nodes

Properties

$_currentData
jump to class

array $_currentData = ''

Holds the node's current data.

Details

$_currentData
array
visibility
protected
default
final
false
static
false

$_dn
jump to class

Zend_Ldap_Dn $_dn = ''

Holds the node's DN.

Details

$_dn
Zend_Ldap_Dn
visibility
protected
default
final
false
static
false

$_systemAttributes
jump to class

 $_systemAttributes = 'createtimestamp'

Details

visibility
protected
default
createtimestamp
final
false
static
true

Methods

__construct
jump to class

__construct( Zend_Ldap_Dn $dn, array $data, boolean $fromDataSource ) :

Constructor.

Constructor is protected to enforce the use of factory methods.

Arguments
$dn
Zend_Ldap_Dn
$data
array
$fromDataSource
boolean
Details
visibility
protected
final
false
static
false

__get
jump to class

__get( string $name ) : array

Gets a LDAP attribute.

This is an offline method.

Arguments
$name
string
Output
array
Details
visibility
public
final
false
static
false
throws

__isset
jump to class

__isset( string $name ) : boolean

Checks whether a given attribute exists.

Empty attributes will be treated as non-existent.

Arguments
$name
string
Output
boolean
Details
visibility
public
final
false
static
false

__set
jump to class

__set( string $name, mixed $value ) : null

Sets a LDAP attribute.

This is an offline method.

Arguments
$name
string
$value
mixed
Output
null
Details
visibility
public
final
false
static
false
throws

__toString
jump to class

__toString( ) : string

Cast to string representation {@see toString()}

Output
string
Details
visibility
public
final
false
static
false

__unset
jump to class

__unset( string $name ) : null

Deletes a LDAP attribute.

This method deletes the attribute.

This is an offline method.

Arguments
$name
string
Output
null
Details
visibility
public
final
false
static
false
throws

_getDn
jump to class

_getDn( ) : Zend_Ldap_Dn

Gets the DN of the current node as a Zend_Ldap_Dn.

This is an offline method.

Output
Zend_Ldap_Dn
Details
visibility
protected
final
false
static
false

_loadData
jump to class

_loadData( array $data, boolean $fromDataSource ) :

Arguments
$data
array
$fromDataSource
boolean
Details
visibility
protected
final
false
static
false
throws

attributeHasValue
jump to class

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

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

Arguments
$attribName
string
$value
mixedarray
Output
boolean
Details
visibility
public
final
false
static
false

count
jump to class

count( ) : int

Returns the number of attributes in node.

Implements Countable

Output
int
Details
visibility
public
final
false
static
false

existsAttribute
jump to class

existsAttribute( 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.

Arguments
$name
string
$emptyExists
boolean
Output
boolean
Details
visibility
public
final
false
static
false

getAttribute
jump to class

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

Gets a LDAP attribute.

This is an offline method.

Arguments
$name
string
$index
integer
Output
mixed
Details
visibility
public
final
false
static
false
throws

getAttributes
jump to class

getAttributes( boolean $includeSystemAttributes = true ) : array

Gets all attributes of node.

The collection contains all attributes.

This is an offline method.

Arguments
$includeSystemAttributes
boolean
Output
array
Details
visibility
public
final
false
static
false

getData
jump to class

getData( boolean $includeSystemAttributes = true ) : array

Gets node attributes.

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

This is an offline method.

Arguments
$includeSystemAttributes
boolean
Output
array
Details
visibility
public
final
false
static
false

getDateTimeAttribute
jump to class

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

Gets a LDAP date/time attribute.

This is an offline method.

Arguments
$name
string
$index
integer
Output
array|integer
Details
visibility
public
final
false
static
false
throws

getDn
jump to class

getDn( ) : 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.

Output
Zend_Ldap_Dn
Details
visibility
public
final
false
static
false

getDnArray
jump to class

getDnArray( string $caseFold = null ) : array

Gets the DN of the current node as an array.

This is an offline method.

Arguments
$caseFold
string
Output
array
Details
visibility
public
final
false
static
false

getDnString
jump to class

getDnString( string $caseFold = null ) : string

Gets the DN of the current node as a string.

This is an offline method.

Arguments
$caseFold
string
Output
string
Details
visibility
public
final
false
static
false

getObjectClass
jump to class

getObjectClass( ) : array

Gets the objectClass of the node

Output
array
Details
visibility
public
final
false
static
false

getRdnArray
jump to class

getRdnArray( string $caseFold = null ) : array

Gets the RDN of the current node as an array.

This is an offline method.

Arguments
$caseFold
string
Output
array
Details
visibility
public
final
false
static
false

getRdnString
jump to class

getRdnString( string $caseFold = null ) : string

Gets the RDN of the current node as a string.

This is an offline method.

Arguments
$caseFold
string
Output
string
Details
visibility
public
final
false
static
false

offsetExists
jump to class

offsetExists( string $name ) : boolean

Checks whether a given attribute exists.

Implements ArrayAccess.

Empty attributes will be treated as non-existent.

Arguments
$name
string
Output
boolean
Details
visibility
public
final
false
static
false

offsetGet
jump to class

offsetGet( string $name ) : array

Gets a LDAP attribute.

Implements ArrayAccess.

This is an offline method.

Arguments
$name
string
Output
array
Details
visibility
public
final
false
static
false
throws

offsetSet
jump to class

offsetSet( string $name, mixed $value ) : null

Sets a LDAP attribute.

Implements ArrayAccess.

This is an offline method.

Arguments
$name
string
$value
mixed
Output
null
Details
visibility
public
final
false
static
false
throws

offsetUnset
jump to class

offsetUnset( string $name ) : null

Deletes a LDAP attribute.

Implements ArrayAccess.

This method deletes the attribute.

This is an offline method.

Arguments
$name
string
Output
null
Details
visibility
public
final
false
static
false
throws

reload
jump to class

reload( Zend_Ldap $ldap = null ) : Zend_Ldap_Node_Abstract

Reload node attributes from LDAP.

This is an online method.

Arguments
$ldap
Zend_Ldap
Output
Zend_Ldap_Node_Abstract
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

toArray
jump to class

toArray( boolean $includeSystemAttributes = true ) : array

Returns an array representation of the current node

Arguments
$includeSystemAttributes
boolean
Output
array
Details
visibility
public
final
false
static
false

toJson
jump to class

toJson( boolean $includeSystemAttributes = true ) : string

Returns a JSON representation of the current node

Arguments
$includeSystemAttributes
boolean
Output
string
Details
visibility
public
final
false
static
false

toString
jump to class

toString( ) : string

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

Output
string
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.