Class JInstallerScript

Base install script for use by extensions providing helper methods for common behaviours.

Package: Joomla\Libraries\Helper
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 3.6
Located at cms/installer/script.php

Methods summary

`public boolean`	# `preflight( string $type, JInstallerAdapter $parent )` Function called before extension installation/update/removal procedure commences Function called before extension installation/update/removal procedure commences Parameters `$type` `string` - $type The type of change (install, update or discover_install, not uninstall) `$parent` `JInstallerAdapter` - $parent The class calling this method Returns `boolean` - True on success Since 3.6
`public array`	# `getInstances( boolean $isModule )` Gets each instance of a module in the #__modules table Gets each instance of a module in the #__modules table Parameters `$isModule` `boolean` - $isModule True if the extension is a module as this can have multiple instances Returns `array` - An array of ID's of the extension Since 3.6
`public string`	# `getParam( string $name, integer $id = 0 )` Gets parameter value in the extensions row of the extension table Gets parameter value in the extensions row of the extension table Parameters `$name` `string` - $name The name of the parameter to be retrieved `$id` `integer` - $id The id of the item in the Param Table Returns `string` - The parameter desired Since 3.6
`public boolean`	# `setParams( array $param_array = null, string $type = 'edit', integer $id = 0 )` 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 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 Parameters `$param_array` `array` - $param_array The array of parameters to be added/edited/removed `$type` `string` - $type The type of change to be made to the param (edit/remove) `$id` `integer` - $id The id of the item in the relevant table Returns `boolean` - True on success Since 3.6
`public array`	# `getItemArray( string $element, string $table, string $column, mixed $identifier )` 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. 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. Parameters `$element` `string` - $element The element to get from the query `$table` `string` - $table The table to search for the data in `$column` `string` - $column The column of the database to search from `$identifier` `mixed` - $identifier The integer id or the already quoted string Returns `array` - Associated array containing data from the cell Since 3.6
`public`	# `removeFiles( )` Remove the files and folders in the given array from Remove the files and folders in the given array from Since 3.6
`public`	# `moveCliFiles( )` Moves the CLI scripts into the CLI folder in the CMS Moves the CLI scripts into the CLI folder in the CMS Since 3.6

Magic methods summary

Properties summary

`protected string`	`$release`	# The version number of the extension. The version number of the extension. Since 3.6
`protected string`	`$paramTable`	# The table the parameters are stored in. The table the parameters are stored in. Since 3.6
`protected string`	`$extension`	# The extension name. This should be set in the installer script. The extension name. This should be set in the installer script. Since 3.6
`protected array`	`$deleteFiles`	# A list of files to be deleted A list of files to be deleted Since 3.6
`protected array`	`$deleteFolders`	# A list of folders to be deleted A list of folders to be deleted Since 3.6
`protected array`	`$cliScriptFiles`	# A list of CLI script files to be copied to the cli directory A list of CLI script files to be copied to the cli directory Since 3.6
`protected string`	`$minimumPhp`	# Minimum PHP version required to install the extension Minimum PHP version required to install the extension Since 3.6
`protected string`	`$minimumJoomla`	# Minimum Joomla! version required to install the extension Minimum Joomla! version required to install the extension Since 3.6
`protected boolean`	`$allowDowngrades`	# Allow downgrades of your extension Allow downgrades of your extension Use at your own risk as if there is a change in functionality people may wish to downgrade. Since 3.6

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JInstallerScript

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Since

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since