templates/3rdParty/pla/lib/TreeItem.php
Properties
Description
Classes and functions for the LDAP tree.
Classes
TreeItem
Properties
No
No
Description
Represents an item in the tree.
Methods
__construct,
addChild,
childSorted,
close,
delChild,
getChildren,
getDN,
getDNEncode,
getIcon,
getObjectClasses,
getRDN,
getTemplate,
isBaseDN,
isChildSorted,
isInLDAP,
isLeaf,
isOpened,
isSizeLimited,
open,
readingChildren,
rename,
setBase,
setLeaf,
setObjectClasses,
setSizeLimited,
setTemplate,
unsetSizeLimited,
__construct(
$server_id,
$dn,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$server_id |
n/a |
|
|
$dn |
n/a |
|
|
Return value
addChild(
$dn,
)
:
n/a
Description
Add a child to this DN entry.Arguments
Name |
Type |
Description |
Default |
$dn |
n/a |
|
|
Return value
childSorted(
)
:
n/a
Description
Mark the children as sortedReturn value
close(
)
:
n/a
Description
Mark this node as closed.Return value
delChild(
$dn,
)
:
n/a
Description
Delete a child from this DN entry.Arguments
Name |
Type |
Description |
Default |
$dn |
n/a |
|
|
Return value
getChildren(
)
:
n/a
Description
Returns null if the children have never be defined
or an array of the dn of the childrenReturn value
getDN(
)
:
\DN
Description
Get the DN of this tree item.Return value
Type |
Description |
\DN |
The DN of this item. |
getDNEncode(
)
:
n/a
Return value
getIcon(
)
:
n/a
Description
Returns the path of the icon file used to represent this node ;
If the icon hasnt been set, it will call get_icon()Return value
getObjectClasses(
)
:
n/a
Return value
getRDN(
)
:
\RDN
Description
Get the RDN of this tree items DN.Return value
Type |
Description |
\RDN |
The RDN of this items DN. |
getTemplate(
)
:
n/a
Return value
isBaseDN(
)
:
n/a
Description
Return if this item is a base DN item.Return value
isChildSorted(
)
:
n/a
Description
Do the children require resortingReturn value
isInLDAP(
)
:
n/a
Return value
isLeaf(
)
:
n/a
Description
Return if this node is a leaf.Return value
isOpened(
)
:
n/a
Description
Return if this item has been opened.Return value
isSizeLimited(
)
:
n/a
Description
Return if this node has hit an LDAP size limit (and thus doesnt have all its children).Return value
open(
)
:
n/a
Description
Opens the node ; the children of the node must have been definedReturn value
readingChildren(
$bool,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$bool |
n/a |
|
|
Return value
rename(
$dn,
)
:
n/a
Description
Rename this DN.Arguments
Name |
Type |
Description |
Default |
$dn |
n/a |
|
|
Return value
setBase(
)
:
n/a
Description
Set this item as a LDAP base DN item.Return value
setLeaf(
)
:
n/a
Description
Mark this node as a leaf.Return value
setObjectClasses(
$oc,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$oc |
n/a |
|
|
Return value
setSizeLimited(
)
:
n/a
Description
Mark this node as a size limited (it wont have all its children).Return value
setTemplate(
$template,
)
:
n/a
Arguments
Name |
Type |
Description |
Default |
$template |
n/a |
|
|
Return value
unsetSizeLimited(
)
:
n/a
Description
Clear the size limited flag.Return value
Properties
$base_entry,
$children,
$childsort,
$dn,
$icon,
$leaf,
$objectclasses,
$open,
$reading_children,
$server_id,
$size_limited,
$template,
private
$base_entry
=
false
private
$children
=
array()
private
$childsort
=
true
protected
$objectclasses
=
array()
private
$reading_children
=
false
private
$size_limited
=
true