Jelix 1.6
Back to top  

jInstallerComponentPlugin

Extends \jInstallerComponentBase

EXPERIMENTAL a class to install a module.

package

jelix
subpackage

installer
experimental
deprecated
since 1.2

Methods

__construct

__construct(string $name, string $path, \jInstaller $mainInstaller)
inherited

Arguments

$name

string

the name of the component

$path

string

the path of the component

$mainInstaller

\jInstaller

addModuleInfos

addModuleInfos( $epId, \jInstallerModuleInfos $module)
inherited

Arguments

$epId

$module

\jInstallerModuleInfos

module infos

checkJelixVersion

checkJelixVersion( $jelixVersion)
inherited

Arguments

$jelixVersion

checkVersion

checkVersion( $min,  $max)
inherited

Arguments

$min

$max

getAccessLevel

getAccessLevel( $epId)
inherited

Arguments

$epId

getInstalledVersion

getInstalledVersion( $epId)
inherited

Arguments

$epId

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

getInstaller(\jInstallerEntryPoint $ep, boolean $installWholeApp) : \jIInstallerComponent
inherited abstract

Arguments

$ep

\jInstallerEntryPoint

the entry point

$installWholeApp

boolean

true if the installation is done during app installation

Response

\jIInstallerComponent

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

getInstallParameters

getInstallParameters( $epId)
inherited

Arguments

$epId

getJelixVersion

getJelixVersion()
inherited

getName

getName()
inherited

getPath

getPath()
inherited

getSourceDate

getSourceDate()
inherited

getSourceVersion

getSourceVersion()
inherited

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

getUpgraders(\jInstallerEntryPoint $ep) : array
inherited abstract

this method should be called after verifying and resolving dependencies. Needed components (modules or plugins) should be installed/upgraded before calling this method

Throws
\jInstallerException

if an error occurs during the install.

Arguments

$ep

\jInstallerEntryPoint

the entry point

Response

array

array of jIInstallerComponent

initialize the object, by reading the identity file

init()
inherited

installFinished

installFinished( $ep)
inherited

Arguments

$ep

isInstalled

isInstalled( $epId)
inherited

Arguments

$epId

isUpgraded

isUpgraded( $epId)
inherited

Arguments

$epId

readDependencies

readDependencies( $xml)
inherited

Arguments

$xml

read the identity file

readIdentity()
inherited
Throws
\Exception

setInstalledVersion

setInstalledVersion( $epId,  $version)
inherited

Arguments

$epId

$version

setInstallParameters

setInstallParameters( $epId,  $parameters)
inherited

Arguments

$epId

$parameters

upgradeFinished

upgradeFinished( $ep,  $upgrader)
inherited

Arguments

$ep

$upgrader

Properties

the namespace of the xml file

identityNamespace : string
inherited
var

the namespace of the xml file

Type(s)

string

the expected name of the root element in the xml file

rootName : string
inherited
var

the expected name of the root element in the xml file

Type(s)

string

the name of the xml file

identityFile : string
inherited
var

the name of the xml file

Type(s)

string

name of the component

name : string
inherited
var

name of the component

Type(s)

string

the path of the directory of the component it should be set by the constructor

path : string
inherited
var

the path of the directory of the component it should be set by the constructor

Type(s)

string

version of the current sources of the module

sourceVersion : string
inherited
var

version of the current sources of the module

Type(s)

string

the date of the current sources of the module

sourceDate : string
inherited
var

the date of the current sources of the module

Type(s)

string

the main installer controller

mainInstaller : \jInstaller
inherited
var

the main installer controller

Type(s)

\jInstaller

list of dependencies of the module

dependencies :
inherited

Type(s)

the minimum version of jelix for which the component is compatible

jelixMinVersion : string
inherited
var

the minimum version of jelix for which the component is compatible

Type(s)

string

the maximum version of jelix for which the component is compatible

jelixMaxVersion : string
inherited
var

the maximum version of jelix for which the component is compatible

Type(s)

string

code error of the installation

inError :
inherited

Type(s)

list of information about the module for each entry points

moduleInfos : array<mixed,\jInstallerModuleInfos>
inherited
var

key = epid

Type(s)

array<mixed,\jInstallerModuleInfos>

indicate if the identify file has already been readed

identityReaded : boolean
inherited
var

indicate if the identify file has already been readed

Type(s)

boolean