Class FOFUtilsInstallscript

A helper class which you can use to create component installation scripts

Abstract
Package: FrameworkOnFramework\utils
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Located at fof/utils/installscript/installscript.php

Methods summary

`public boolean`	# `preflight( string $type, JInstaller $parent )` Joomla! pre-flight event. This runs before Joomla! installs or updates the component. This is our last chance to tell Joomla! if it should abort the installation. Joomla! pre-flight event. This runs before Joomla! installs or updates the component. This is our last chance to tell Joomla! if it should abort the installation. Parameters `$type` `string` - $type Installation type (install, update, discover_install) `$parent` `JInstaller` - $parent Parent object Returns `boolean` - True to let the installation proceed, false to halt the installation
`public`	# `postflight( string $type, JInstaller $parent )` Runs after install, update or discover_update. In other words, it executes after Joomla! has finished installing or updating your component. This is the last chance you've got to perform any additional installations, clean-up, database updates and similar housekeeping functions. Runs after install, update or discover_update. In other words, it executes after Joomla! has finished installing or updating your component. This is the last chance you've got to perform any additional installations, clean-up, database updates and similar housekeeping functions. Parameters `$type` `string` - $type install, update or discover_update `$parent` `JInstaller` - $parent Parent object
`public`	# `uninstall( JInstaller $parent )` Runs on uninstallation Runs on uninstallation Parameters `$parent` `JInstaller` - $parent The parent object
`protected`	# `copyCliFiles( JInstaller $parent )` Copies the CLI scripts into Joomla!'s cli directory Copies the CLI scripts into Joomla!'s cli directory Parameters `$parent` `JInstaller` - $parent
`protected`	# `renderPostInstallation( mixed $status, mixed $fofInstallationStatus, mixed $strapperInstallationStatus, mixed $parent )` Renders the message after installing or upgrading the component Renders the message after installing or upgrading the component
`protected`	# `renderPostUninstallation( mixed $status, mixed $parent )` Renders the message after uninstalling the component Renders the message after uninstalling the component
`protected`	# `bugfixDBFunctionReturnedNoError( )` Bugfix for "DB function returned no error" Bugfix for "DB function returned no error"
`protected`	# `bugfixCantBuildAdminMenus( )` Joomla! 1.6+ bugfix for "Can not build admin menus" Joomla! 1.6+ bugfix for "Can not build admin menus"
`protected JObject`	# `installSubextensions( JInstaller $parent )` Installs subextensions (modules, plugins) bundled with the main extension Installs subextensions (modules, plugins) bundled with the main extension Parameters `$parent` `JInstaller` - $parent Returns `JObject` - The subextension installation status
`protected stdClass`	# `uninstallSubextensions( JInstaller $parent )` Uninstalls subextensions (modules, plugins) bundled with the main extension Uninstalls subextensions (modules, plugins) bundled with the main extension Parameters `$parent` `JInstaller` - $parent The parent object Returns `stdClass` - The subextension uninstallation status
`protected`	# `removeFilesAndFolders( array $removeList )` Removes obsolete files and folders Removes obsolete files and folders Parameters `$removeList` `array` - $removeList The files and directories to remove
`protected array`	# `installFOF( JInstaller $parent )` Installs FOF if necessary Installs FOF if necessary Parameters `$parent` `JInstaller` - $parent The parent object Returns `array` - The installation status
`protected array`	# `installStrapper( JInstaller $parent )` Installs Akeeba Strapper if necessary Installs Akeeba Strapper if necessary Parameters `$parent` `JInstaller` - $parent The parent object Returns `array` - The installation status
`protected stdClass`	# `uninstallObsoleteSubextensions( JInstaller $parent )` Uninstalls obsolete subextensions (modules, plugins) bundled with the main extension Uninstalls obsolete subextensions (modules, plugins) bundled with the main extension Parameters `$parent` `JInstaller` - $parent The parent object Returns `stdClass` - The subextension uninstallation status
`protected`	# `addPostInstallationMessage( array $options )` Adds or updates a post-installation message (PIM) definition for Joomla! 3.2 or later. You can use this in your post-installation script using this code: Adds or updates a post-installation message (PIM) definition for Joomla! 3.2 or later. You can use this in your post-installation script using this code: The $options array contains the following mandatory keys: extension_id The numeric ID of the extension this message is for (see the #__extensions table) type One of message, link or action. Their meaning is: message Informative message. The user can dismiss it. link The action button links to a URL. The URL is defined in the action parameter. action A PHP action takes place when the action button is clicked. You need to specify the action_file (RAD path to the PHP file) and action (PHP function name) keys. See below for more information. title_key The JText language key for the title of this PIM Example: COM_FOOBAR_POSTINSTALL_MESSAGEONE_TITLE description_key The JText language key for the main body (description) of this PIM Example: COM_FOOBAR_POSTINSTALL_MESSAGEONE_DESCRIPTION action_key The JText language key for the action button. Ignored and not required when type=message Example: COM_FOOBAR_POSTINSTALL_MESSAGEONE_ACTION language_extension The extension name which holds the language keys used above. For example, com_foobar, mod_something, plg_system_whatever, tpl_mytemplate language_client_id Should we load the front-end (0) or back-end (1) language keys? version_introduced Which was the version of your extension where this message appeared for the first time? Example: 3.2.1 enabled Must be 1 for this message to be enabled. If you omit it, it defaults to 1. condition_file The RAD path to a PHP file containing a PHP function which determines whether this message should be shown to the user. @see FOFTemplateUtils::parsePath() for RAD path format. Joomla! will include this file before calling the condition_method. Example: admin://components/com_foobar/helpers/postinstall.php condition_method The name of a PHP function which will be used to determine whether to show this message to the user. This must be a simple PHP user function (not a class method, static method etc) which returns true to show the message and false to hide it. This function is defined in the condition_file. Example: com_foobar_postinstall_messageone_condition When type=message no additional keys are required. When type=link the following additional keys are required: action The URL which will open when the user clicks on the PIM's action button Example: index.php?option=com_foobar&view=tools&task=installSampleData Then type=action the following additional keys are required: action_file The RAD path to a PHP file containing a PHP function which performs the action of this PIM. Parameters `$options` `array` - $options See description Throws `Exception` See FOFTemplateUtils::parsePath() for RAD path format. Joomla! will include this file before calling the function defined in the action key below. Example: admin://components/com_foobar/helpers/postinstall.php action The name of a PHP function which will be used to run the action of this PIM. This must be a simple PHP user function (not a class method, static method etc) which returns no result. Example: com_foobar_postinstall_messageone_action
`protected`	# `_applyPostInstallationMessages( )` Applies the post-installation messages for Joomla! 3.2 or later Applies the post-installation messages for Joomla! 3.2 or later
`protected`	# `uninstallPostInstallationMessages( )`

Magic methods summary

Properties summary

`protected string`	`$componentName`	# The component's name The component's name
`protected string`	`$componentTitle`	# The title of the component (printed on installation and uninstallation messages) The title of the component (printed on installation and uninstallation messages)
`protected array`	`$installation_queue`	# The list of extra modules and plugins to install on component installation / update and remove on component uninstallation. The list of extra modules and plugins to install on component installation / update and remove on component uninstallation.
`protected array`	`$uninstallation_queue`	# The list of obsolete extra modules and plugins to uninstall on component upgrade / installation. The list of obsolete extra modules and plugins to uninstall on component upgrade / installation.
`protected array`	`$removeFilesFree`	# Obsolete files and folders to remove from the free version only. This is used when you move a feature from the free version of your extension to its paid version. If you don't have such a distinction you can ignore this. Obsolete files and folders to remove from the free version only. This is used when you move a feature from the free version of your extension to its paid version. If you don't have such a distinction you can ignore this.
`protected array`	`$removeFilesAllVersions`	# Obsolete files and folders to remove from both paid and free releases. This is used when you refactor code and some files inevitably become obsolete and need to be removed. Obsolete files and folders to remove from both paid and free releases. This is used when you refactor code and some files inevitably become obsolete and need to be removed.
`protected array`	`$cliScriptFiles`	# A list of scripts to be copied to the "cli" directory of the site A list of scripts to be copied to the "cli" directory of the site
`protected string`	`$cliSourcePath`	# The path inside your package where cli scripts are stored The path inside your package where cli scripts are stored
`protected string`	`$fofSourcePath`	# The path inside your package where FOF is stored The path inside your package where FOF is stored
`protected string`	`$strapperSourcePath`	# The path inside your package where Akeeba Strapper is stored The path inside your package where Akeeba Strapper is stored
`protected string`	`$modulesSourcePath`	# The path inside your package where extra modules are stored The path inside your package where extra modules are stored
`protected string`	`$pluginsSourcePath`	# The path inside your package where extra plugins are stored The path inside your package where extra plugins are stored
`protected boolean`	`$schemaXmlPathRelative`	# Is the schemaXmlPath class variable a relative path? If set to true the schemaXmlPath variable contains a path relative to the component's back-end directory. If set to false the schemaXmlPath variable contains an absolute filesystem path. Is the schemaXmlPath class variable a relative path? If set to true the schemaXmlPath variable contains a path relative to the component's back-end directory. If set to false the schemaXmlPath variable contains an absolute filesystem path.
`protected string`	`$schemaXmlPath`	# The path where the schema XML files are stored. Its contents depend on the schemaXmlPathRelative variable above true => schemaXmlPath contains a path relative to the component's back-end directory false => schemaXmlPath contains an absolute filesystem path The path where the schema XML files are stored. Its contents depend on the schemaXmlPathRelative variable above true => schemaXmlPath contains a path relative to the component's back-end directory false => schemaXmlPath contains an absolute filesystem path
`protected string`	`$minimumPHPVersion`	# The minimum PHP version required to install this extension The minimum PHP version required to install this extension
`protected string`	`$minimumJoomlaVersion`	# The minimum Joomla! version required to install this extension The minimum Joomla! version required to install this extension
`protected string`	`$maximumJoomlaVersion`	# The maximum Joomla! version this extension can be installed on The maximum Joomla! version this extension can be installed on
`protected boolean`	`$isPaid`	# Is this the paid version of the extension? This only determines which files / extensions will be removed. Is this the paid version of the extension? This only determines which files / extensions will be removed.
`protected array`	`$postInstallationMessages`	# Post-installation message definitions for Joomla! 3.2 or later. Post-installation message definitions for Joomla! 3.2 or later. This array contains the message definitions for the Post-installation Messages component added in Joomla! 3.2 and later versions. Each element is also a hashed array. For the keys used in these message definitions please See `FOFUtilsInstallscript::addPostInstallationMessage()`

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFUtilsInstallscript

Methods summary

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Throws

See

Magic methods summary

Properties summary

See