| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2005 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 716 lines (23 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| getModule($name, $title = null) X-Ref |
| Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs') param: string $name The name of the module param: string $title The title of the module, optional return: \stdClass The Module object |
| getModules($position) X-Ref |
| Get modules by position param: string $position The position of the module return: array An array of module objects |
| isEnabled($module) X-Ref |
| Checks if a module is enabled. A given module will only be returned if it meets the following criteria: it is enabled, it is assigned to the current menu item or all items, and the user meets the access level requirements. param: string $module The module name return: boolean See description for conditions. |
| renderModule($module, $attribs = array() X-Ref |
| Render the module. param: object $module A module object. param: array $attribs An array of attributes for the module (probably from the XML). return: string The HTML content of the module output. |
| renderRawModule($module, Registry $params, $attribs = array() X-Ref |
| Render the module content. param: object $module A module object param: Registry $params A module parameters param: array $attribs An array of attributes for the module (probably from the XML). return: string |
| getLayoutPath($module, $layout = 'default') X-Ref |
| Get the path to a layout for a module param: string $module The name of the module param: string $layout The name of the module layout. If alternative layout, in the form template:filename. return: string The path to the module layout |
| load() X-Ref |
| Load published modules. return: array |
| getModuleList() X-Ref |
| Module list return: array |
| cleanModuleList($modules) X-Ref |
| Clean the module list param: array $modules Array with module objects return: array |
| moduleCache($module, $moduleparams, $cacheparams) X-Ref |
| Module cache helper Caching modes: To be set in XML: 'static' One cache file for all pages with the same module parameters 'itemid' Changes on itemid change, to be called from inside the module: 'safeuri' Id created from $cacheparams->modeparams array, 'id' Module sets own cache id's param: object $module Module object param: object $moduleparams Module parameters param: object $cacheparams Module cache parameters - id or URL parameters, depending on the module cache mode return: string |
| isAdminMultilang() X-Ref |
| Method to determine if filtering by language is enabled in back-end for modules. return: boolean True if enabled; false otherwise. |
| getModuleById($id) X-Ref |
| Get module by id param: string $id The id of the module return: \stdClass The Module object |
| createDummyModule() X-Ref |
| Method to create a dummy module. return: \stdClass The Module object |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |