Class ModulesController

Base class for modules

Controller

ModulesController

Direct known subclasses

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

Abstract
Located at app_controller.php

Methods summary

`protected`	# `checkWriteModulePermission( )`
`protected`	# `paginatedList( unknown_type $id, unknown_type $filter, unknown_type $order, unknown_type $dir, unknown_type $page, unknown_type $dim )` Method for paginated objects, used in ModuleController::index()... Method for paginated objects, used in ModuleController::index()... Parameters `$id` `$filter` `$order` `$dir` `$page` `$dim`
`public`	# `changeLanguageObjects( )` Change "lang" field in bulk to objects. Change "lang" field in bulk to objects. Used by "list_objects_bulk.tpl" view element.
`public`	# `changeRightsObjects( )` Change "rights" field in bulk to objects. Change "rights" field in bulk to objects. Used by "list_objects_bulk.tpl" view element.
`protected`	# `changeBulkObjects( integer[] $objectIds, string $field, string $value )` Change objects field value in bulk. Change objects field value in bulk. Parameters `$objectIds` IDs of the objects to change `$field` name of the field to change `$value` new value for the field Throws `BeditaException`
`public`	# `addPermissionsObjects( )` Add multiple permissions in bulk to objects. Add multiple permissions in bulk to objects. Used by "list_objects_bulk.tpl" view element.
`public`	# `changeStatusObjects( $modelName = null )`
`public`	# `assocCategory( )`
`public`	# `disassocCategory( )`
`public`	# `addItemsToAreaSection( )`
`public`	# `moveItemsToAreaSection( )`
`public`	# `removeItemsFromAreaSection( )`
`private`	# `itemsAreaSectionOp( $op = 'add', $objects_to_assoc = array(), $area_section_id = null, $user_info = true )`
`public array`	# `previewsForObject( $sections, $obj_nick )` Return preview links for $obj_nick in publications Return preview links for $obj_nick in publications Parameters `$sections` of section/area id `$obj_nick` nickname Returns array of previews divided by publications, all object's url are in 'object_url' => array
`public`	# `cloneObject( )`
`protected`	# `checkAutoSave( )`
`public`	# `autoSaveObject( BEAppObjectModel $model )`
`protected`	# `viewObject( BEAppModel $beModel, $id = null )`
`protected`	# `setSessionForObjectDetail( array $objects = null )` set session vars to use in objects detail: - backFromView - array with prev and next set session vars to use in objects detail: - backFromView - array with prev and next Parameters `$objects` if it's defined prepare prevNext array for session
`protected`	# `loadCategories( $objectTypes = array() )`
`protected`	# `showCategories( BEAppModel $beModel )`
`public`	# `saveCategories( )` Saves a category. Controllers should specify the list of categorizable models in $categorizableModels property. Saves a category. Controllers should specify the list of categorizable models in $categorizableModels property.
`public`	# `deleteCategories( )` Deletes a category. Controllers should specify the list of categorizable models in $categorizableModels property. Deletes a category. Controllers should specify the list of categorizable models in $categorizableModels property. Deprecated
`public`	# `bulkCategories( )` Performs bulk actions on categories. Performs bulk actions on categories.
`protected array`	# `getModuleObjectTypes( string $moduleName )` return array of object types belong to module return array of object types belong to module Parameters `$moduleName` Returns array
`protected`	# `loadFilters( $filterType = 'export' )`
`public`	# `view( integer $id )` Generic view method: to override in real modules or create specific view methods if more types are handled by this module, like view[ModelName] (e.g. viewDocument, viewEvent...) This methods will be called automagically.... Generic view method: to override in real modules or create specific view methods if more types are handled by this module, like view[ModelName] (e.g. viewDocument, viewEvent...) This methods will be called automagically.... Parameters `$id` object id to view
`public`	# `delete( )` Generic delete method: to override in real modules. If more types are handled by this module create specific delete methods like delete[ModelName] (e.g. deleteDocument, deleteEvent...) This methods will be called automagically.... Generic delete method: to override in real modules. If more types are handled by this module create specific delete methods like delete[ModelName] (e.g. deleteDocument, deleteEvent...) This methods will be called automagically....
`public`	# `save( )` Generic save method: to override in real modules. If more types are handled by this module create specific 'save' methods like save[ModelName] (e.g. saveDocument, saveEvent...) This methods will be called automagically.... Generic save method: to override in real modules. If more types are handled by this module create specific 'save' methods like save[ModelName] (e.g. saveDocument, saveEvent...) This methods will be called automagically....
`public`	# `readonlyTreePaths( $id )`
`public`	# `isInsideHiddenBranch( integer $id )` Set 'isInsideHiddenBranch' for a specified $id passed, if $id is inside hidden branch id config 'excludeFromTreeIds' Set 'isInsideHiddenBranch' for a specified $id passed, if $id is inside hidden branch id config 'excludeFromTreeIds' Parameters `$id` section id
`public mixed,`	# `moduleForward( string $action, string $result, string $moduleRedirect = array() )` Default module controller forward given $action and $result. Default rules are used, you may pass custom rules in $moduleRedirect array Default module controller forward given $action and $result. Default rules are used, you may pass custom rules in $moduleRedirect array Parameters `$action` `$result` `$moduleRedirect` Returns mixed, redirect url or false if no redirect is found
`protected`	# `forward( $action, $result )` Default forward for BEdita modules - to overrider in module controllers if needed Default forward for BEdita modules - to overrider in module controllers if needed See AppController::forward() Overrides `AppController::forward`

Methods inherited from AppController

__construct(), afterFilter(), beditaAfterFilter(), beditaBeforeFilter(), beditaBeforeRender(), beforeCheckLogin(), beforeFilter(), beforeRender(), checkLogin(), checkObjectWritePermission(), currentController(), deleteObjects(), eventError(), eventInfo(), eventLog(), eventWarn(), handleError(), idFromNicknameCache(), initAttributes(), loadModelByObjectTypeId(), loadModelByType(), modelBindings(), objectRelationArray(), objectTypeCache(), objectTypeIdCache(), prepareRelationsToSave(), saveObject(), setModelBindings(), setObjectBindings(), setResult(), setupAnnotations(), setupLocale(), setup_args(), startProfiler(), stopProfiler(), unsetModelBindings(), updateHistory(), usedUrl(), userErrorMessage(), userInfoMessage(), userWarnMessage(), viewRevision()

Constants summary

Constants inherited from AppController

ERROR, OK, VIEW_FWD

Properties summary

`protected array`	`$categorizableModels` Controller-specific categorizable models. Controller-specific categorizable models.	# `array()`
`protected array`	`$relationsOrder` Define a relations order by Model The order will be reflected in every module object view detail Example: Define a relations order by Model The order will be reflected in every module object view detail Example: array( 'Image' => array('attached_to', 'poster_of'), 'Video' => array('seealso') ) See self::viewObject()	# `array()`

Properties inherited from AppController

$BeObjectCache, $components, $currLang, $currLocale, $current, $ext, $fullBaseUrl, $helpers, $historyItem, $modelBindings, $moduleList, $moduleName, $modulePerms, $objectData, $profiling, $result, $skipCheck, $uses, $view

Classes

Interfaces

Exceptions

Class ModulesController

Direct known subclasses

Methods summary

Parameters

Parameters

Throws

Parameters

Returns

Parameters

Deprecated

Parameters

Returns

Parameters

Parameters

Parameters

Returns

See

Overrides

Methods inherited from AppController

Constants summary

Constants inherited from AppController

Properties summary

See

Properties inherited from AppController