wCMF  3.6
 All Classes Namespaces Files Functions Variables Groups Pages
TreeViewController Class Reference
+ Inheritance diagram for TreeViewController:

Public Member Functions

 hasView ()
 
 executeKernel ()
 
 getRootOIDs ()
 
 getChildren ($oid)
 
 getViewNode (&$node, $displayText='')
 
 isVisible (&$node)
 
 getDisplayText (&$node)
 
 getClickAction (&$node)
 
- Public Member Functions inherited from Controller
 Controller (&$delegate)
 
 initialize (&$request, &$response)
 
 validate ()
 
 hasView ()
 
 execute ()
 
 executeKernel ()
 
 getErrorMsg ()
 
 setErrorMsg ($msg)
 
 appendErrorMsg ($msg)
 
getRequest ()
 
getResponse ()
 
getView ()
 
getDelegate ()
 
 getViewTemplate ($controller, $context, $action)
 
 getCacheId ()
 
 assignViewDefaults (&$view)
 
 isLocalizedRequest ()
 

Additional Inherited Members

- Public Attributes inherited from Controller
 $_request = null
 
 $_response = null
 
 $_errorMsg = ''
 
 $_view = null
 
 $_delegate = null
 

Detailed Description

TreeViewController is used to visualize cms data in a tree view.

wCMF - wemove Content Management Framework Copyright (C) 2005-2014 wemove digital solutions GmbH

Licensed under the terms of any of the following licenses at your choice:

See the license.txt file distributed with this work for additional information.

Id:
class.TreeViewController.php 1462 2014-02-04 23:52:27Z iherwig

Input actions:

  • loadChilren Load the children of the given parent Node

Output actions:

  • ok In any case
Parameters
[in]nodeThe object id of the parent Node whose children should be loaded
[in]sortThe attribute to sort the children by
[out]objectsAn array of associative arrays with keys 'oid', 'text', 'onClickAction', 'hasChildren'
Author
ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 43 of file class.TreeViewController.php.

Member Function Documentation

TreeViewController::hasView ( )
TreeViewController::executeKernel ( )

Assign data to View.

Returns
Array of given context and action 'failure' on failure. False on success (Stop action processing chain). In case of 'failure' a detailed description is provided by getErrorMsg().
See Also
Controller::executeKernel()

Definition at line 64 of file class.TreeViewController.php.

References getChildren(), Localization\getInstance(), getViewNode(), Controller\isLocalizedRequest(), isVisible(), and Node\sort().

+ Here is the call graph for this function:

TreeViewController::getRootOIDs ( )

Get the OIDs of the root nodes. TreeViewController will build the complete resource tree from these.

Note
subclasses will override this to implement special application requirements.
Returns
An array of OIDs.

Definition at line 110 of file class.TreeViewController.php.

References PersistenceFacade\getInstance(), InifileParser\getInstance(), and Controller\setErrorMsg().

Referenced by getChildren().

+ Here is the call graph for this function:

TreeViewController::getChildren (   $oid)

Get the children for a given oid.

Note
subclasses will override this to implement special application requirements.
Returns
An array of Node instances.

Definition at line 134 of file class.TreeViewController.php.

References ACTION_READ, BUILDDEPTH_SINGLE, PersistenceFacade\getInstance(), RightsManager\getInstance(), getRootOIDs(), and PersistenceFacade\isValidOID().

Referenced by executeKernel().

+ Here is the call graph for this function:

TreeViewController::getViewNode ( $node,
  $displayText = '' 
)

Get the view of a Node

Parameters
nodeThe Node to create the view for
displayTextThe text to display (will be taken from TreeViewController::getDisplayText() if not specified) [default: '']
Returns
An associative array whose keys correspond to Ext.tree.TreeNode config parameters

Definition at line 170 of file class.TreeViewController.php.

References getClickAction(), and getDisplayText().

Referenced by executeKernel().

+ Here is the call graph for this function:

TreeViewController::isVisible ( $node)

Test if a Node should be displayed in the tree

Note
subclasses will override this to implement special application requirements.
Parameters
nodeA reference to the Node to display
Returns
True/false (the default implementation always returns true)

Definition at line 193 of file class.TreeViewController.php.

Referenced by executeKernel().

TreeViewController::getDisplayText ( $node)

Get the display text for a Node

Note
subclasses will override this to implement special application requirements.
Parameters
nodeA reference to the Node to display
Returns
The display text.

Definition at line 203 of file class.TreeViewController.php.

References NodeUtil\getDisplayValue().

Referenced by getViewNode().

+ Here is the call graph for this function:

TreeViewController::getClickAction ( $node)

Get the action to perform if a Node is clicked (The content of the anchor tag href attribute)

Note
subclasses will override this to implement special application requirements.
Parameters
nodeA reference to the Node
Returns
The action

Definition at line 213 of file class.TreeViewController.php.

Referenced by getViewNode().


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