nyroFwk  0.2
Public Member Functions | Protected Member Functions | Protected Attributes
module_scaffold_controller Class Reference
Inheritance diagram for module_scaffold_controller:
module_abstract object

Public Member Functions

 exec (array $prm=array())
 
 callbackTpl (array $prm)
 
 getResponse ()
 
 publish (array $prm=array())
 
 getName ()
 
 getAttr ($name)
 
 setAttr ($name, $value)
 
 getCfg ()
 

Protected Member Functions

 afterInit ()
 
 execIndex ($prm=null)
 
 execShow ($prm=null)
 
 execScaffoldIndex ($prm=null)
 
 isScaffolded ()
 
 execScaffoldList ($prm=null)
 
 updateFilterWhere (db_where $where=null)
 
 execScaffoldMultiple ()
 
 multipleDelete (array $ids)
 
 hook ($action)
 
 execScaffoldShow ($prm=null)
 
 execScaffoldAdd ($prm=null)
 
 execScaffoldDuplic ($prm=null)
 
 execScaffoldEdit ($prm=null)
 
 addEditForm ($action, $id=null)
 
 execScaffoldDelete ($prm=null)
 
 getFields ($action)
 
 beforeExec ($realExec)
 
 middleExec ($realExec)
 
 afterExec ($realExec)
 
 getViewAction ()
 
 setViewAction ($action)
 
 getViewVar ($name)
 
 setViewVar ($name, $value)
 
 setViewVars (array $values)
 
 preFetch ()
 
 isCacheEnabled ()
 
 addCacheTag ($val)
 
 beforeInit ()
 

Protected Attributes

 $table = null
 
 $row = null
 
 $filterTable
 
 $dataTable
 
 $form = null
 
 $cols
 
 $related
 
 $fields
 
 $indexPage
 
 $ids
 
 $prmExec
 
 $tpl
 
 $cfg
 

Detailed Description

Scaffold controller to dynamically create administration

Definition at line 10 of file nyro/module/scaffold/controller.class.php.

Member Function Documentation

◆ addCacheTag()

addCacheTag (   $val)
protectedinherited

Add a cache tag

Parameters
mixed$valThe tag to add

Definition at line 239 of file module/abstract.class.php.

◆ addEditForm()

addEditForm (   $action,
  $id = null 
)
protected

Definition at line 292 of file nyro/module/scaffold/controller.class.php.

◆ afterExec()

afterExec (   $realExec)
protectedinherited

Definition at line 146 of file module/abstract.class.php.

◆ afterInit()

afterInit ( )
protected

Definition at line 83 of file nyro/module/scaffold/controller.class.php.

◆ beforeExec()

beforeExec (   $realExec)
protectedinherited

Definition at line 136 of file module/abstract.class.php.

◆ beforeInit()

beforeInit ( )
protectedinherited

Call just before the configuration initialisation

Definition at line 35 of file object.class.php.

◆ callbackTpl()

callbackTpl ( array  $prm)
inherited

Definition at line 123 of file module/abstract.class.php.

◆ exec()

exec ( array  $prm = array())
finalinherited

Every called action must pass by this function

Parameters
null | string$prmActopn Parameters
Exceptions
nExceptionif wrong parameter or other errors

Definition at line 40 of file module/abstract.class.php.

◆ execIndex()

execIndex (   $prm = null)
protected

Definition at line 111 of file nyro/module/scaffold/controller.class.php.

◆ execScaffoldAdd()

execScaffoldAdd (   $prm = null)
protected

Definition at line 276 of file nyro/module/scaffold/controller.class.php.

◆ execScaffoldDelete()

execScaffoldDelete (   $prm = null)
protected

Definition at line 337 of file nyro/module/scaffold/controller.class.php.

◆ execScaffoldDuplic()

execScaffoldDuplic (   $prm = null)
protected

Definition at line 283 of file nyro/module/scaffold/controller.class.php.

◆ execScaffoldEdit()

execScaffoldEdit (   $prm = null)
protected

Definition at line 288 of file nyro/module/scaffold/controller.class.php.

◆ execScaffoldIndex()

execScaffoldIndex (   $prm = null)
protected

Definition at line 120 of file nyro/module/scaffold/controller.class.php.

◆ execScaffoldList()

execScaffoldList (   $prm = null)
protected

Definition at line 142 of file nyro/module/scaffold/controller.class.php.

◆ execScaffoldMultiple()

execScaffoldMultiple ( )
protected

Definition at line 207 of file nyro/module/scaffold/controller.class.php.

◆ execScaffoldShow()

execScaffoldShow (   $prm = null)
protected

Definition at line 256 of file nyro/module/scaffold/controller.class.php.

◆ execShow()

execShow (   $prm = null)
protected

Definition at line 116 of file nyro/module/scaffold/controller.class.php.

◆ getAttr()

getAttr (   $name)
inherited

Get an attribute

Parameters
string$nameAttribute name
Returns
mixed|null The attribute or null if not set

Definition at line 48 of file object.class.php.

◆ getCfg()

getCfg ( )
inherited

Get the configuration object

Returns
config

Definition at line 67 of file object.class.php.

◆ getFields()

getFields (   $action)
protected

Get the Fields for a specific actions

Parameters
string$actionAction name (list, add, edit or show)
Returns
array

Definition at line 354 of file nyro/module/scaffold/controller.class.php.

◆ getName()

getName ( )
inherited

Get the module name

Returns
string

Definition at line 251 of file module/abstract.class.php.

◆ getResponse()

getResponse ( )
inherited

Definition at line 129 of file module/abstract.class.php.

◆ getViewAction()

getViewAction ( )
protectedinherited

Get the current view action

Returns
string

Definition at line 153 of file module/abstract.class.php.

◆ getViewVar()

getViewVar (   $name)
protectedinherited

Get a variable for the view

Parameters
string$nameVariable name
Returns
mixed|null The value or null if not existing

Definition at line 176 of file module/abstract.class.php.

◆ hook()

hook (   $action)
protected

Function to be rewritten in eventual child to change the way the scaffold works Available actions:

  • list, listFilter
  • show, formShow
  • formInit, formInitAdd, formInitEdit
  • add, formPostAdd, beforeAdd, afterAdd, formAdd
  • edit, formPostEdit, beforeEdit, afterEdit, formEdit
  • delete, beforeDelete, afterDelete
  • beforeMultipleDelete, afterMultipleDelete, beforeMultiple*, afterMultiple*
Parameters
string$action

Definition at line 254 of file nyro/module/scaffold/controller.class.php.

◆ isCacheEnabled()

isCacheEnabled ( )
protectedinherited

Check against the configuration if the current request should be cached

Returns
bool True if enabled

Definition at line 225 of file module/abstract.class.php.

◆ isScaffolded()

isScaffolded ( )
protected

Definition at line 138 of file nyro/module/scaffold/controller.class.php.

◆ middleExec()

middleExec (   $realExec)
protectedinherited

Definition at line 141 of file module/abstract.class.php.

◆ multipleDelete()

multipleDelete ( array  $ids)
protected

Multiple delete action

Parameters
array$ids

Definition at line 232 of file nyro/module/scaffold/controller.class.php.

◆ preFetch()

preFetch ( )
protectedinherited

Function called just before fetching the TPL. This is useful to add cacheTag or change tpl properties

Definition at line 218 of file module/abstract.class.php.

◆ publish()

publish ( array  $prm = array())
inherited

Publish the module to shown

Returns
string The fetched view

Definition at line 204 of file module/abstract.class.php.

◆ setAttr()

setAttr (   $name,
  $value 
)
inherited

Set an attribute

Parameters
string$nameAttribute name
mixed$valueAttribute value

Definition at line 58 of file object.class.php.

◆ setViewAction()

setViewAction (   $action)
protectedinherited

Set the action which will use for the view

Parameters
string$action

Definition at line 162 of file module/abstract.class.php.

◆ setViewVar()

setViewVar (   $name,
  $value 
)
protectedinherited

Add a variable to the view

Parameters
string$nameVariable name
mixed$value

Definition at line 186 of file module/abstract.class.php.

◆ setViewVars()

setViewVars ( array  $values)
protectedinherited

Add variables to the view with an array

Parameters
array$values

Definition at line 195 of file module/abstract.class.php.

◆ updateFilterWhere()

updateFilterWhere ( db_where  $where = null)
protected

Definition at line 203 of file nyro/module/scaffold/controller.class.php.

Field Documentation

◆ $cfg

$cfg
protectedinherited

Definition at line 17 of file object.class.php.

◆ $cols

$cols
protected

Definition at line 52 of file nyro/module/scaffold/controller.class.php.

◆ $dataTable

$dataTable
protected

Definition at line 38 of file nyro/module/scaffold/controller.class.php.

◆ $fields

$fields
protected

Definition at line 67 of file nyro/module/scaffold/controller.class.php.

◆ $filterTable

$filterTable
protected

Definition at line 31 of file nyro/module/scaffold/controller.class.php.

◆ $form

$form = null
protected

Definition at line 45 of file nyro/module/scaffold/controller.class.php.

◆ $ids

$ids
protected

Definition at line 81 of file nyro/module/scaffold/controller.class.php.

◆ $indexPage

$indexPage
protected

Definition at line 74 of file nyro/module/scaffold/controller.class.php.

◆ $prmExec

$prmExec
protectedinherited

Definition at line 17 of file module/abstract.class.php.

◆ $related

$related
protected

Definition at line 59 of file nyro/module/scaffold/controller.class.php.

◆ $row

$row = null
protected

Definition at line 24 of file nyro/module/scaffold/controller.class.php.

◆ $table

$table = null
protected

Definition at line 17 of file nyro/module/scaffold/controller.class.php.

◆ $tpl

$tpl
protectedinherited

Definition at line 24 of file module/abstract.class.php.


The documentation for this class was generated from the following file:
Generated on Sun Oct 15 2017 22:25:21 for nyroFwk by doxygen 1.8.13