AppInfos

Extends \Jelix\Core\Infos\InfosAbstract

package

Default

Methods

InfosAbstract constructor.

__construct(string $filePath, boolean $isXml) 
inherited

Arguments

$filePath

string

the path of the xml file to read

$isXml

boolean

exists

exists() : boolean
inherited

Response

boolean

getDescription

getDescription( $locale = '') 
inherited

Arguments

$locale

getFilePath

getFilePath() : string
inherited

Response

string

the path of the file to read/write

getItemPath

getItemPath() 
inherited

getLabel

getLabel( $locale = '') 
inherited

Arguments

$locale

getLocale

getLocale( $locale) 
inherited

Arguments

$locale

isXmlFile

isXmlFile() : boolean
inherited

Response

boolean

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

load(string $directoryPath = '', mixed $fileName = '') : \Jelix\Core\Infos\AppInfos
static

Arguments

$directoryPath

string

the path to the application directory

$fileName

mixed

Response

\Jelix\Core\Infos\AppInfos

save the informations into the original file.

save() 
inherited abstract

Properties

the path to the module/app information file

path : string
inherited
var

the path to the module/app information file

Type(s)

string

isXml

isXml : 
inherited

Type(s)

_exists

_exists : 
inherited

Type(s)

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

id : string
inherited
var

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

Type(s)

string

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

name : string
inherited
var

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

Type(s)

string

the birth date of the module/app. optional

createDate : string
inherited
var

the birth date of the module/app. optional

Type(s)

string

version of the module/app. required for modules

version : string
inherited
var

version of the module/app. required for modules

Type(s)

string

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

versionDate : string
inherited
var

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

Type(s)

string

versionStability

versionStability : 
inherited

Type(s)

key is the locale code

label : array<mixed,string>
inherited
var

key is the locale code

Type(s)

array<mixed,string>

key is the locale code

description : array<mixed,string>
inherited
var

key is the locale code

Type(s)

array<mixed,string>

author

author : array<mixed,\Jelix\Core\Infos\Author>
inherited
var

Type(s)

array<mixed,\Jelix\Core\Infos\Author>

notes

notes : 
inherited

Type(s)

homepageURL

homepageURL : 
inherited

Type(s)

updateURL

updateURL : 
inherited

Type(s)

license

license : 
inherited

Type(s)

licenseURL

licenseURL : 
inherited

Type(s)