objects Class Reference

Class for handling objects and their types. More...

Static Public Member Functions
static	ls ($types, $attrs=NULL, string $ou=NULL, string $filter='', bool $checkAcl=FALSE, string $scope='subtree', bool $templateSearch=FALSE, bool $sizeLimit=FALSE)
	Get list of object of objectTypes from $types in $ou. More...
static	count ($types, string $ou=NULL, string $filter='', bool $checkAcl=FALSE, bool $templateSearch=FALSE)
	Get count of objects of objectTypes from $types in $ou. More...
static	open (string $dn, string $type)
	Create the tab object for the given dn. More...
static	link (string $dn, string $type, string $subaction='', $text=NULL, bool $icon=TRUE, bool $link=TRUE)

Detailed Description

Class for handling objects and their types.

Allows to list, open, create and delete objects

Definition at line 27 of file class_objects.inc.

Member Function Documentation

count()

static count (   $types, string  $ou = NULL, string  $filter = '', bool  $checkAcl = FALSE, bool  $templateSearch = FALSE  )

static

Get count of objects of objectTypes from $types in $ou.

Parameters

array	$types	the objectTypes to list
string	$ou	the LDAP branch to search in, base will be used if it is NULL
string	$filter	an additional filter to use in the LDAP search.
boolean	$checkAcl	Should ACL be checked on the filtered attributes.

Returns

The number of objects of type $type in $ou

Definition at line 227 of file class_objects.inc.

Referenced by ls().

link()

static link ( string  $dn, string  $type, string  $subaction = '',   $text = NULL, bool  $icon = TRUE, bool  $link = TRUE  )

static

Parameters

string | array | null

$text

Definition at line 356 of file class_objects.inc.

References logging\debug(), and htmlescape().

ls()

static ls (   $types,   $attrs = NULL, string  $ou = NULL, string  $filter = '', bool  $checkAcl = FALSE, string  $scope = 'subtree', bool  $templateSearch = FALSE, bool  $sizeLimit = FALSE  )

static

Get list of object of objectTypes from $types in $ou.

Parameters

array	$types	the objectTypes to list
mixed	$attrs	The attributes to fetch. If this is a single value, the resulting associative array will have for each dn the value of this attribute. If this is an array, the keys must be the wanted attributes, and the values can be either 1, '*', 'b64' or 'raw' depending if you want a single value or an array of values. 'raw' means untouched LDAP value and is only useful for dns. Other values are considered to be 1. 'b64' means an array of base64 encoded values and is mainly useful through webservice for binary attributes.
string	$ou	the LDAP branch to search in, base will be used if it is NULL
string	$filter	an additional filter to use in the LDAP search. (Might use special _template_cn field to search in template cn).
boolean	$checkAcl	should ACL be ignored or checked? Defaults to FALSE.
string	$scope	scope, defaults to subtree. When using one, be careful what you put in $ou.
boolean	$templateSearch	Whether to search for templates or normal objects.

Returns

The list of objects as an associative array (keys are dns)

Definition at line 46 of file class_objects.inc.

References count().

open()

static open ( string  $dn, string  $type  )

static

Create the tab object for the given dn.

Parameters

string	$type	the objectType to open
string	$dn	the dn to open

Returns

The created tab object

Definition at line 342 of file class_objects.inc.

References logging\debug().

Referenced by change_password(), management\editEntry(), templateHandling\listFields(), template\reset(), config\set_current(), and passwordMethod\unlock_account().

---

The documentation for this class was generated from the following file:

• include/class_objects.inc