FusionDirectory
Public Member Functions | Protected Member Functions
management Class Reference

Management base class. More...

Inheritance diagram for management:
Inheritance graph
[legend]

Public Member Functions

 registerAction (Action $action)
 Register an action to show in the action menu and/or the action column.
 
 detectPostActions ()
 Detects actions/events send by the ui and the corresponding targets.
 
 handleAction (array $action)
 Calls the registered method for a given action/event.
 
 readPost ()
 Interpret POST content.
 
 update ()
 Update state and return FALSE if the dialog was closed.
 
 render ()
 Render the dialog and returns the HTML code.
 
 removeLocks ()
 Removes ldap object locks created by this class. Whenever an object is edited, we create locks to avoid concurrent modifications. This locks will automatically removed here.
 
 closeDialogs ()
 This method closes dialogs and cleans up the cached object info and the ui.
 
 newEntry (array $action)
 This method intiates the object creation. More...
 
 archiveRequested (array $action)
 Queue selected objects to be archived. Checks Locks and ask for confirmation.
 
 editEntry (array $action)
 This method opens an existing object to be edited. More...
 
 cancelEdit ()
 Editing an object was canceled. Close dialogs/tabs and remove locks.
 
 saveChanges ()
 Save object modifications and closes dialogs (returns to object listing). More...
 
 applyChanges ()
 Save object modifications and keep dialogs opened.
 
 removeRequested (array $action)
 Queue selected objects to be removed. Checks ACLs, Locks and ask for confirmation.
 
 removeConfirmed (array $action)
 Deletion was confirmed, delete the objects queued. Checks ACLs just in case.
 
 copyPasteHandler (array $action=['action'=> ''])
 This method is used to queue and process copy&paste actions. Allows to copy, cut and paste mutliple entries at once.
 
 createSnapshotDialog (array $action)
 Opens the snapshot creation dialog for the given target.
 
 restoreSnapshotDialog (array $action)
 Displays the "Restore snapshot dialog" for a given target. If no target is specified, open the restore removed object dialog.
 
 getAllDeletedSnapshots ()
 Get all deleted snapshots.
 
 createSnapshot (string $dn, string $description, string $snapshotSource='FD')
 Creates a new snapshot entry If source arg is not set, default to 'FD'.
 
 restoreSnapshot (string $dn)
 Restores a snapshot object. More...
 
 removeSnapshot (string $dn)
 Delete a snapshot. More...
 

Protected Member Functions

 execute ()
 Execute this plugin Handle actions/events, locking, snapshots, dialogs, tabs,...
 
 getHeader ()
 Sets smarty headline and returns the plugin header which is displayed whenever a tab object is opened.
 
 showTabFooter ()
 Whether footer buttons should appear.
 
 getTabFooter ()
 Generates the footer which is used whenever a tab object is displayed.
 
 removeConfirmationDialog (array $objects)
 Display confirmation dialog.
 

Detailed Description

Management base class.

Definition at line 25 of file class_management.inc.

Constructor & Destructor Documentation

◆ __construct()

static __construct (   $objectTypes = FALSE,
array  $filterElementDefinitions = [ ['TabFilterElement',
[] ]  ,
 
)
attribute

Definition at line 92 of file class_management.inc.

Member Function Documentation

◆ editEntry()

editEntry ( array  $action)

This method opens an existing object to be edited.

Parameters
array$actionA combination of both 'action' and 'targets': action: The name of the action which was the used as trigger. targets: A list of object dns, which should be affected by this method.

Definition at line 934 of file class_management.inc.

References Lock\add(), logging\debug(), Lock\genLockedMessage(), Lock\get(), and objects\open().

◆ newEntry()

newEntry ( array  $action)

This method intiates the object creation.

Parameters
array$actionA combination of both 'action' and 'target': action: The name of the action which was the used as trigger. target: A list of object dns, which should be affected by this method.

Definition at line 755 of file class_management.inc.

References logging\debug().

◆ removeSnapshot()

removeSnapshot ( string  $dn)

Delete a snapshot.

Parameters
string$dnDN of the snapshot

Definition at line 1382 of file class_management.inc.

References logging\debug().

◆ restoreSnapshot()

restoreSnapshot ( string  $dn)

Restores a snapshot object.

Parameters
String$dnThe DN of the snapshot

Definition at line 1354 of file class_management.inc.

References logging\debug().

◆ saveChanges()

saveChanges ( )

Save object modifications and closes dialogs (returns to object listing).

  • Calls 'simpleTabs::save' to save back object modifications (e.g. to ldap).
  • Calls 'management::closeDialogs' to return to the object listing.

Definition at line 987 of file class_management.inc.

References logging\debug().


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