Class AppController

Controller base class for backends+frontends

Controller

AppController

Direct known subclasses

AuthenticationsController, FilesController, FrontendController, HomeController, ModulesController, PagesController, StreamsController

Indirect known subclasses

AddressbookController, AdminController, NewsletterController, StatisticsController, TagsController, TranslationsController, UsersController, WebmarksController, ApiBaseController, AreasController, CommentsController, DocumentsController, EventsController, GalleriesController, MultimediaController, NewsController

Located at app_controller.php

Methods summary

`public`	# `__construct( )` Constructor If debugKit is enabled in configuration and it's found in plugins paths then add it to self::componenets array Constructor If debugKit is enabled in configuration and it's found in plugins paths then add it to self::componenets array
`public static`	# `currentController( )`
`public static`	# `usedUrl( )`
`public`	# `handleError( string $eventMsg, string $userMsg, string\|null $errTrace = null, array\|null $usrMsgParams = array() )` Handle error utility Handle error utility Parameters `$eventMsg` The event message `$userMsg` The user message `$errTrace` The error trace `$usrMsgParams` The user message parameters
`public`	# `setResult( $r )`
`protected`	# `initAttributes( )`
`protected`	# `beforeCheckLogin( )` convienience method to do operations before login check for example you could set AppController::skipCheck to true avoiding user session check convienience method to do operations before login check for example you could set AppController::skipCheck to true avoiding user session check
`protected`	# `startProfiler( )` Start profiler Start profiler
`protected`	# `stopProfiler( $save = true )` Stop profiler and save data Stop profiler and save data
`final public`	# `beforeFilter( )`
`protected`	# `setupLocale( )`
`final public`	# `beforeRender( )` Redirect and class method result. If form contains: $this->data['OK'] or $this->data['ERROR'] redirect to thes values (on OK, on ERROR) Redirect and class method result. If form contains: $this->data['OK'] or $this->data['ERROR'] redirect to thes values (on OK, on ERROR) If the class defines: $this->REDIRECT[]['OK'] or $this->REDIRECT[]['ERROR'] redirect to thes values (on OK, on ERROR) Otherwise no redirect
`private`	# `redirUrl( $url )`
`final public`	# `afterFilter( )`
`protected`	# `updateHistory( )`
`protected`	# `forward( $action, $outcome )`
`protected`	# `beditaBeforeFilter( )` local 'beforeFilter' (for backend or frontend) local 'beforeFilter' (for backend or frontend)
`protected`	# `beditaBeforeRender( )` local 'beforeRender' (for backend or frontend) local 'beforeRender' (for backend or frontend)
`protected`	# `beditaAfterFilter( )` local 'afterFilter' (for backend or frontend) local 'afterFilter' (for backend or frontend)
`protected`	# `eventLog( string $level, string $msg )` Event log creation Event log creation Parameters `$level` The log level `$msg` The message
`protected`	# `userErrorMessage( string $msg, $layout = 'message', $params = array('class' => 'error') )` User error message (will appear in messages div) User error message (will appear in messages div) Parameters `$msg` `$layout` `$params`
`protected`	# `userWarnMessage( string $msg, $layout = 'message', $params = array('class' => 'warn') )` User warning message (will appear in messages div) User warning message (will appear in messages div) Parameters `$msg` `$layout` `$params`
`protected`	# `userInfoMessage( string $msg, $layout = 'message', $params = array('class' => 'info') )` User info message (will appear in messages div) User info message (will appear in messages div) Parameters `$msg` `$layout` `$params`
`protected`	# `eventInfo( string $msg )` Info message in system event logs Info message in system event logs Parameters `$msg`
`protected`	# `eventWarn( string $msg )` Warning message in system event logs Warning message in system event logs Parameters `$msg`
`protected`	# `eventError( string $msg )` Error message in system event logs Error message in system event logs Parameters `$msg`
`protected`	# `checkLogin( )` Modules access: verify user permits. Uses BeAuth Component. Modules access: verify user permits. Uses BeAuth Component. Load the list of the modules availables for the user.
`protected`	# `setup_args( )` Function arguments setup. If variable is null, use $this->params[url]. Parameters: 0..N array: 0 var name 1 type [string] (for the function settype) 2 reference to the variable to modify Function arguments setup. If variable is null, use $this->params[url]. Parameters: 0..N array: 0 var name 1 type [string] (for the function settype) 2 reference to the variable to modify
`protected`	# `loadModelByObjectTypeId( $obj_type_id )`
`protected`	# `loadModelByType( $modelClass )`
`protected array`	# `modelBindings( Model $modelObj, string $level = 'default' )` set model bindings and return the array used set model bindings and return the array used Parameters `$modelObj` `$level` binding level as defined in Model::modelBindings array Returns array
`protected array`	# `setObjectBindings( string $modelType, string $level = 'frontend' )` set model bindings for BEdita object set model bindings for BEdita object Parameters `$modelType` model name of BE object `$level` model binding level Returns array that contains: "bindings_used" => multidimensional array of bindings used, "bindings_list" => one dimensional array with the simple list of bindings ordered using a "natural order" algorithm
`protected string`	# `objectTypeCache( integer $id )` Get object type (or model name) from object id using object cache Get object type (or model name) from object id using object cache Parameters `$id` Object id to search Returns string Object type (or model name) on success, false on failure
`protected integer`	# `objectTypeIdCache( integer $id )` Get object "type id" from object id using object cache Get object "type id" from object id using object cache Parameters `$id` Object id to search Returns integer Object "type id" on success, false on failure
`protected integer`	# `idFromNicknameCache( string $nickname )` Get object id from object nickname using object cache Get object id from object nickname using object cache Parameters `$nickname` Object nickname to search Returns integer Object id on success, false on failure
`public array`	# `objectRelationArray( array $objectArray, array $status = array(), array $options = array() )` Reorder content objects relations in array where keys are relation names Reorder content objects relations in array where keys are relation names Parameters `$objectArray` `$status` $status, default get all objects `$options` $options, possible values are 'mainLanguage' => set fields with "mainLanguage" value 'user' => in frontend app check frontend access that user Returns array
`protected array`	# `setupAnnotations( array & $objectArray, array $status = array() )` Setup object array with annotations-type details Setup object array with annotations-type details Parameters `$objectArray` `$status` $status, default get all objects Returns array
`protected`	# `checkObjectWritePermission( $objectId )`
`protected`	# `prepareRelationsToSave( )` Prepare `$this->data` with relations data checking if them are to unserialize. Prepare `$this->data` with relations data checking if them are to unserialize. If exits `$this->data['relations_serialized']` then unserialize it and put result in `$this->data['RelatedObject']` Throws `BeditaException` When are defined both `$this->data['relations_serialized']` and `$this->data['RelatedObject']`
`protected`	# `saveObject( BEAppModel $beModel, array $options = array() )`
`protected string`	# `deleteObjects( model $model )` Delete objects Delete objects Parameters `$model` name Returns string of objects'ids deleted
`protected`	# `viewRevision( BEAppModel $beModel, integer $id, integer $rev )` View revision data for a specific object and revision number: * all data as in revision in $revision array * array of changed fields in $diff View revision data for a specific object and revision number: * all data as in revision in $revision array * array of changed fields in $diff Parameters `$beModel` `$id` $id, object ud `$rev` $rev, revision number
`public`	# `setModelBindings( string $modelName, array $bindings )` Set model bindings. Set model bindings. Parameters `$modelName` `$bindings`
`public`	# `unsetModelBindings( string $modelName )` Restore model bindings. Restore model bindings. Parameters `$modelName`

Constants summary

`string`	`OK` Result types for methods Result types for methods	# `'OK'`
`string`	`ERROR`	# `'ERROR'`
`string`	`VIEW_FWD`	# `'view://'`

Properties summary

`public array`	`$helpers`	# `array('Javascript', 'Html', 'BeForm', 'Beurl', 'Tr', 'Session', 'Perms', 'BeEmbedMedia', 'SessionFilter', 'Paginator')`
`public array`	`$components`	# `array( 'BeAuth', 'BeTree', 'BeCustomProperty', 'Transaction', 'Cookie', 'Session', 'RequestHandler', 'ResponseHandler', 'BeHash', 'SessionFilter' )`
`public array`	`$uses`	# `array('EventLog')`
`public string`	`$view`	# `'Smarty'`
`public string`	`$ext`	# `'.tpl'`
`protected`	`$moduleName`	# `NULL`
`protected`	`$moduleList`	# `NULL`
`protected`	`$modulePerms`	# `NULL`
`public string`	`$result`	# `'OK'`
`protected boolean`	`$skipCheck`	# `false`
`protected static`	`$current`	# `NULL`
`protected`	`$currLang`	# `NULL`
`protected`	`$currLocale`	# `NULL`
`protected boolean`	`$profiling`	# `false`
`protected array`	`$modelBindings` Specific per-controller model bindings Specific per-controller model bindings	# `array()`
`protected string`	`$fullBaseUrl` Full url prefix Full url prefix	# `''`
`protected array,`	`$historyItem` fields to save in history table fields to save in history table	# `array()`
`public BeObjectCache`	`$BeObjectCache` If object cache is activate by objectCakeCache config param it contains instance of BeObjectCache class in libs If object cache is activate by objectCakeCache config param it contains instance of BeObjectCache class in libs	# `null`
`protected array`	`$objectData` Internal array to store and reuse object data like object_type_id or id from nickname Avoid multiple load from database or cache of same data Internal array to store and reuse object data like object_type_id or id from nickname Avoid multiple load from database or cache of same data	# `array( 'nicknames' => array(), 'typeIds' => array(), )`

Classes

Interfaces

Exceptions

Class AppController

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Parameters

Parameters

Constants summary

Properties summary