InfosAbstract
in package
Table of Contents
- $author : array<string|int, Author>
- $copyright : mixed
- $createDate : string
- $description : array<string|int, string>
- $homepageURL : mixed
- $id : string
- $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
- save() : mixed
- save the informations into the original file.
- getLocale() : mixed
Properties
$author
public
array<string|int, Author>
$author
= array()
$copyright
public
mixed
$copyright
= ''
$createDate
public
string
$createDate
= ''
the birthdate of the module/app. optional
$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')
$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 —save()
save the informations into the original file.
public
abstract save() : mixed
Return values
mixed —getLocale()
protected
getLocale(mixed $locale) : mixed
Parameters
- $locale : mixed