Detailed Description
TreeController is used to visualize nodes in a tree view.
The controller supports the following actions:
Parameter | Description |
---|---|
in oid | The object id of the parent Node whose children should be loaded (optional) |
in sort | The attribute to sort the children by (optional) |
in rootTypes | Name of a configuration value in configuration section 'application', that defines an array of root types of the tree (optional, defaults to 'rootTypes') |
out list | An array of associative arrays with keys 'oid', 'displayText', 'isFolder', 'hasChildren' |
Response Actions | |
ok | In all cases |
Definition at line 43 of file TreeController.php.
Protected Member Functions | |
doExecute () | |
getChildren ($oid) | |
getRootOIDs () | |
getViewNode (Node $node, $displayText='') | |
isVisible (Node $node) | |
getDisplayText (Node $node) | |
getRootTypes () | |
isRootTypeNode (ObjectId $oid) | |
Protected Member Functions inherited from Controller | |
validate () | |
executeSubAction ($action) | |
getLogger () | |
getSession () | |
getPersistenceFacade () | |
getPermissionManager () | |
getActionMapper () | |
getLocalization () | |
getMessage () | |
getConfiguration () | |
assignResponseDefaults () | |
isLocalizedRequest () | |
checkLanguageParameter () | |
Additional Inherited Members | |
Public Member Functions inherited from Controller | |
__construct (Session $session, PersistenceFacade $persistenceFacade, PermissionManager $permissionManager, ActionMapper $actionMapper, Localization $localization, Message $message, Configuration $configuration) | |
initialize (Request $request, Response $response) | |
execute ($method=null) | |
getRequest () | |
getResponse () | |
Member Function Documentation
|
protected |
- See also
- Controller::doExecute()
Definition at line 48 of file TreeController.php.
|
protected |
Get the children for a given oid.
- Parameters
-
$oid The object id
- Returns
- Array of Node instances.
Definition at line 89 of file TreeController.php.
|
protected |
Get the oids of the root nodes.
- Returns
- An array of object ids.
Definition at line 130 of file TreeController.php.
|
protected |
Get the view of a Node.
- Parameters
-
$node The Node to create the view for $displayText The text to display (will be taken from TreeController::getDisplayText() if not specified) (default: '')
- Returns
- An associative array whose keys correspond to Ext.tree.TreeNode config parameters
Definition at line 141 of file TreeController.php.
|
protected |
Test if a Node should be displayed in the tree.
- Parameters
-
$node Node to display
- Returns
- Boolean
Definition at line 164 of file TreeController.php.
|
protected |
Get the display text for a Node.
- Parameters
-
$node Node to display
- Returns
- The display text.
Definition at line 173 of file TreeController.php.
|
protected |
Get all root types.
- Returns
- Array of Node instances
Definition at line 187 of file TreeController.php.
|
protected |
Check if the given oid belongs to a root type node.
- Parameters
-
$oid The object id
- Returns
- Boolean
Definition at line 224 of file TreeController.php.