Jelix 1.8.9

ModuleInfos extends InfosAbstract
in package

Information about the module, retrieved from its module.xml file.

Tags

Table of Contents

$author  : array<string|int, Author>
$autoloadClasses  : array<string|int, string>
List of classes and their relative path to the module.
$autoloadClassPatterns  : array<string|int, array<string|int, mixed>>
List of directories where to find classes having a specific name pattern.
$autoloaders  : array<string|int, string>
List of files that initialize an autoloader.
$autoloadIncludePath  : array<string|int, array<string|int, mixed>>
list of relative path to directories where a class could be found.
$autoloadPsr0Namespaces  : array<string|int, array<string|int, mixed>>
List of namespaces and corresponding path following PSR-0.
$autoloadPsr4Namespaces  : array<string|int, array<string|int, mixed>>
List of namespaces and corresponding path following PSR-4.
$copyright  : mixed
$createDate  : string
$dependencies  : array<string|int, array<string|int, mixed>>
list of module dependencies.
$description  : array<string|int, string>
$homepageURL  : mixed
$id  : string
$incompatibilities  : array<string|int, array<string|int, mixed>>
list of incompatibilities of the module.
$label  : array<string|int, string>
$license  : mixed
$licenseURL  : mixed
$name  : string
$notes  : mixed
$updateURL  : mixed
$version  : string
$versionDate  : string
$versionStability  : mixed
$_exists  : mixed
$isXml  : mixed
$path  : string
__construct()  : mixed
InfosAbstract constructor.
exists()  : bool
getDescription()  : mixed
getFilePath()  : string
getItemPath()  : mixed
getLabel()  : mixed
isXmlFile()  : bool
load()  : ModuleInfos
create a new ModuleInfos object, loaded from a file that is into the given directory.
save()  : mixed
save the informations into the original file.
getLocale()  : mixed

Properties

$autoloadClasses

List of classes and their relative path to the module.

public array<string|int, string> $autoloadClasses = array()

Keys are class name, values are path

Tags

$autoloadClassPatterns

List of directories where to find classes having a specific name pattern.

public array<string|int, array<string|int, mixed>> $autoloadClassPatterns = array()

key is a regexp. Value is: array ('<rel_dirpath>', '')

Tags

$autoloaders

List of files that initialize an autoloader.

public array<string|int, string> $autoloaders = array()
Tags

$autoloadIncludePath

list of relative path to directories where a class could be found.

public array<string|int, array<string|int, mixed>> $autoloadIncludePath = array()

items are array ('<rel_dirpath>', '')

Tags

$autoloadPsr0Namespaces

List of namespaces and corresponding path following PSR-0.

public array<string|int, array<string|int, mixed>> $autoloadPsr0Namespaces = array()

Each namespace may have several directories where to search.

'namespace name' => array( array ('<rel_dirpath>', '')), 0 => array( array ('<rel_dirpath>', ''),... )

Tags

$autoloadPsr4Namespaces

List of namespaces and corresponding path following PSR-4.

public array<string|int, array<string|int, mixed>> $autoloadPsr4Namespaces = array()

Each namespace may have several directories where to search.

'namespace name' => array( array ('<rel_dirpath>', '')), 0 => array( array ('<rel_dirpath>', ''),... )

Tags

$createDate

public string $createDate = ''

the birthdate of the module/app. optional

Tags

$dependencies

list of module dependencies.

public array<string|int, array<string|int, mixed>> $dependencies = array()

items are: array('name'=>'', 'version'=>'', 'optional'=>true/false)

Tags

$description

public array<string|int, string> $description = array()

key is the locale code

Tags

$id

public string $id = ''

unique id (e.g. 'name@company')

Tags

$incompatibilities

list of incompatibilities of the module.

public array<string|int, array<string|int, mixed>> $incompatibilities = array()

items are array('name'=>'', 'version'=>'')

Tags

$label

public array<string|int, string> $label = array()

key is the locale code

Tags

$name

public string $name = ''

the name of the module, used as identifier in jelix selectors or other part of the code

Tags

$version

public string $version = ''

version of the module/app. required for modules

Tags

$versionDate

public string $versionDate = ''

the release date of the module/app. required for modules

Tags

$path

protected string $path = ''

the path to the module/app information file

Tags

Methods

__construct()

InfosAbstract constructor.

public __construct(string $filePath, bool $isXml) : mixed
Parameters
$filePath : string

the path of the xml file to read

$isXml : bool
Tags
Return values
mixed

getDescription()

public getDescription([mixed $locale = '' ]) : mixed
Parameters
$locale : mixed = ''
Tags
Return values
mixed

getFilePath()

public getFilePath() : string
Tags
Return values
string

the path of the file to read/write

getItemPath()

public getItemPath() : mixed
Tags
Return values
mixed

getLabel()

public getLabel([mixed $locale = '' ]) : mixed
Parameters
$locale : mixed = ''
Tags
Return values
mixed

isXmlFile()

public isXmlFile() : bool
Tags
Return values
bool

load()

create a new ModuleInfos object, loaded from a file that is into the given directory.

public static load(string $directoryPath) : ModuleInfos
Parameters
$directoryPath : string

the path to the directory

Tags
Return values
ModuleInfos

save()

save the informations into the original file.

public save() : mixed
Tags
Return values
mixed

getLocale()

protected getLocale(mixed $locale) : mixed
Parameters
$locale : mixed
Tags
Return values
mixed

Search results