Jelix 1.8.11-rc.2

AppInfos extends InfosAbstract
in package

Tags

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
load()  : AppInfos
create a new AppInfos object, loaded from a file that is into the given directory.
save()  : mixed
save the informations into the original file.
getLocale()  : mixed

Properties

$createDate

public string $createDate = ''

the birthdate of the module/app. optional

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

$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 AppInfos object, loaded from a file that is into the given directory.

public static load([string $directoryPath = '' ][, mixed $fileName = '' ]) : AppInfos
Parameters
$directoryPath : string = ''

the path to the application directory

$fileName : mixed = ''
Tags
Return values
AppInfos

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