Jelix 1.8.12

jprefModuleUpgrader_moveini extends Installer
in package

Base class for classes that does processing to install a module into an instance of the application. A module should have a class that inherits from it in order to setup itself into the application.

Tags
subpackage

jpref

author

Laurent Jouanneau

contributor
copyright

2016 Laurent Jouanneau

see
http://www.jelix.org
licence

GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html

Table of Contents

$date  : string
$defaultDbProfile  : string
$parameters  : array<string|int, mixed>
parameters for the installer, indicated in the configuration file or dynamically, by a launcher in a command line for instance.
$targetVersions  : array<string|int, mixed>
the versions for which the installer should be called.
$version  : string
$componentName  : string
$name  : string
$path  : string
The path of the module.
__construct()  : mixed
getDate()  : mixed
getDefaultDbProfile()  : mixed
getModuleName()  : mixed
getName()  : mixed
getParameter()  : mixed
getParameters()  : mixed
{@inheritdoc}
getPath()  : mixed
getTargetVersions()  : mixed
getVersion()  : mixed
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.
setParameters()  : mixed
{@inheritdoc}
setTargetVersions()  : mixed
setVersion()  : mixed

Properties

$date

protected string $date = '2016-11-24'

the date of the release of the update. format: yyyy-mm-dd hh:ii

Tags

$defaultDbProfile

protected string $defaultDbProfile = ''

the default profile name for the component, if it exist. keep it to '' if not

Tags

$parameters

parameters for the installer, indicated in the configuration file or dynamically, by a launcher in a command line for instance.

protected array<string|int, mixed> $parameters = array()
Tags

$targetVersions

the versions for which the installer should be called.

protected array<string|int, mixed> $targetVersions = array('1.1')

Useful for an upgrade which target multiple branches of a project. Put the version for multiple branches. The installer will be called only once, for the needed version. If you don't fill it, the name of the class file should contain the target version (deprecated behavior though)

list of version by asc order

Tags

$version

protected string $version = '0'

the version for which the installer is called

Tags

Methods

__construct()

public __construct(string $componentName, string $name, string $path, string $version[, bool $installWholeApp = true ]) : mixed
Parameters
$componentName : string

name of the component

$name : string

name of the installer

$path : string

the component path

$version : string

version of the component

$installWholeApp : bool = true

deprecated

Tags
Return values
mixed

getDate()

public getDate() : mixed
Tags
Return values
mixed

getDefaultDbProfile()

public getDefaultDbProfile() : mixed
Tags
Return values
mixed

getModuleName()

public final getModuleName() : mixed
Tags
Return values
mixed

getParameter()

public final getParameter(mixed $name) : mixed
Parameters
$name : mixed
Tags
Return values
mixed

getParameters()

{@inheritdoc}

public final getParameters() : mixed
Tags
Return values
mixed

getTargetVersions()

public getTargetVersions() : mixed
Tags
Return values
mixed

getVersion()

public getVersion() : mixed
Tags
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
Return values
mixed

setParameters()

{@inheritdoc}

public final setParameters(mixed $parameters) : mixed
Parameters
$parameters : mixed
Tags
Return values
mixed

setTargetVersions()

public setTargetVersions(mixed $versions) : mixed
Parameters
$versions : mixed
Tags
Return values
mixed

setVersion()

public setVersion(mixed $version) : mixed
Parameters
$version : mixed
Tags
Return values
mixed

Search results