Jelix 1.8.12

InstallerInterface

interface of classes which install a module.

Tags
since
1.7

Table of Contents

install()  : mixed
Should configure the module.
postInstall()  : mixed
Redefine this method if you do some additional process after the installation of all modules.
preInstall()  : mixed
Called before the installation of any modules.

Methods

install()

Should configure the module.

public install(InstallHelpers $helpers) : mixed

If an error occurs during the installation, you are responsible to cancel/revert all things the method did before the error

Parameters
$helpers : InstallHelpers
Tags
throws
Exception

if an error occurs during the installation

Return values
mixed

postInstall()

Redefine this method if you do some additional process after the installation of all modules.

public postInstall(InstallHelpers $helpers) : mixed
Parameters
$helpers : InstallHelpers
Tags
throws
Exception

if an error occurs during the post installation

Return values
mixed

preInstall()

Called before the installation of any modules.

public preInstall(PreInstallHelpers $helpers) : mixed

Here, you should check if the module can be installed or not

Parameters
$helpers : PreInstallHelpers
Tags
throws
Exception

if the module cannot be installed

Return values
mixed

Search results