| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2016 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 397 lines (13 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
InstallerScript:: (8 methods):
preflight()
getInstances()
getParam()
setParams()
getItemArray()
removeFiles()
moveCliFiles()
addDashboardMenu()
Class: InstallerScript - X-Ref
Base install script for use by extensions providing helper methods for common behaviours.| preflight($type, $parent) X-Ref |
| Function called before extension installation/update/removal procedure commences param: string $type The type of change (install, update or discover_install, not uninstall) param: InstallerAdapter $parent The class calling this method return: boolean True on success |
| getInstances($isModule) X-Ref |
| Gets each instance of a module in the #__modules table param: boolean $isModule True if the extension is a module as this can have multiple instances return: array An array of ID's of the extension |
| getParam($name, $id = 0) X-Ref |
| Gets parameter value in the extensions row of the extension table param: string $name The name of the parameter to be retrieved param: integer $id The id of the item in the Param Table return: string The parameter desired |
| setParams($paramArray = null, $type = 'edit', $id = 0) X-Ref |
| Sets parameter values in the extensions row of the extension table. Note that the this must be called separately for deleting and editing. Note if edit is called as a type then if the param doesn't exist it will be created param: array $paramArray The array of parameters to be added/edited/removed param: string $type The type of change to be made to the param (edit/remove) param: integer $id The id of the item in the relevant table return: boolean True on success |
| getItemArray($element, $table, $column, $identifier) X-Ref |
| Builds a standard select query to produce better DRY code in this script. This should produce a single unique cell which is json encoded - it will then return an associated array with this data in. param: string $element The element to get from the query param: string $table The table to search for the data in param: string $column The column of the database to search from param: mixed $identifier The integer id or the string return: array Associated array containing data from the cell |
| removeFiles() X-Ref |
| Remove the files and folders in the given array from return: void |
| moveCliFiles() X-Ref |
| Moves the CLI scripts into the CLI folder in the CMS return: void |
| addDashboardMenu(string $dashboard, string $preset) X-Ref |
| Creates the dashboard menu module param: string $dashboard The name of the dashboard param: string $preset The name of the menu preset return: void |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |