Jelix 1.8.9

Item
in package

Tags

Table of Contents

$_canBeInstalled  : mixed
$_isInstalled  : mixed
$action  : mixed
$alternativeDependencies  : mixed
$currentVersion  : mixed
$dependencies  : mixed
$incompatibilities  : mixed
$name  : mixed
$nextVersion  : mixed
$properties  : mixed
__construct()  : mixed
Item constructor.
addAlternativeDependencies()  : mixed
addDependency()  : mixed
addIncompatibility()  : mixed
canBeInstalled()  : mixed
getAction()  : mixed
getAlternativeDependencies()  : mixed
getCurrentVersion()  : mixed
getDependencies()  : mixed
getDependencyVersion()  : mixed
getIncompatibilities()  : mixed
getName()  : mixed
getNextVersion()  : mixed
getProperty()  : mixed
isInstalled()  : mixed
setAction()  : mixed
setProperty()  : mixed
To set properties that can be useful for the user of the Resolver.

Properties

$_canBeInstalled

protected mixed $_canBeInstalled = true
Tags

$_isInstalled

protected mixed $_isInstalled = false
Tags

$action

protected mixed $action
Tags

$alternativeDependencies

protected mixed $alternativeDependencies = array()
Tags

$currentVersion

protected mixed $currentVersion
Tags

$dependencies

protected mixed $dependencies = array()
Tags

$incompatibilities

protected mixed $incompatibilities = array()
Tags

$name

protected mixed $name
Tags

$nextVersion

protected mixed $nextVersion
Tags

$properties

protected mixed $properties = array()
Tags

Methods

__construct()

Item constructor.

public __construct(string $name, string $currentVersion, bool $isInstalled[, bool $canBeInstalled = true ]) : mixed
Parameters
$name : string

an name that is unique among all items

$currentVersion : string
$isInstalled : bool
$canBeInstalled : bool = true

indicate if the module can be installed automatically by the resolver

Tags
Return values
mixed

addAlternativeDependencies()

public addAlternativeDependencies(array<string|int, mixed> $choice) : mixed
Parameters
$choice : array<string|int, mixed>

list of dependencies where one of them should be installed, not all ex:

[
// this dependency
'$name'=> '$version',
// or this dependency
'$name'=> '$version',
// or ...
]
Tags
Return values
mixed

addDependency()

public addDependency(mixed $name[, mixed $version = '*' ][, mixed $optional = false ]) : mixed
Parameters
$name : mixed
$version : mixed = '*'
$optional : mixed = false
Tags
Return values
mixed

addIncompatibility()

public addIncompatibility(mixed $name[, mixed $version = '*' ]) : mixed
Parameters
$name : mixed
$version : mixed = '*'
Tags
Return values
mixed

canBeInstalled()

public canBeInstalled() : mixed
Tags
Return values
mixed

getAction()

public getAction() : mixed
Tags
Return values
mixed

getAlternativeDependencies()

public getAlternativeDependencies() : mixed
Tags
Return values
mixed

getCurrentVersion()

public getCurrentVersion() : mixed
Tags
Return values
mixed

getDependencies()

public getDependencies() : mixed
Tags
Return values
mixed

getDependencyVersion()

public getDependencyVersion(mixed $name) : mixed
Parameters
$name : mixed
Tags
Return values
mixed

getIncompatibilities()

public getIncompatibilities() : mixed
Tags
Return values
mixed

getName()

public getName() : mixed
Tags
Return values
mixed

getNextVersion()

public getNextVersion() : mixed
Tags
Return values
mixed

getProperty()

public getProperty(mixed $name) : mixed
Parameters
$name : mixed
Tags
Return values
mixed

isInstalled()

public isInstalled() : mixed
Tags
Return values
mixed

setAction()

public setAction(int $action[, null $nextVersion = null ]) : mixed
Parameters
$action : int

one of Resolver::ACTION_* const

$nextVersion : null = null

if action is ACTION_UPGRADE

Tags
Return values
mixed

setProperty()

To set properties that can be useful for the user of the Resolver.

public setProperty( $name,  $value) : mixed
Parameters
$name :
$value :
Tags
Return values
mixed

Search results