jApp
in package
Table of Contents
- $_currentApp : jAppInstance
- $_mainConfigFile : mixed
- $contextBackup : mixed
- __callStatic() : mixed
- allows to call some methods on the current instance as static methods on jApp.
- app() : mixed
- appConfigPath() : string
- applicationInitFile() : mixed
- appPath() : mixed
- appSystemPath() : mixed
- clearModulesPluginsPath() :
- config() : object
- configPath() : string
- coord() : jCoordinator
- declareModule() :
- declareModulesDir() :
- declareModulesFromConfig() :
- declarePluginsDir() :
- getAllModulesPath() :
- getAllPluginsPath() :
- getCurrentModule() :
- getDeclaredModulesDir() :
- getEnabledModulesPaths() :
- getModulePath() :
- includePlugin() :
- initPaths() : mixed
- initialize the application paths.
- isInit() : bool
- indicate if path have been set.
- isModuleEnabled() :
- loadConfig() : mixed
- Load the configuration from the given file.
- loadPlugin() :
- logPath() : mixed
- mainConfigFile() : mixed
- Main config file path.
- popCurrentModule() :
- pushCurrentModule() :
- restoreContext() : mixed
- restore the previous context of the application.
- saveContext() : mixed
- save all path and others variables relatives to the application, so you can temporary change the context to an other application.
- scriptsPath() : string
- setConfig() :
- setCoord() : mixed
- setEnv() : mixed
- setTempBasePath() : mixed
- tempBasePath() : mixed
- tempPath() : mixed
- urlBasePath() : mixed
- urlJelixWWWPath() : mixed
- varConfigPath() : mixed
- varPath() : mixed
- version() : string
- return the version of the application containing into a VERSION file It doesn't read the version from project.xml or composer.json.
- wwwPath() : mixed
Properties
$_currentApp
protected
static jAppInstance
$_currentApp
$_mainConfigFile
protected
static mixed
$_mainConfigFile
$contextBackup
protected
static mixed
$contextBackup
= array()
Methods
__callStatic()
allows to call some methods on the current instance as static methods on jApp.
public
static __callStatic(mixed $name, mixed $arguments) : mixed
Parameters
- $name : mixed
- $arguments : mixed
Return values
mixed —app()
public
static app() : mixed
Return values
mixed —appConfigPath()
public
static appConfigPath([string $file = '' ]) : string
Parameters
- $file : string = ''
Tags
Return values
string —applicationInitFile()
public
static applicationInitFile() : mixed
Return values
mixed —appPath()
public
static appPath([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''
Return values
mixed —appSystemPath()
public
static appSystemPath([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''
Return values
mixed —clearModulesPluginsPath()
public
static clearModulesPluginsPath() :
Return values
—config()
public
static config() : object
Return values
object —object containing all configuration options of the application
configPath()
public
static configPath([string $file = '' ]) : string
Parameters
- $file : string = ''
Tags
Return values
string —coord()
public
static coord() : jCoordinator
Return values
jCoordinator —declareModule()
public
static declareModule(mixed $modulePath) :
Parameters
- $modulePath : mixed
Return values
—declareModulesDir()
public
static declareModulesDir(mixed $basePath, mixed $modules) :
Parameters
- $basePath : mixed
- $modules : mixed
Return values
—declareModulesFromConfig()
public
static declareModulesFromConfig(mixed $config) :
Parameters
- $config : mixed
Return values
—declarePluginsDir()
public
static declarePluginsDir(mixed $basePath) :
Parameters
- $basePath : mixed
Return values
—getAllModulesPath()
public
static getAllModulesPath() :
Return values
—getAllPluginsPath()
public
static getAllPluginsPath() :
Return values
—getCurrentModule()
public
static getCurrentModule() :
Return values
—getDeclaredModulesDir()
public
static getDeclaredModulesDir() :
Return values
—getEnabledModulesPaths()
public
static getEnabledModulesPaths() :
Return values
—getModulePath()
public
static getModulePath(mixed $module, mixed $includingExternal) :
Parameters
- $module : mixed
- $includingExternal : mixed
Return values
—includePlugin()
public
static includePlugin(mixed $name, mixed $type, mixed $suffix, mixed $classname) :
Parameters
- $name : mixed
- $type : mixed
- $suffix : mixed
- $classname : mixed
Return values
—initPaths()
initialize the application paths.
public
static initPaths(string $appPath[, string $wwwPath = null ][, string $varPath = null ][, string $logPath = null ][, string $configPath = null ][, string $scriptPath = null ]) : mixed
Warning: given paths should be ended by a directory separator.
Parameters
- $appPath : string
-
application directory
- $wwwPath : string = null
-
www directory
- $varPath : string = null
-
var directory
- $logPath : string = null
-
log directory
- $configPath : string = null
-
var config directory
- $scriptPath : string = null
-
scripts directory (deprecated)
Return values
mixed —isInit()
indicate if path have been set.
public
static isInit() : bool
Return values
bool —true if it is ok
isModuleEnabled()
public
static isModuleEnabled(mixed $moduleName, mixed $includingExternal) :
Parameters
- $moduleName : mixed
- $includingExternal : mixed
Return values
—loadConfig()
Load the configuration from the given file.
public
static loadConfig(object|string $configFile[, bool $enableErrorHandler = true ]) : mixed
Call it after initPaths
Parameters
- $configFile : object|string
-
name of the ini file to configure the framework or a configuration object
- $enableErrorHandler : bool = true
-
enable the error handler of jelix. keep it to true, unless you have something to debug and really have to use the default handler or an other handler
Return values
mixed —loadPlugin()
public
static loadPlugin(mixed $name, mixed $type, mixed $suffix, mixed $classname, mixed $args) :
Parameters
- $name : mixed
- $type : mixed
- $suffix : mixed
- $classname : mixed
- $args : mixed
Return values
—logPath()
public
static logPath([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''
Return values
mixed —mainConfigFile()
Main config file path.
public
static mainConfigFile() : mixed
Return values
mixed —popCurrentModule()
public
static popCurrentModule() :
Return values
—pushCurrentModule()
public
static pushCurrentModule(mixed $module) :
Parameters
- $module : mixed
Return values
—restoreContext()
restore the previous context of the application.
public
static restoreContext() : mixed
Return values
mixed —saveContext()
save all path and others variables relatives to the application, so you can temporary change the context to an other application.
public
static saveContext() : mixed
Return values
mixed —scriptsPath()
public
static scriptsPath([string $file = '' ]) : string
Parameters
- $file : string = ''
Tags
Return values
string —setConfig()
public
static setConfig(mixed $config) :
Parameters
- $config : mixed
Return values
—setCoord()
public
static setCoord(jCoordinator $coord) : mixed
Parameters
- $coord : jCoordinator
Return values
mixed —setEnv()
public
static setEnv(mixed $env) : mixed
Parameters
- $env : mixed
Return values
mixed —setTempBasePath()
public
static setTempBasePath(mixed $path) : mixed
Parameters
- $path : mixed
Return values
mixed —tempBasePath()
public
static tempBasePath() : mixed
Return values
mixed —tempPath()
public
static tempPath([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''
Return values
mixed —urlBasePath()
public
static urlBasePath() : mixed
Return values
mixed —urlJelixWWWPath()
public
static urlJelixWWWPath() : mixed
Return values
mixed —varConfigPath()
public
static varConfigPath([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''
Return values
mixed —varPath()
public
static varPath([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''
Return values
mixed —version()
return the version of the application containing into a VERSION file It doesn't read the version from project.xml or composer.json.
public
static version() : string
Return values
string —wwwPath()
public
static wwwPath([mixed $file = '' ]) : mixed
Parameters
- $file : mixed = ''