ModuleInfos
extends InfosAbstract
in package
Information about the module, retrieved from its module.xml file.
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
$author
public
array<string|int, Author>
$author
= array()
$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
$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>', '
$autoloaders
List of files that initialize an autoloader.
public
array<string|int, string>
$autoloaders
= array()
$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>', '
$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>', '
$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>', '
$copyright
public
mixed
$copyright
= ''
$createDate
public
string
$createDate
= ''
the birthdate of the module/app. optional
$dependencies
list of module dependencies.
public
array<string|int, array<string|int, mixed>>
$dependencies
= array()
items are: array('name'=>'', 'version'=>'', 'optional'=>true/false)
$description
public
array<string|int, string>
$description
= array()
key is the locale code
$homepageURL
public
mixed
$homepageURL
= ''
$id
public
string
$id
= ''
unique id (e.g. 'name@company')
$incompatibilities
list of incompatibilities of the module.
public
array<string|int, array<string|int, mixed>>
$incompatibilities
= array()
items are array('name'=>'', 'version'=>'')
$label
public
array<string|int, string>
$label
= array()
key is the locale code
$license
public
mixed
$license
= ''
$licenseURL
public
mixed
$licenseURL
= ''
$name
public
string
$name
= ''
the name of the module, used as identifier in jelix selectors or other part of the code
$notes
public
mixed
$notes
= ''
$updateURL
public
mixed
$updateURL
= ''
$version
public
string
$version
= ''
version of the module/app. required for modules
$versionDate
public
string
$versionDate
= ''
the release date of the module/app. required for modules
$versionStability
public
mixed
$versionStability
= ''
$_exists
protected
mixed
$_exists
= false
$isXml
protected
mixed
$isXml
= false
$path
protected
string
$path
= ''
the path to the module/app information file
Methods
__construct()
InfosAbstract constructor.
public
__construct(string $filePath, bool $isXml) : mixed
Parameters
- $filePath : string
-
the path of the xml file to read
- $isXml : bool
Return values
mixed —exists()
public
exists() : bool
Return values
bool —getDescription()
public
getDescription([mixed $locale = '' ]) : mixed
Parameters
- $locale : mixed = ''
Return values
mixed —getFilePath()
public
getFilePath() : string
Return values
string —the path of the file to read/write
getItemPath()
public
getItemPath() : mixed
Return values
mixed —getLabel()
public
getLabel([mixed $locale = '' ]) : mixed
Parameters
- $locale : mixed = ''
Return values
mixed —isXmlFile()
public
isXmlFile() : bool
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
Return values
ModuleInfos —save()
save the informations into the original file.
public
save() : mixed
Return values
mixed —getLocale()
protected
getLocale(mixed $locale) : mixed
Parameters
- $locale : mixed