Controller/Action/Auto/Synctree.php

Classes 
package
Classes
Kwf_Controller_Action_Auto_Synctree

Description

This controller is used to display a tree structure.

The sync-prefix means that this controller loads all data at once, so children are always loaded.

\Kwf_Controller_Action_Auto_Synctree

Extends from
\Kwf_Controller_Action_Auto_Abstract
package
Constants
ADD_FIRST
ADD_LAST
Properties
$_addPosition
$_buttons
$_defaultOrder
$_editDialog
$_enableDD
$_filters
$_hasPosition
$_icons
$_model
$_modelName
$_parentField
$_primaryKey
$_rootParentValue
$_rootText
$_rootVisible
$_table
$_tableName
$_textField
Methods
_beforeDelete
_beforeSaveMove
_changeVisibility
_fetchData
_filterNodes
_formatNode
_formatNodes
_getParentId
_getQueryExpression
_getSelect
_getTreeWhere
_getWhere
_hasPermissions
_init
_saveNodeOpened
_saveSessionNodeOpened
indexAction
jsonAddAction
jsonCollapseAction
jsonDataAction
jsonDeleteAction
jsonExpandAction
jsonMetaAction
jsonMoveAction
jsonNodeDataAction
jsonVisibleAction
preDispatch
setTable

Description

This controller is used to display a tree structure.

The sync-prefix means that this controller loads all data at once, so children are always loaded.

Constants

ADD_LAST

 ADD_LAST = '0'

Details

value
0

ADD_FIRST

 ADD_FIRST = '1'

Details

value
1

Properties

$_addPosition

 $_addPosition = 'self'

Details

visibility
protected
default
self
final
false
static
false

$_buttons

 $_buttons = 'array'

Change this array to your needs.

remove an entry to remove the button. false to disable the button.

Details

visibility
protected
default
array
final
false
static
false

$_defaultOrder

 $_defaultOrder = ''

Details

visibility
protected
default
final
false
static
false

$_editDialog

 $_editDialog = ''

Use this field to set a controller to add/edit a single entry of this tree it should look like this: protected $_editDialog = array( 'controllerUrl' => 'url', ) The url should match the entry in Acl.php

Details

visibility
protected
default
final
false
static
false

$_enableDD

 $_enableDD = ''

Set this field to true to enable drag and drop for tree-items

Details

visibility
protected
default
final
false
static
false

$_filters

 $_filters = ''

Details

visibility
protected
default
final
false
static
false

$_hasPosition

 $_hasPosition = ''

Details

visibility
protected
default
final
false
static
false

$_icons

 $_icons = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_model

\Kwf_Model_Interface $_model = ''

Details

\Kwf_Model_Interface
visibility
protected
default
final
false
static
false

$_modelName

 $_modelName = ''

The model has needs to be a subclass of Kwf_Model_Tree

Details

visibility
protected
default
final
false
static
false

$_parentField

 $_parentField = 'parent_id'

Details

visibility
protected
default
parent_id
final
false
static
false

$_primaryKey

 $_primaryKey = ''

Details

visibility
protected
default
final
false
static
false

$_rootParentValue

 $_rootParentValue = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_rootText

 $_rootText = 'Root'

Details

visibility
protected
default
Root
final
false
static
false

$_rootVisible

 $_rootVisible = 'true'

Details

visibility
protected
default
true
final
false
static
false

$_table

 $_table = ''

Details

visibility
protected
default
final
false
static
false

$_tableName

 $_tableName = ''

Details

visibility
protected
default
final
false
static
false

$_textField

 $_textField = 'name'

Details

visibility
protected
default
name
final
false
static
false

Methods

_beforeDelete

_beforeDelete(  $row ) :
Arguments
$row
Details
visibility
protected
final
false
static
false

_beforeSaveMove

_beforeSaveMove(  $row ) :
Arguments
$row
Details
visibility
protected
final
false
static
false

_changeVisibility

_changeVisibility(  $row ) :
Arguments
$row
Details
visibility
protected
final
false
static
false

_fetchData

_fetchData(  $parentRow ) :
Arguments
$parentRow
Details
visibility
protected
final
false
static
false

_filterNodes

_filterNodes( ) :
Details
visibility
protected
final
false
static
false

_formatNode

_formatNode(  $row ) :
Arguments
$row
Details
visibility
protected
final
false
static
false

_formatNodes

_formatNodes(  $parentRow = null ) :
Arguments
$parentRow
Details
visibility
protected
final
false
static
false

_getParentId

_getParentId(  $row ) :
Arguments
$row
Details
visibility
protected
final
false
static
false

_getQueryExpression

_getQueryExpression(  $query ) :
Arguments
$query
Details
visibility
protected
final
false
static
false

_getSelect

_getSelect( ) :

override this method to handle the output of this view. Just return the select statement which serves your needs.

Details
visibility
protected
final
false
static
false

_getTreeWhere

_getTreeWhere(  $parentRow = null ) :

Arguments
$parentRow
Details
visibility
protected
final
false
static
false
deprecated

_getWhere

_getWhere( ) :

Details
visibility
protected
final
false
static
false
deprecated

_hasPermissions

_hasPermissions(  $row,  $action ) :
Arguments
$row
$action
Details
visibility
protected
final
false
static
false

_init

_init( ) :
Details
visibility
protected
final
false
static
false

_saveNodeOpened

_saveNodeOpened( ) :
Details
visibility
protected
final
false
static
false

_saveSessionNodeOpened

_saveSessionNodeOpened(  $id,  $activate ) :
Arguments
$id
$activate
Details
visibility
protected
final
false
static
false

indexAction

indexAction( ) :

This method is called when the url is requested without params and sub-paths

Details
visibility
public
final
false
static
false

jsonAddAction

jsonAddAction( ) :
Details
visibility
public
final
false
static
false

jsonCollapseAction

jsonCollapseAction( ) :
Details
visibility
public
final
false
static
false

jsonDataAction

jsonDataAction( ) :

This function is called when CONTROLLER_URL/json-data is called.

Details
visibility
public
final
false
static
false

jsonDeleteAction

jsonDeleteAction( ) :
Details
visibility
public
final
false
static
false

jsonExpandAction

jsonExpandAction( ) :
Details
visibility
public
final
false
static
false

jsonMetaAction

jsonMetaAction( ) :
Details
visibility
public
final
false
static
false

jsonMoveAction

jsonMoveAction( ) :
Details
visibility
public
final
false
static
false

jsonNodeDataAction

jsonNodeDataAction( ) :
Details
visibility
public
final
false
static
false

jsonVisibleAction

jsonVisibleAction( ) :
Details
visibility
public
final
false
static
false

preDispatch

preDispatch( ) :
Details
visibility
public
final
false
static
false

setTable

setTable(  $table ) :
Arguments
$table
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox 0.12.3.