jInstallerComponentBase
in package
a class to install a component (module or plugin)
Tags
Table of Contents
- $dependencies : mixed
- list of dependencies of the module
- $inError : mixed
- code error of the installation
- $identityFile : string
- $identityNamespace : string
- $identityReaded : bool
- $jelixMaxVersion : string
- $jelixMinVersion : string
- $mainInstaller : jInstaller
- $moduleInfos : array<string|int, jInstallerModuleInfos>
- list of information about the module for each entry points
- $name : string
- $path : string
- $rootName : string
- $sourceDate : string
- $sourceVersion : string
- __construct() : mixed
- addModuleInfos() : mixed
- checkJelixVersion() : mixed
- checkVersion() : mixed
- getAccessLevel() : mixed
- getInstalledVersion() : mixed
- getInstaller() : jIInstallerComponent
- get the object which is responsible to install the component. this object should implement jIInstallerComponent.
- getInstallParameters() : mixed
- getJelixVersion() : mixed
- getName() : mixed
- getPath() : mixed
- getSourceDate() : mixed
- getSourceVersion() : mixed
- getUpgraders() : array<string|int, jIInstallerComponent>
- return the list of objects which are responsible to upgrade the component from the current installed version of the component.
- init() : mixed
- initialize the object, by reading the identity file
- installFinished() : mixed
- isInstalled() : mixed
- isUpgraded() : mixed
- setInstalledVersion() : mixed
- setInstallParameters() : mixed
- upgradeFinished() : mixed
- readComponentDependencyInfo() : array<string|int, mixed>|null
- readDependencies() : mixed
- readIdentity() : mixed
- read the identity file
Properties
$dependencies
list of dependencies of the module
public
mixed
$dependencies
= array()
$inError
code error of the installation
public
mixed
$inError
= 0
$identityFile
protected
string
$identityFile
= ''
the name of the xml file
$identityNamespace
protected
string
$identityNamespace
= ''
the namespace of the xml file
$identityReaded
protected
bool
$identityReaded
= alse
indicate if the identify file has already been readed
$jelixMaxVersion
protected
string
$jelixMaxVersion
= '*'
the maximum version of jelix for which the component is compatible
$jelixMinVersion
protected
string
$jelixMinVersion
= '*'
the minimum version of jelix for which the component is compatible
$mainInstaller
protected
jInstaller
$mainInstaller
=
ull
the main installer controller
$moduleInfos
list of information about the module for each entry points
protected
array<string|int, jInstallerModuleInfos>
$moduleInfos
= array()
key = epid
$name
protected
string
$name
= ''
name of the component
$path
protected
string
$path
= ''
the path of the directory of the component it should be set by the constructor
$rootName
protected
string
$rootName
= ''
the expected name of the root element in the xml file
$sourceDate
protected
string
$sourceDate
= ''
the date of the current sources of the module
$sourceVersion
protected
string
$sourceVersion
= ''
version of the current sources of the module
Methods
__construct()
public
__construct(string $name, string $path, jInstaller $mainInstaller) : mixed
Parameters
- $name : string
-
the name of the component
- $path : string
-
the path of the component
- $mainInstaller : jInstaller
Return values
mixed —addModuleInfos()
public
addModuleInfos(mixed $epId, jInstallerModuleInfos $module) : mixed
Parameters
- $epId : mixed
- $module : jInstallerModuleInfos
-
module infos
Return values
mixed —checkJelixVersion()
public
checkJelixVersion(mixed $jelixVersion) : mixed
Parameters
- $jelixVersion : mixed
Return values
mixed —checkVersion()
public
checkVersion(mixed $min, mixed $max) : mixed
Parameters
- $min : mixed
- $max : mixed
Return values
mixed —getAccessLevel()
public
getAccessLevel(mixed $epId) : mixed
Parameters
- $epId : mixed
Return values
mixed —getInstalledVersion()
public
getInstalledVersion(mixed $epId) : mixed
Parameters
- $epId : mixed
Return values
mixed —getInstaller()
get the object which is responsible to install the component. this object should implement jIInstallerComponent.
public
abstract getInstaller(jInstallerEntryPoint $ep, bool $installWholeApp) : jIInstallerComponent
Parameters
- $ep : jInstallerEntryPoint
-
the entry point
- $installWholeApp : bool
-
true if the installation is done during app installation
Return values
jIInstallerComponent —the installer, or null if there isn't any installer or false if the installer is useless for the given parameter
getInstallParameters()
public
getInstallParameters(mixed $epId) : mixed
Parameters
- $epId : mixed
Return values
mixed —getJelixVersion()
public
getJelixVersion() : mixed
Return values
mixed —getName()
public
getName() : mixed
Return values
mixed —getPath()
public
getPath() : mixed
Return values
mixed —getSourceDate()
public
getSourceDate() : mixed
Return values
mixed —getSourceVersion()
public
getSourceVersion() : mixed
Return values
mixed —getUpgraders()
return the list of objects which are responsible to upgrade the component from the current installed version of the component.
public
abstract getUpgraders(jInstallerEntryPoint $ep) : array<string|int, jIInstallerComponent>
this method should be called after verifying and resolving dependencies. Needed components (modules or plugins) should be installed/upgraded before calling this method
Parameters
- $ep : jInstallerEntryPoint
-
the entry point
Tags
Return values
array<string|int, jIInstallerComponent> —init()
initialize the object, by reading the identity file
public
init() : mixed
Return values
mixed —installFinished()
public
installFinished(mixed $ep) : mixed
Parameters
- $ep : mixed
Return values
mixed —isInstalled()
public
isInstalled(mixed $epId) : mixed
Parameters
- $epId : mixed
Return values
mixed —isUpgraded()
public
isUpgraded(mixed $epId) : mixed
Parameters
- $epId : mixed
Return values
mixed —setInstalledVersion()
public
setInstalledVersion(mixed $epId, mixed $version) : mixed
Parameters
- $epId : mixed
- $version : mixed
Return values
mixed —setInstallParameters()
public
setInstallParameters(mixed $epId, mixed $parameters) : mixed
Parameters
- $epId : mixed
- $parameters : mixed
Return values
mixed —upgradeFinished()
public
upgradeFinished(mixed $ep, mixed $upgrader) : mixed
Parameters
- $ep : mixed
- $upgrader : mixed
Return values
mixed —readComponentDependencyInfo()
protected
readComponentDependencyInfo(string $type, SimpleXMLElement $dependency) : array<string|int, mixed>|null
Parameters
- $type : string
- $dependency : SimpleXMLElement
Return values
array<string|int, mixed>|null —readDependencies()
protected
readDependencies(mixed $xml) : mixed
Parameters
- $xml : mixed
Return values
mixed —readIdentity()
read the identity file
protected
readIdentity() : mixed