SecurityTreeListView Class Reference

Inheritance diagram for SecurityTreeListView:
MetadataView View GroupsTreeListView ProductCategoriesTreeListView RolesTreeListView GroupsModalTreeListView ProductCategoriesModalTreeListView RolesModalTreeListView SelectParentGroupModalTreeListView SelectParentCategoryModalTreeListView SelectParentRoleModalTreeListView

Public Member Functions

 __construct ($controllerId, $moduleId, $items)

Static Public Member Functions

static getDefaultMetadata ()

Protected Member Functions

 renderTreeMenu ($nodeRelationName, $nodesRelationName, $title)
 getModelRelationNameForUserCount ()
 renderTreeListView ($data)
 makeChildrenNodes ($items, $parentItem, $nodeRelationName, $isLink=true)
 resolveNodeWithChildrenItems (array $itemNodes, $parentItem)
 makeTreeMenuNodeLink ($label, $action, $id)
 makeTreeMenuNodeRoute ($action, $id)
 resolveIsNodeLinkableById ($id, $name)
 resolveUserCountForItem (Item $item)
 registerScripts ()

Static Protected Member Functions

static renderTreeListViewNode (&$content, $data, $indent)
static shouldRenderConfigureLink ()
static resolveIdFromRoute ($route)
static renderUserCount ($userCount, $route)
static resolveShouldShowLinkableUserCount ()
static resolveRouteAction ()

Protected Attributes

 $controllerId
 $moduleId
 $items

Detailed Description

View that renders a a security component in the form of a tree or noded list view.

Definition at line 41 of file SecurityTreeListView.php.


Constructor & Destructor Documentation

__construct ( controllerId,
moduleId,
items 
)
Parameters:
string $controllerId
string $moduleId
array $items

Definition at line 54 of file SecurityTreeListView.php.


Member Function Documentation

renderTreeMenu ( nodeRelationName,
nodesRelationName,
title 
) [protected]

Render Tree Menu.

Parameters:
nodeRelationName - parent relation name such as 'role' or 'group'
nodesRelationName - children relation name such as 'roles' or 'groups'
Returns:
string tree content

Definition at line 70 of file SecurityTreeListView.php.

makeChildrenNodes ( items,
parentItem,
nodeRelationName,
isLink = true 
) [protected]
Parameters:
$isLink - Currently if this gets set to true in this function then this is propogated downstream because makeChildrenNodes is used recursively.
See also:
renderTreeMenu
Returns:
CTreeView ready nodes array

Definition at line 149 of file SecurityTreeListView.php.

resolveNodeWithChildrenItems ( array $  itemNodes,
parentItem 
) [protected]

Override if you need to add additional items into the tree for each node. An example is roles, that show the list of users for each role.

Definition at line 192 of file SecurityTreeListView.php.

static getDefaultMetadata (  )  [static]

Returns default metadata for use in automatically generating the view.

Reimplemented from MetadataView.

Definition at line 208 of file SecurityTreeListView.php.

resolveIsNodeLinkableById ( id,
name 
) [protected]

Override if special logic is needed to control when a node is displayed as a link or not

Reimplemented in SelectParentCategoryModalTreeListView, SelectParentGroupModalTreeListView, and SelectParentRoleModalTreeListView.

Definition at line 220 of file SecurityTreeListView.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Jul 24 07:10:30 2017