CommandConfig
in package
configuration for commands.
Tags
Table of Contents
- $appName : mixed
- name of the application. cannot be indicated into configuration files.
- $chmodDirValue : int
- $chmodFileValue : int
- $chownGroup : string
- $chownUser : string
- $debugMode : bool
- $doChmod : bool
- $doChown : bool
- $helpLang : string
- $infoCopyright : string
- $infoCreatorMail : string
- $infoCreatorName : string
- $infoIDSuffix : string
- $infoLicence : string
- $infoLicenceUrl : string
- $infoLocale : string
- $infoTimezone : string
- $infoWebsite : string
- $layoutConfigPath : mixed
- $layoutLogPath : mixed
- $layoutScriptsPath : mixed
- $layoutTempPath : mixed
- $layoutVarPath : mixed
- $layoutWwwPath : mixed
- $newAppInfoCopyright : string
- $newAppInfoIDSuffix : string
- $newAppInfoLicence : string
- $newAppInfoLicenceUrl : string
- $newAppInfoLocale : string
- $newAppInfoWebsite : string
- $verboseMode : bool
- __construct() : mixed
- copyAppInfo() : mixed
- generateUndefinedProperties() : mixed
- initAppPaths() : mixed
- loadFromIni() : mixed
- fill some properties from informations stored in an ini file.
- loadFromProject() : string
- fill some properties from informations stored into the project.xml file.
- _parseIniValue() : mixed
- getDomainName() : mixed
Properties
$appName
name of the application. cannot be indicated into configuration files.
public
mixed
$appName
= ''
Tags
$chmodDirValue
public
int
$chmodDirValue
= 0755
chmod value on new dir
Tags
$chmodFileValue
public
int
$chmodFileValue
= 0644
chmod value on new files
Tags
$chownGroup
public
string
$chownGroup
= ''
define the group owner of new files/dir
Tags
$chownUser
public
string
$chownUser
= ''
define the user owner of new files/dir
Tags
$debugMode
public
bool
$debugMode
= false
true = debug mode
Tags
$doChmod
public
bool
$doChmod
= false
true = a chmod is done on new files and directories
Tags
$doChown
public
bool
$doChown
= false
true = a chown is done on new files and directories
Tags
$helpLang
public
string
$helpLang
= 'en'
the lang code for help messages
Tags
$infoCopyright
public
string
$infoCopyright
= '_auto'
copyright of new files. value readed from project.xml
Tags
$infoCreatorMail
public
string
$infoCreatorMail
= '_auto'
the creator's mail inserted in new file headers
Tags
$infoCreatorName
public
string
$infoCreatorName
= '_auto'
the creator's name inserted in new files headers
Tags
$infoIDSuffix
public
string
$infoIDSuffix
= '_auto'
the suffix part of generated name of new modules. Value readed from project.xml. May be something like '@yourwebsite.undefined'
Tags
$infoLicence
public
string
$infoLicence
= 'All rights reserved'
the licence of generated files. value readed from project.xml
Tags
$infoLicenceUrl
public
string
$infoLicenceUrl
= ''
link to the licence. value readed from project.xml
Tags
$infoLocale
public
string
$infoLocale
= 'en_US'
default locale for new app
Tags
$infoTimezone
public
string
$infoTimezone
= 'Europe/Paris'
default timezone for new app
Tags
$infoWebsite
public
string
$infoWebsite
= ''
the web site of the project or your company. value readed from project.xml
Tags
$layoutConfigPath
public
mixed
$layoutConfigPath
= '%appdir%/var/config/'
Tags
$layoutLogPath
public
mixed
$layoutLogPath
= '%appdir%/var/log/'
Tags
$layoutScriptsPath
public
mixed
$layoutScriptsPath
= '%appdir%/scripts/'
Tags
$layoutTempPath
public
mixed
$layoutTempPath
= '%appdir%/temp/'
Tags
$layoutVarPath
public
mixed
$layoutVarPath
= '%appdir%/var/'
Tags
$layoutWwwPath
public
mixed
$layoutWwwPath
= '%appdir%/www/'
Tags
$newAppInfoCopyright
public
string
$newAppInfoCopyright
= '_auto'
copyright of new projects
Tags
$newAppInfoIDSuffix
public
string
$newAppInfoIDSuffix
= '_auto'
the suffix part of generated name of modules in a new project
Tags
$newAppInfoLicence
public
string
$newAppInfoLicence
= 'All rights reserved'
the licence of generated files, for a new project
Tags
$newAppInfoLicenceUrl
public
string
$newAppInfoLicenceUrl
= ''
link to the licence, for a new project
Tags
$newAppInfoLocale
public
string
$newAppInfoLocale
= 'en_US'
Tags
$newAppInfoWebsite
public
string
$newAppInfoWebsite
= ''
the web site of the project or your company, used in a new project
Tags
$verboseMode
public
bool
$verboseMode
= false
true = verbose mode, -v flag is implicit
Tags
Methods
__construct()
public
__construct() : mixed
Tags
Return values
mixed —copyAppInfo()
public
copyAppInfo([mixed $onlyUndefined = true ]) : mixed
Parameters
- $onlyUndefined : mixed = true
Tags
Return values
mixed —generateUndefinedProperties()
public
generateUndefinedProperties([mixed $toCreateApp = false ]) : mixed
Parameters
- $toCreateApp : mixed = false
Tags
Return values
mixed —initAppPaths()
public
initAppPaths(mixed $applicationDir) : mixed
Parameters
- $applicationDir : mixed
Tags
Return values
mixed —loadFromIni()
fill some properties from informations stored in an ini file.
public
loadFromIni(string $iniFile[, string $appname = '' ]) : mixed
Parameters
- $iniFile : string
-
the filename
- $appname : string = ''
-
the application name
Tags
Return values
mixed —loadFromProject()
fill some properties from informations stored into the project.xml file.
public
loadFromProject(mixed $projectFile) : string
Parameters
- $projectFile : mixed
Tags
Return values
string —the application name
_parseIniValue()
protected
_parseIniValue(mixed $key, mixed $value) : mixed
Parameters
- $key : mixed
- $value : mixed
Tags
Return values
mixed —getDomainName()
protected
getDomainName(mixed $url) : mixed
Parameters
- $url : mixed