API Documentation

Ldap/Node.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: Node.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Ldap_Node

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

Extends from
Zend_Ldap_Node_Abstract
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
$_newDn
$_originalData
$_new
$_delete
$_ldap
$_children
$_iteratorRewind
Methods
__construct
__sleep
__wakeup
getLdap
attachLdap
detachLdap
isAttached
_loadData
create
fromLdap
fromArray
_ensureRdnAttributeValues
_markAsNew
isNew
_markAsToBeDeleted
willBeDeleted
delete
willBeMoved
update
_getDn
getCurrentDn
setDn
move
rename
setObjectClass
appendObjectClass
toLdif
getChangedData
getChanges
setAttribute
appendToAttribute
_setAttribute
setDateTimeAttribute
appendToDateTimeAttribute
_setDateTimeAttribute
setPasswordAttribute
deleteAttribute
removeDuplicatesFromAttribute
removeFromAttribute
_assertChangeableAttribute
__set
__unset
offsetSet
offsetUnset
exists
reload
searchSubtree
countSubtree
countChildren
searchChildren
hasChildren
getChildren
getParent
current
key
next
rewind
valid

Description

Zend_Ldap_Node provides an object oriented view into a LDAP node.

Properties

$_children
jump to class

array $_children = ''

Holds an array of the current node's children.

Details

$_children
array
visibility
protected
default
final
false
static
false

$_delete
jump to class

boolean $_delete = ''

This node will be deleted

Details

$_delete
boolean
visibility
protected
default
final
false
static
false

$_iteratorRewind
jump to class

boolean $_iteratorRewind = 'false'

Controls iteration status

Details

$_iteratorRewind
boolean
visibility
private
default
false
final
false
static
false

$_ldap
jump to class

Zend_Ldap $_ldap = ''

Holds the connection to the LDAP server if in connected mode.

Details

$_ldap
Zend_Ldap
visibility
protected
default
final
false
static
false

$_new
jump to class

boolean $_new = ''

This node will be added

Details

$_new
boolean
visibility
protected
default
final
false
static
false

$_newDn
jump to class

Zend_Ldap_Dn $_newDn = ''

Holds the node's new DN if node is renamed.

Details

$_newDn
Zend_Ldap_Dn
visibility
protected
default
final
false
static
false

$_originalData
jump to class

array $_originalData = ''

Holds the node's orginal attributes (as loaded).

Details

$_originalData
array
visibility
protected
default
final
false
static
false

Methods

__construct
jump to class

__construct( Zend_Ldap_Dn $dn, array $data, boolean $fromDataSource, Zend_Ldap $ldap = null ) :

Constructor.

Constructor is protected to enforce the use of factory methods.

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

__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

__sleep
jump to class

__sleep( ) : array

Serialization callback

Only DN and attributes will be serialized.

Output
array
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

__wakeup
jump to class

__wakeup( ) : null

Deserialization callback

Enforces a detached node.

Output
null
Details
visibility
public
final
false
static
false

_assertChangeableAttribute
jump to class

_assertChangeableAttribute( string $name ) : boolean

Arguments
$name
string
Output
boolean
Details
visibility
protected
final
false
static
false
throws

_ensureRdnAttributeValues
jump to class

_ensureRdnAttributeValues( ) : void

Ensures that teh RDN attributes are correctly set.

Details
visibility
protected
final
false
static
false

_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

_markAsNew
jump to class

_markAsNew( boolean $new ) :

Marks this node as new.

Node will be added (instead of updated) on calling update() if $new is true.

Arguments
$new
boolean
Details
visibility
protected
final
false
static
false

_markAsToBeDeleted
jump to class

_markAsToBeDeleted( boolean $delete ) :

Marks this node as to be deleted.

Node will be deleted on calling update() if $delete is true.

Arguments
$delete
boolean
Details
visibility
protected
final
false
static
false

_setAttribute
jump to class

_setAttribute( string $name, mixed $value, boolean $append ) :

Checks if the attribute can be set and sets it accordingly.

Arguments
$name
string
$value
mixed
$append
boolean
Details
visibility
protected
final
false
static
false
throws

_setDateTimeAttribute
jump to class

_setDateTimeAttribute( string $name, integer|array $value, boolean $utc, boolean $append ) :

Checks if the attribute can be set and sets it accordingly.

Arguments
$name
string
$value
integerarray
$utc
boolean
$append
boolean
Details
visibility
protected
final
false
static
false
throws

appendObjectClass
jump to class

appendObjectClass( array|string $value ) : Zend_Ldap_Node

Appends to the objectClass.

This is an offline method.

Arguments
$value
arraystring
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

appendToAttribute
jump to class

appendToAttribute( string $name, mixed $value ) : Zend_Ldap_Node

Appends to a LDAP attribute.

This is an offline method.

Arguments
$name
string
$value
mixed
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

appendToDateTimeAttribute
jump to class

appendToDateTimeAttribute( string $name, integer|array $value, boolean $utc = false ) : Zend_Ldap_Node

Appends to a LDAP date/time attribute.

This is an offline method.

Arguments
$name
string
$value
integerarray
$utc
boolean
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

attachLdap
jump to class

attachLdap( Zend_Ldap $ldap ) : Zend_Ldap_Node

Attach node to an LDAP connection

This is an offline method.

Arguments
$ldap
Zend_Ldap
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws
uses
Zend_Ldap_Dn::isChildOf()

countChildren
jump to class

countChildren( ) : integer

Count children of current node.

This is an online method.

Output
integer
Details
visibility
public
final
false
static
false
throws

countSubtree
jump to class

countSubtree( string|Zend_Ldap_Filter_Abstract $filter, integer $scope = Zend_Ldap ) : integer

Count items in current subtree found by given filter.

This is an online method.

Arguments
$filter
stringZend_Ldap_Filter_Abstract
$scope
integer
Output
integer
Details
visibility
public
final
false
static
false
throws

create
jump to class

create( string|array|Zend_Ldap_Dn $dn, array $objectClass = array ) : Zend_Ldap_Node

Factory method to create a new detached Zend_Ldap_Node for a given DN.

Arguments
$dn
stringarrayZend_Ldap_Dn
$objectClass
array
Output
Zend_Ldap_Node
Details
visibility
public
final
false
static
true
throws

current
jump to class

current( ) : array

Return the current attribute.

Implements Iterator

Output
array
Details
visibility
public
final
false
static
false

delete
jump to class

delete( ) : Zend_Ldap_Node

Marks this node as to be deleted

Node will be deleted on calling update() if $delete is true.

Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false

deleteAttribute
jump to class

deleteAttribute( string $name ) : Zend_Ldap_Node

Deletes a LDAP attribute.

This method deletes the attribute.

This is an offline method.

Arguments
$name
string
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

detachLdap
jump to class

detachLdap( ) : Zend_Ldap_Node

Detach node from LDAP connection

This is an offline method.

Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false

exists
jump to class

exists( Zend_Ldap $ldap = null ) : boolean

Check if node exists on LDAP.

This is an online method.

Arguments
$ldap
Zend_Ldap
Output
boolean
Details
visibility
public
final
false
static
false
throws

fromArray
jump to class

fromArray( array $data, boolean $fromDataSource = false ) : Zend_Ldap_Node

Factory method to create a detached Zend_Ldap_Node from array data.

Arguments
$data
array
$fromDataSource
boolean
Output
Zend_Ldap_Node
Details
visibility
public
final
false
static
true
throws

fromLdap
jump to class

fromLdap( string|array|Zend_Ldap_Dn $dn, Zend_Ldap $ldap ) : Zend_Ldap_Node|null

Factory method to create an attached Zend_Ldap_Node for a given DN.

Arguments
$dn
stringarrayZend_Ldap_Dn
$ldap
Zend_Ldap
Output
Zend_Ldap_Node|null
Details
visibility
public
final
false
static
true
throws

getChangedData
jump to class

getChangedData( ) : array

Gets changed node data.

The array contains all changed attributes. This format can be used in {@link Zend_Ldap::add()} and {@link Zend_Ldap::update()}.

This is an offline method.

Output
array
Details
visibility
public
final
false
static
false

getChanges
jump to class

getChanges( ) : array

Returns all changes made.

This is an offline method.

Output
array
Details
visibility
public
final
false
static
false

getChildren
jump to class

getChildren( ) : Zend_Ldap_Node_ChildrenIterator

Returns the children for the current node.

Can be used offline but returns an empty array if children have not been retrieved yet.

Output
Zend_Ldap_Node_ChildrenIterator
Details
visibility
public
final
false
static
false
throws

getCurrentDn
jump to class

getCurrentDn( ) : Zend_Ldap_Dn

Gets the current 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

getLdap
jump to class

getLdap( ) : Zend_Ldap

Gets the current LDAP connection.

Output
Zend_Ldap
Details
visibility
public
final
false
static
false
throws

getParent
jump to class

getParent( Zend_Ldap $ldap = null ) : Zend_Ldap_Node

Returns the parent of the current node.

Arguments
$ldap
Zend_Ldap
Output
Zend_Ldap_Node
Details
visibility
public
final
false
static
false
throws

hasChildren
jump to class

hasChildren( ) : boolean

Checks if current node has children.

Returns whether the current element has children.

Can be used offline but returns false if children have not been retrieved yet.

Output
boolean
Details
visibility
public
final
false
static
false
throws

isAttached
jump to class

isAttached( ) : boolean

Checks if the current node is attached to a LDAP server.

This is an offline method.

Output
boolean
Details
visibility
public
final
false
static
false

isNew
jump to class

isNew( ) : boolean

Tells if the node is consiedered as new (not present on the server)

Please note, that this doesn't tell you if the node is present on the server. Use {@link exits()} to see if a node is already there.

Output
boolean
Details
visibility
public
final
false
static
false

key
jump to class

key( ) : string

Return the attribute name.

Implements Iterator

Output
string
Details
visibility
public
final
false
static
false

move
jump to class

move( Zend_Ldap_Dn|string|array $newDn ) : Zend_Ldap_Node

{@see setDn()}

This is an offline method.

Arguments
$newDn
Zend_Ldap_Dnstringarray
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

next
jump to class

next( ) :

Move forward to next attribute.

Implements Iterator

Details
visibility
public
final
false
static
false

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

Reload node attributes from LDAP.

This is an online method.

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

removeDuplicatesFromAttribute
jump to class

removeDuplicatesFromAttribute( string $attribName ) : void

Removes duplicate values from a LDAP attribute

Arguments
$attribName
string
Details
visibility
public
final
false
static
false

removeFromAttribute
jump to class

removeFromAttribute( string $attribName, mixed|array $value ) : void

Remove given values from a LDAP attribute

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

rename
jump to class

rename( Zend_Ldap_Dn|string|array $newDn ) : Zend_Ldap_Node

{@see setDn()}

This is an offline method.

Arguments
$newDn
Zend_Ldap_Dnstringarray
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

rewind
jump to class

rewind( ) :

Rewind the Iterator to the first attribute.

Implements Iterator

Details
visibility
public
final
false
static
false

searchChildren
jump to class

searchChildren( string|Zend_Ldap_Filter_Abstract $filter, string $sort = null ) : Zend_Ldap_Node_Collection

Gets children of current node.

This is an online method.

Arguments
$filter
stringZend_Ldap_Filter_Abstract
$sort
string
Output
Zend_Ldap_Node_Collection
Details
visibility
public
final
false
static
false
throws

searchSubtree
jump to class

searchSubtree( string|Zend_Ldap_Filter_Abstract $filter, integer $scope = Zend_Ldap, string $sort = null ) : Zend_Ldap_Node_Collection

Search current subtree with given options.

This is an online method.

Arguments
$filter
stringZend_Ldap_Filter_Abstract
$scope
integer
$sort
string
Output
Zend_Ldap_Node_Collection
Details
visibility
public
final
false
static
false
throws

setAttribute
jump to class

setAttribute( string $name, mixed $value ) : Zend_Ldap_Node

Sets a LDAP attribute.

This is an offline method.

Arguments
$name
string
$value
mixed
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

setDateTimeAttribute
jump to class

setDateTimeAttribute( string $name, integer|array $value, boolean $utc = false ) : Zend_Ldap_Node

Sets a LDAP date/time attribute.

This is an offline method.

Arguments
$name
string
$value
integerarray
$utc
boolean
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

setDn
jump to class

setDn( Zend_Ldap_Dn|string|array $newDn ) : Zend_Ldap_Node

Sets the new DN for this node

This is an offline method.

Arguments
$newDn
Zend_Ldap_Dnstringarray
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

setObjectClass
jump to class

setObjectClass( array|string $value ) : Zend_Ldap_Node

Sets the objectClass.

This is an offline method.

Arguments
$value
arraystring
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

setPasswordAttribute
jump to class

setPasswordAttribute( string $password, string $hashType = Zend_Ldap_Attribute, string $attribName = userPassword ) : Zend_Ldap_Node

Sets a LDAP password.

Arguments
$password
string
$hashType
string
$attribName
string
Output
Zend_Ldap_Node
Provides a fluid interface
Details
visibility
public
final
false
static
false
throws

toLdif
jump to class

toLdif( array $options = array ) : string

Returns a LDIF representation of the current node

Arguments
$options
array
Additional options used during encoding
Output
string
Details
visibility
public
final
false
static
false

update
jump to class

update( Zend_Ldap $ldap = null ) : Zend_Ldap_Node

Sends all pending changes to the LDAP server

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

valid
jump to class

valid( ) : boolean

Check if there is a current attribute after calls to rewind() or next().

Implements Iterator

Output
boolean
Details
visibility
public
final
false
static
false

willBeDeleted
jump to class

willBeDeleted( ) : boolean

Is this node going to be deleted once update() is called?

Output
boolean
Details
visibility
public
final
false
static
false

willBeMoved
jump to class

willBeMoved( ) : boolean

Is this node going to be moved once update() is called?

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