J3.x:Developing an MVC Component/Adding an install-uninstall-update script file

2014-10-17T18:47:35Z

Miguel:

{{:J3.1:Developing a MVC Component}}

{{review}}

This is a multiple-article series of tutorials on how to develop a Model-View-Contoller [[Component]] for Joomla! Version {{JVer|{{CurrentSTSVer|minor}}}}.

[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Beginner Development]]
[[Category:Component Development]]
== Creating the extension script file ==
Installing, updating and uninstalling a component may require additional operations that cannot be achieved by the basic operations described in the main xml file. Joomla offers a new approach to solve this problem. It consists in using a php script file containing a class using five methods:

* preflight which is executed before install and update
* install
* update
* uninstall
* postflight which is executed after install and update

Writing an extension script consists in declaring an class whose name is com_ComponentNameInstallerScript with these 5 methods.
For plugins you need to add the group.

<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die;

/**
* Script file of HelloWorld plugin
* Group: Universe
*/
class plgUniverseHelloWorldInstallerScript
{
/**
* Method to install the extension
* $parent is the class calling this method
*
* @return void
*/
function install($parent)
{
echo 'The module has been installed';
}

/**
* Method to uninstall the extension
* $parent is the class calling this method
*
* @return void
*/
function uninstall($parent)
{
echo 'The module has been uninstalled';
}

/**
* Method to update the extension
* $parent is the class calling this method
*
* @return void
*/
function update($parent)
{
echo 'The module has been updated to version' . $parent->get('manifest')->version) . '';
}

/**
* Method to run before an install/update/uninstall method
* $parent is the class calling this method
* $type is the type of change (install, update or discover_install)
*
* @return void
*/
function preflight($type, $parent)
{
echo 'Anything here happens before the installation/update/uninstallation of the module';
}

/**
* Method to run after an install/update/uninstall method
* $parent is the class calling this method
* $type is the type of change (install, update or discover_install)
*
* @return void
*/
function postflight($type, $parent)
{
echo 'Anything here happens after the installation/update/uninstallation of the module';
}
}</source>

Joomla! Documentation - User contributions [en]

J3.x:Developing an MVC Component/Adding an install-uninstall-update script file