Public Member Functions | Protected Member Functions | Protected Attributes

ModulesController Class Reference

Base class for modules. More...

Inheritance diagram for ModulesController:
AppController AddressbookController AdminController AreasController CommentsController DocumentsController EventsController GalleriesController MultimediaController NewsController NewsletterController StatisticsController TagsController TranslationsController UsersController WebmarksController

List of all members.

Public Member Functions

 changeStatusObjects ($modelName=null)
 assocCategory ()
 disassocCategory ()
 addItemsToAreaSection ()
 moveItemsToAreaSection ()
 removeItemsFromAreaSection ()
 previewsForObject ($sections, $obj_nick)
 Return preview links for $obj_nick in publications.
 cloneObject ()
 autoSaveObject (BEAppObjectModel $model)
 saveCategories ()
 Saves a category.
 deleteCategories ()
 Deletes a category.
 bulkCategories ()
 Performs bulk actions on categories.
 view ($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.
 delete ()
 Generic delete method: to override in real modules.
 save ()
 Generic save method: to override in real modules.
 moduleForward ($action, $result, $moduleRedirect=array())
 Default module controller forward given $action and $result.

Protected Member Functions

 checkWriteModulePermission ()
 paginatedList ($id, $filter, $order, $dir, $page, $dim)
 Method for paginated objects, used in ModuleController::index()...
 checkAutoSave ()
 viewObject (BEAppModel $beModel, $id=null)
 setSessionForObjectDetail ($objects=null)
 set session vars to use in objects detail:

  • backFromView
  • array with prev and next

 loadCategories ($objectTypes=array())
 showCategories (BEAppModel $beModel)
 getModuleObjectTypes ($moduleName)
 return array of object types belong to module
 loadFilters ($filterType= 'export')
 forward ($action, $result)
 Default forward for BEdita modules - to overrider in module controllers if needed.

Protected Attributes

 $categorizableModels = array()

Detailed Description

Base class for modules.

Definition at line 919 of file app_controller.php.


Member Function Documentation

ModulesController::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....

Reimplemented in AddressbookController, AreasController, CommentsController, DocumentsController, EventsController, GalleriesController, MultimediaController, NewsController, NewsletterController, TagsController, TranslationsController, and WebmarksController.

Definition at line 1680 of file app_controller.php.

ModulesController::deleteCategories (  ) 

Deletes a category.

Controllers should specify the list of categorizable models in $categorizableModels property.

Deprecated:

Definition at line 1504 of file app_controller.php.

References AppController::eventInfo(), and AppController::userInfoMessage().

ModulesController::forward ( action,
result 
) [protected]

Default forward for BEdita modules - to overrider in module controllers if needed.

See also:
AppController::forward()

Reimplemented from AppController.

Reimplemented in AddressbookController, AdminController, AreasController, CommentsController, MultimediaController, NewsletterController, TagsController, TranslationsController, UsersController, and WebmarksController.

Definition at line 1794 of file app_controller.php.

References moduleForward().

ModulesController::getModuleObjectTypes ( moduleName  )  [protected]

return array of object types belong to module

Parameters:
string $moduleName
Returns:
array

Definition at line 1609 of file app_controller.php.

Referenced by CommentsController::view().

ModulesController::moduleForward ( action,
result,
moduleRedirect = array() 
)

Default module controller forward given $action and $result.

Default rules are used, you may pass custom rules in $moduleRedirect array

Parameters:
string $action
string $result
string $moduleRedirect
Returns:
mixed, redirect url or false if no redirect is found

Definition at line 1720 of file app_controller.php.

Referenced by WebmarksController::forward(), UsersController::forward(), TranslationsController::forward(), TagsController::forward(), NewsletterController::forward(), MultimediaController::forward(), CommentsController::forward(), AreasController::forward(), AdminController::forward(), AddressbookController::forward(), and forward().

ModulesController::paginatedList ( id,
filter,
order,
dir,
page,
dim 
) [protected]

Method for paginated objects, used in ModuleController::index()...

Parameters:
unknown_type $id
unknown_type $filter
unknown_type $order
unknown_type $dir
unknown_type $page
unknown_type $dim

Definition at line 950 of file app_controller.php.

References setSessionForObjectDetail(), and AppController::setup_args().

Referenced by AreasController::loadChildren().

ModulesController::previewsForObject ( sections,
obj_nick 
)

Return preview links for $obj_nick in publications.

Parameters:
$sections array of section/area id
$obj_nick object nickname
Returns:
array of previews divided by publications, all object's url are in 'object_url' => array

Definition at line 1195 of file app_controller.php.

Referenced by MultimediaController::view().

ModulesController::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....

Reimplemented in AddressbookController, CommentsController, DocumentsController, EventsController, GalleriesController, NewsController, NewsletterController, TagsController, TranslationsController, and WebmarksController.

Definition at line 1696 of file app_controller.php.

ModulesController::saveCategories (  ) 

Saves a category.

Controllers should specify the list of categorizable models in $categorizableModels property.

Definition at line 1455 of file app_controller.php.

References AppController::eventInfo(), and AppController::userInfoMessage().

ModulesController::setSessionForObjectDetail ( objects = null  )  [protected]

set session vars to use in objects detail:

  • backFromView
  • array with prev and next

Parameters:
array $objects if it's defined prepare prevNext array for session

Definition at line 1395 of file app_controller.php.

Referenced by paginatedList(), and MultimediaController::view().

ModulesController::view ( 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....

Parameters:
integer $id object id to view

Reimplemented in AddressbookController, AreasController, CommentsController, DocumentsController, EventsController, GalleriesController, MultimediaController, NewsController, TagsController, and WebmarksController.

Definition at line 1664 of file app_controller.php.

Referenced by AdminController::utility().


The documentation for this class was generated from the following file:
Generated on Fri Dec 11 2015 15:29:47 by Doxygen 1.7.1  BEditaBEdita 3.7 Corylus