Jelix 1.6.37

jInstallerComponentModule extends jInstallerComponentBase
in package

a class to install a module.

Tags
subpackage

installer

since
1.2

Table of Contents

$dependencies  : mixed
list of dependencies of the module
$inError  : mixed
code error of the installation
$identityFile  : string
$identityNamespace  : string
$identityReaded  : bool
$installerContexts  : mixed
list of sessions Id of the component
$jelixMaxVersion  : string
$jelixMinVersion  : string
$mainInstaller  : jInstaller
$moduleInfos  : array<string|int, jInstallerModuleInfos>
list of information about the module for each entry points
$moduleInstaller  : jInstallerBase
$moduleMainUpgrader  : jInstallerModule
$moduleUpgraders  : array<string|int, jInstallerBase>
$name  : string
$path  : string
$rootName  : string
$sourceDate  : string
$sourceVersion  : string
$upgradersContexts  : mixed
__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
_formatDate()  : mixed
_setAccess()  : mixed
If no access is defined for the module, we should set it one
readComponentDependencyInfo()  : array<string|int, mixed>|null
readDependencies()  : mixed
readIdentity()  : mixed
read the identity file

Properties

Methods

__construct()

public __construct(mixed $name, mixed $path, mixed $mainInstaller) : mixed
Parameters
$name : mixed

the name of the component

$path : mixed

the path of the component

$mainInstaller : mixed
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

getInstaller()

get the object which is responsible to install the component. this object should implement jIInstallerComponent.

public getInstaller(jInstallerEntryPoint $ep, bool $installWholeApp) : jIInstallerComponent
Parameters
$ep : jInstallerEntryPoint

the entry point

$installWholeApp : bool

true if the installation is done during app installation

Tags
throws
jInstallerException
Return values
jIInstallerComponent

the installer, or null if there isn't any installer or false if the installer is useless for the given parameter

getUpgraders()

return the list of objects which are responsible to upgrade the component from the current installed version of the component.

public 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
throws
jInstallerException
throws
jInstallerException

if an error occurs during the install.

Return values
array<string|int, jIInstallerComponent>

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

Search results