templates/3rdParty/pla/lib/Tree.php

Properties

Description

Classes and functions for the LDAP tree.

Classes

Tree

Properties

 
 
Tree  
Yes 
No 

Description

Abstract class which represents the LDAP tree view ; the draw() method must be implemented by subclasses

Methods

__construct, addEntry, delEntry, draw, getBaseEntries, getEntry, getInstance, getServer, getServerID, indexDN, readChildren, readChildrenNumber, renameEntry,

__construct(   $server_id, ) : n/a

Arguments

Name Type Description Default
$server_id n/a

Return value

Type Description
n/a n/a

addEntry( string   $dn, ) : n/a

Description

Add an entry in the tree view ; the entry is added in the children array of its parent

Arguments

Name Type Description Default
$dn string

the dn of the entry to create

Return value

Type Description
n/a n/a

delEntry(   $dn, ) : n/a

Description

Delete an entry from the tree view ; the entry is deleted from the children array of its parent

Arguments

Name Type Description Default
$dn n/a

Return value

Type Description
n/a n/a

draw( ) : n/a

Description

Displays the LDAP tree

Return value

Type Description
n/a n/a

getBaseEntries( ) : array

Description

Get the entries that are BaseDN entries.

Return value

Type Description
array Base DN entries

getEntry(   $dn, ) : object

Description

Get a tree entry

Arguments

Name Type Description Default
$dn n/a

Return value

Type Description
object Tree DN object

getInstance(   $server_id, ) : object

Description

Create an instance of the tree - this is used when we call this class directly Tree::getInstance($index)

Arguments

Name Type Description Default
$server_id n/a

Return value

Type Description
object Tree

getServer( ) : object

Description

Get the server Object for this tree

Return value

Type Description
object Server Object for this tree

getServerID( ) : int

Description

Get the Server ID for this tree

Return value

Type Description
int Server ID that this tree is for

indexDN(   $dn, ) : \dn

Description

This function will take the DN, convert it to lowercase and strip unnessary commas. This result will be used as the index for the tree object.
Any display of a DN should use the object->dn entry, not the index. The reason we need to do this is because: uid=User A,ou=People,c=AU and uid=User B, ou=PeOpLe, c=au are infact in the same branch, but PLA will show them inconsistently.

Arguments

Name Type Description Default
$dn n/a

Return value

Type Description
\dn Lowercase clean DN

readChildren(   $dn,   $nolimit = false, ) : n/a

Description

Read the children of a tree entry

Arguments

Name Type Description Default
$dn n/a
$nolimit n/a false

Return value

Type Description
n/a n/a

readChildrenNumber(   $dn,   $nolimit = false, ) : n/a

Description

Return the number of children an entry has. Optionally autoread the child entry.

Arguments

Name Type Description Default
$dn n/a
$nolimit n/a false

Return value

Type Description
n/a n/a

renameEntry(   $dnOLD,   $dnNEW, ) : n/a

Description

Rename an entry in the tree

Arguments

Name Type Description Default
$dnOLD n/a
$dnNEW n/a

Return value

Type Description
n/a n/a

Properties

$entries, $server_id,

  protected  $entries = array()




  private  $server_id = null




Documentation was generated by phpDocumentor 2.1.0 .

Namespaces

  • global

    Packages