FusionDirectory
 All Data Structures Files Functions Variables
Public Member Functions | Protected Member Functions
listing Class Reference

This class contains all the function needed to make the list that show the objects inside FusionDirectory. More...

Public Member Functions

 __construct ($data)
 Create a listing. More...
 
 setCopyPasteHandler ($handler)
 Set a CopyPasteHandler. More...
 
 setHeight ($height)
 Set the height. More...
 
 setSnapshotHandler ($handler)
 Set a SnapshotHandler. More...
 
 setFilter ($filter)
 Set a filter. More...
 
 registerElementFilter ($name, $call)
 Save element from a filter. More...
 
 load ($data)
 Load a file. More...
 
 render ()
 Render.
 
 update ()
 Update a listing.
 
 setBase ($base)
 Set a new base valor. More...
 
 getBase ()
 Accessor of the base. More...
 
 parseLayout ($layout)
 Parse a layout. More...
 
 getObjectType ($dn, $attrs)
 Get the object type. More...
 
 getDepartmentType ($dn, $attrs)
 Get the department type.
 
 filterObjectType ($row, $dn)
 Icon of the object type. More...
 
 filterDepartmentType ($row, $dn)
 Icon of the department type. More...
 
 filterActions ($dn, $row, $classes)
 Filter actions. More...
 
 filterDepartmentLink ($row, $dn, $description)
 Filter the department link. More...
 
 filterNameLink ($row, $dn)
 Filter link with object name.
 
 filterLink ()
 Filter link.
 
 getAction ()
 Get action.
 
 hasActionPermission (&$action, $dn, $row=NULL)
 Check if user have action permission. More...
 
 refreshBasesList ()
 Refresh the bases list.
 
 getDepartments ()
 Get the departments.
 
 getEntries ()
 Get listing entries.
 
 getType ($dn)
 Get type. More...
 

Protected Member Functions

 genericGetType ($dn, $attrs, $types)
 Get the object or department type.
 
 filterGenericType ($dn, $types, $type)
 Generic method for department and objects once type is known.
 

Detailed Description

This class contains all the function needed to make the list that show the objects inside FusionDirectory.

Definition at line 31 of file class_listing.inc.

Constructor & Destructor Documentation

__construct (   $data)

Create a listing.

Parameters
string$dataeither a filename or an array representation of the XML

Definition at line 72 of file class_listing.inc.

References session\global_get(), load(), refreshBasesList(), and registerElementFilter().

Member Function Documentation

filterActions (   $dn,
  $row,
  $classes 
)

Filter actions.

Parameters
string$dnThe DN
string$row
string$classes

Definition at line 985 of file class_listing.inc.

References hasActionPermission().

filterDepartmentLink (   $row,
  $dn,
  $description 
)

Filter the department link.

Parameters
string$row
string$dnThe DN
array$description

Definition at line 1084 of file class_listing.inc.

filterDepartmentType (   $row,
  $dn 
)

Icon of the department type.

Parameters
string$rowThe row
string$dnThe DN

Definition at line 971 of file class_listing.inc.

References filterGenericType(), and getDepartmentType().

filterObjectType (   $row,
  $dn 
)

Icon of the object type.

Parameters
string$rowThe row
string$dnThe DN

Definition at line 941 of file class_listing.inc.

References filterGenericType(), and getObjectType().

getBase ( )

Accessor of the base.

Returns
the base

Definition at line 676 of file class_listing.inc.

getObjectType (   $dn,
  $attrs 
)

Get the object type.

Parameters
string$classes

Definition at line 865 of file class_listing.inc.

References genericGetType().

Referenced by filterObjectType().

getType (   $dn)

Get type.

Parameters
string$dnThe DN

Definition at line 1820 of file class_listing.inc.

hasActionPermission ( $action,
  $dn,
  $row = NULL 
)

Check if user have action permission.

Parameters
string$action
string$dnThe DN
string$row

Definition at line 1432 of file class_listing.inc.

Referenced by filterActions().

load (   $data)

Load a file.

Parameters
string$dataeither a filename or an array representation of the XML

Definition at line 201 of file class_listing.inc.

References parseLayout(), and xml\xml2array().

Referenced by __construct().

parseLayout (   $layout)

Parse a layout.

Parameters
string$layout

Definition at line 686 of file class_listing.inc.

Referenced by load().

registerElementFilter (   $name,
  $call 
)

Save element from a filter.

Parameters
string$name
string$call

Definition at line 186 of file class_listing.inc.

Referenced by __construct().

setBase (   $base)

Set a new base valor.

Parameters
string$base

Definition at line 653 of file class_listing.inc.

References baseSelector\setBase().

Referenced by getAction(), and update().

setCopyPasteHandler (   $handler)

Set a CopyPasteHandler.

Parameters
$handlerThe handler
See also
CopyPasteHandler

Definition at line 131 of file class_listing.inc.

setFilter (   $filter)

Set a filter.

Parameters
string$filter
See also
filter

Definition at line 169 of file class_listing.inc.

References getDepartments(), and filter\setBase().

setHeight (   $height)

Set the height.

Parameters
integer$height

Definition at line 141 of file class_listing.inc.

setSnapshotHandler (   $handler)

Set a SnapshotHandler.

Parameters
$handlerThe handler
See also
SnapshotHandler

Definition at line 153 of file class_listing.inc.


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