Module Basics
Modules are located inside the modules
directory and can be installed and edited under admin/view/modules
.
Getting started
Try the debugger
module to observe the application state while developing.
Module Structure
Head
Namespace statement and docblock of the ModuleName
class:
<?php namespace Redaxscript\Modules\ModuleName; /** * long module description * * @since 4.0.0 * * @package Redaxscript * @category Modules * @author Author Name */
Body
Empty ModuleName
skeleton:
class ModuleName extends Module\Module { /** * array of the module * * @var array */ protected static $_moduleArray = [ 'name' => 'Module Name', 'alias' => 'ModuleName', 'author' => 'Author Name', 'description' => 'Long module description', 'version' => '4.0.0' ]; }
Init
Optional method to override the default init process:
/** * init * * @since 4.0.0 */ public function init() { }
Hook
Optional method to trigger one of the module hooks:
/** * ModuleHook * * @since 4.0.0 */ public function ModuleHook() { }
Render
Optional method to be called inside the <module>
content tag:
/** * render * * @since 4.0.0 */ public function render() { }
Install
Optional method to override the default install process:
/** * install * * @since 4.0.0 */ public function install() { }
Uninstall
Optional method to override the default uninstall process:
/** * uninstall * * @since 4.0.0 */ public function uninstall() { }Edit on GitHub
Module Hooks
General
Name | Type |
---|---|
init | trigger |
renderStart | trigger |
renderEnd | trigger |
templateReplace | trigger |
templateStart | trigger |
templateEnd | trigger |
cronUpdate | trigger |
Router
Name | Type |
---|---|
routeHeader | trigger |
routeContent | trigger |
Article
Name | Type |
---|---|
articleReplace | trigger |
articleStart | trigger |
articleEnd | trigger |
articleFragmentStart | trigger |
articleFragmentEnd | trigger |
Byline
Name | Type |
---|---|
bylineStart | trigger |
bylineEnd | trigger |
Extra
Name | Type |
---|---|
extraReplace | trigger |
extraStart | trigger |
extraEnd | trigger |
extraFragmentStart | trigger |
extraFragmentEnd | trigger |
Comment
Name | Type |
---|---|
commentReplace | trigger |
commentStart | trigger |
commentEnd | trigger |
commentFragmentStart | trigger |
commentFragmentEnd | trigger |
Breadcrumb
Name | Type |
---|---|
breadcrumbStart | trigger |
breadcrumbEnd | trigger |
Pagination
Name | Type |
---|---|
paginationStart | trigger |
paginationEnd | trigger |
Navigation
Name | Type |
---|---|
navigationCategoryStart | trigger |
navigationCategoryEnd | trigger |
navigationArticleStart | trigger |
navigationArticleEnd | trigger |
navigationCommentStart | trigger |
navigationCommentEnd | trigger |
navigationLanguageStart | trigger |
navigationLanguageEnd | trigger |
navigationTemplateStart | trigger |
navigationTemplateEnd | trigger |
Form
Name | Type |
---|---|
commentFormStart | trigger |
commentFormEnd | trigger |
consoleFormStart | trigger |
consoleFormEnd | trigger |
installFormStart | trigger |
installFormEnd | trigger |
loginFormStart | trigger |
loginFormEnd | trigger |
recoverFormStart | trigger |
recoverFormEnd | trigger |
registerFormStart | trigger |
registerFormEnd | trigger |
resetFormStart | trigger |
resetFormEnd | trigger |
searchFormStart | trigger |
searchFormEnd | trigger |
Admin Router
Name | Type |
---|---|
adminRouteHeader | trigger |
adminRouteContent | trigger |
Admin Panel
Name | Type |
---|---|
adminPanelStart | trigger |
adminPanelEnd | trigger |
Admin Notification
Name | Type |
---|---|
adminNotification | collect |
Admin Dashboard
Name | Type |
---|---|
adminDashboardStart | trigger |
adminDashboardEnd | trigger |
adminDashboard | collect |
Admin Dock
Name | Type |
---|---|
adminDockStart | trigger |
adminDockEnd | trigger |
Admin Form
Name | Type |
---|---|
adminArticleFormStart | trigger |
adminArticleFormEnd | trigger |
adminCategoryFormStart | trigger |
adminCategoryFormEnd | trigger |
adminCommentFormStart | trigger |
adminCommentFormEnd | trigger |
adminExtraFormStart | trigger |
adminExtraFormEnd | trigger |
adminGroupFormStart | trigger |
adminGroupFormEnd | trigger |
adminModuleFormStart | trigger |
adminModuleFormEnd | trigger |
adminSettingFormStart | trigger |
adminSettingFormEnd | trigger |
adminUserFormStart | trigger |
adminUserFormEnd | trigger |
Admin Table
Name | Type |
---|---|
adminArticleTableStart | trigger |
adminArticleTableEnd | trigger |
adminCategoryTableStart | trigger |
adminCategoryTableEnd | trigger |
adminCommentTableStart | trigger |
adminCommentTableEnd | trigger |
adminExtraTableStart | trigger |
adminExtraTableEnd | trigger |
adminGroupTableStart | trigger |
adminGroupTableEnd | trigger |
adminModuleTableStart | trigger |
adminModuleTableEnd | trigger |
adminUserTableStart | trigger |
adminUserTableEnd | trigger |