Docs For Class jApp

Description

Located in /core/jApp.class.php (line 16)

Variable Summary

static mixed $appPath

static mixed $configPath

static mixed $contextBackup

static mixed $env

static mixed $logPath

static mixed $scriptPath

static mixed $tempBasePath

static mixed $tempPath

static mixed $varPath

static mixed $wwwPath

static mixed $_isInit

Method Summary

static void appPath ([ $file = ''])

static void configPath ([ $file = ''])

static void initLegacy ()

static void initPaths (string $appPath, [string $wwwPath = null], [string $varPath = null], [string $logPath = null], [string $configPath = null], [string $scriptPath = null])

static boolean isInit ()

static null|object loadPlugin (string $name, string $type, string $suffix, string $classname, [mixed $args = null])

static void logPath ([ $file = ''])

static void restoreContext ()

static void saveContext ()

static void scriptsPath ([ $file = ''])

static void setEnv ( $env)

static void setTempBasePath ( $path)

static void tempBasePath ()

static void tempPath ([ $file = ''])

static void varPath ([ $file = ''])

static void wwwPath ([ $file = ''])

Variables

static mixed $appPath = '' (line 22)

access: protected

static mixed $configPath = '' (line 28)

access: protected

static mixed $contextBackup = array() (line 120)

access: protected

static mixed $env = 'www/' (line 36)

access: protected

static mixed $logPath = '' (line 26)

access: protected

static mixed $scriptPath = '' (line 32)

access: protected

static mixed $tempBasePath = '' (line 18)

access: protected

static mixed $tempPath = '' (line 20)

access: protected

static mixed $varPath = '' (line 24)

access: protected

static mixed $wwwPath = '' (line 30)

access: protected

static mixed $_isInit = false (line 34)

access: protected

Methods

static appPath (line 101)

access: public

static void appPath ([ $file = ''])

$file

static configPath (line 104)

access: public

static void configPath ([ $file = ''])

$file

static initLegacy (line 79)

init path from JELIX_APP_* defines or define JELIX_APP_*, depending of how the bootstrap has been initialized.

The goal of this method is to support the transition between the old way of defining path, and the new way in jelix 1.3.

deprecated:
access: public

static void initLegacy ()

static initPaths (line 49)

initialize the application paths

Warning: given paths should be ended by a directory separator.

access: public

static void initPaths (string $appPath, [string $wwwPath = null], [string $varPath = null], [string $logPath = null], [string $configPath = null], [string $scriptPath = null])

string $appPath: application directory
string $wwwPath: www directory
string $varPath: var directory
string $logPath: log directory
string $configPath: config directory
string $scriptPath: scripts directory

static isInit (line 69)

indicate if path have been set

return: true if it is ok
access: public

static boolean isInit ()

static loadPlugin (line 150)

load a plugin from a plugin directory (any type of plugins)

return: null if the plugin doesn't exists
access: public

static null|object loadPlugin (string $name, string $type, string $suffix, string $classname, [mixed $args = null])

string $name: the name of the plugin
string $type: the type of the plugin
string $suffix: the suffix of the filename
string $classname: the name of the class to instancy
mixed $args: the argument for the constructor of the class. null = no argument.

static logPath (line 103)

access: public

static void logPath ([ $file = ''])

$file

static restoreContext (line 134)

restore the previous context of the application

access: public

static void restoreContext ()

static saveContext (line 126)

save all path and others variables relatives to the application, so you can

temporary change the context to an other application

access: public

static void saveContext ()

static scriptsPath (line 106)

access: public

static void scriptsPath ([ $file = ''])

$file

static setEnv (line 114)

access: public

static void setEnv ( $env)

$env

static setTempBasePath (line 110)

access: public

static void setTempBasePath ( $path)

$path

static tempBasePath (line 108)

access: public

static void tempBasePath ()

static tempPath (line 107)

access: public

static void tempPath ([ $file = ''])

$file

static varPath (line 102)

access: public

static void varPath ([ $file = ''])

$file

static wwwPath (line 105)

access: public

static void wwwPath ([ $file = ''])

$file