Jelix 1.6
Back to top  

jApp

package

jelix
subpackage

core

Methods

appPath

appPath( $file = '')
static

Arguments

$file

config

config() : object
static

Response

object

object containing all configuration options of the application

configPath

configPath( $file = '')
static

Arguments

$file

coord

coord() : \jCoordinator
static

Response

\jCoordinator

get the module name of the current context

getCurrentModule() : string
static

Response

string

name of the current module

return the real path of a module

getModulePath(string $module, boolean $includingExternal = false) : string
static
Throws
\Exception

Arguments

$module

string

a module name

$includingExternal

boolean

true if we want to know if the module is also an external module, e.g. in an other entry point

Response

string

the corresponding path

initialize the application paths

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

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

Arguments

$appPath

string

application directory

$wwwPath

string

www directory

$varPath

string

var directory

$logPath

string

log directory

$configPath

string

config directory

$scriptPath

string

scripts directory

indicate if path have been set

isInit() : boolean
static

Response

boolean

true if it is ok

Says if the given module $name is enabled

isModuleEnabled(string $moduleName, boolean $includingExternal = false) : boolean
static
Throws
\Exception

Arguments

$moduleName

string

$includingExternal

boolean

true if we want to know if the module is also an external module, e.g. in an other entry point

Response

boolean

true : module is ok

Load the configuration from the given file.

loadConfig(string|object $configFile, boolean $enableErrorHandler = true)
static

Call it after initPaths

Arguments

$configFile

string|object

name of the ini file to configure the framework or a configuration object

$enableErrorHandler

boolean

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

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

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

Arguments

$name

string

the name of the plugin

$type

string

the type of the plugin

$suffix

string

the suffix of the filename

$classname

string

the name of the class to instancy

$args

mixed

the argument for the constructor of the class. null = no argument.

Response

null|object

null if the plugin doesn't exists

logPath

logPath( $file = '')
static

Arguments

$file

Main config file path

mainConfigFile()
static

cancel the current context and set the context to the previous module

popCurrentModule() : string
static

Response

string

the obsolet module name

set the context to the given module

pushCurrentModule(string $module)
static

Arguments

$module

string

the module name

restore the previous context of the application

restoreContext()
static

save all path and others variables relatives to the application, so you can temporary change the context to an other application

saveContext()
static

scriptsPath

scriptsPath( $file = '')
static

Arguments

$file

setConfig

setConfig( $config)
static

Arguments

$config

setCoord

setCoord(\jCoordinator $coord)
static

Arguments

$coord

\jCoordinator

setEnv

setEnv( $env)
static

Arguments

$env

setTempBasePath

setTempBasePath( $path)
static

Arguments

$path

tempBasePath

tempBasePath()
static

tempPath

tempPath( $file = '')
static

Arguments

$file

urlBasePath

urlBasePath()
static

varPath

varPath( $file = '')
static

Arguments

$file

wwwPath

wwwPath( $file = '')
static

Arguments

$file

Properties

tempBasePath

tempBasePath :
static

Type(s)

appPath

appPath :
static

Type(s)

varPath

varPath :
static

Type(s)

logPath

logPath :
static

Type(s)

configPath

configPath :
static

Type(s)

wwwPath

wwwPath :
static

Type(s)

scriptPath

scriptPath :
static

Type(s)

_isInit

_isInit :
static

Type(s)

env

env :
static

Type(s)

configAutoloader

configAutoloader :
static

Type(s)

object containing all configuration options of the application

_config : object
static
var

object containing all configuration options of the application

Type(s)

object

_mainConfigFile

_mainConfigFile :
static

Type(s)

_coord

_coord : \jCoordinator
static
var

Type(s)

\jCoordinator

contextBackup

contextBackup :
static

Type(s)

modulesContext

modulesContext :
static

Type(s)