CApplication

所有包 | 属性 | 方法 | 事件

包	system.base
继承	abstract class CApplication » CModule » CComponent
子类	CConsoleApplication, CWebApplication
可用自	1.0
版本	$Id$

CApplication is the base class for all application classes.

An application serves as the global context that the user request is being processed. It manages a set of application components that provide specific functionalities to the whole application.

The core application components provided by CApplication are the following:

errorHandler: handles PHP errors and uncaught exceptions. This application component is dynamically loaded when needed.
securityManager: provides security-related services, such as hashing, encryption. This application component is dynamically loaded when needed.
statePersister: provides global state persistence method. This application component is dynamically loaded when needed.
cache: provides caching feature. This application component is disabled by default.
messages: provides the message source for translating application messages. This application component is dynamically loaded when needed.
coreMessages: provides the message source for translating Yii framework messages. This application component is dynamically loaded when needed.

CApplication will undergo the following lifecycles when processing a user request:

load application configuration;
set up class autoloader and error handling;
load static application components;
onBeginRequest: preprocess the user request;
processRequest: process the user request;
onEndRequest: postprocess the user request;

Starting from lifecycle 3, if a PHP error or an uncaught exception occurs, the application will switch to its error handling logic and jump to step 6 afterwards.

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
basePath	string	the root directory of the application.	CApplication
behaviors	array	the behaviors that should be attached to the module.	CModule
cache	CCache	the cache application component.	CApplication
charset	string	the charset currently used for the application.	CApplication
components	array	the currently loaded components (indexed by their IDs)	CModule
coreMessages	CPhpMessageSource	the core message translations	CApplication
dateFormatter	CDateFormatter	the locale-dependent date formatter.	CApplication
db	CDbConnection	the database connection	CApplication
errorHandler	CErrorHandler	the error handler application component.	CApplication
extensionPath	string	Returns the root directory that holds all third-party extensions.	CApplication
id	string	a unique identifier for the application.	CApplication
language	string	the language that the user is using and the application should be targeted to.	CApplication
locale	CLocale	the locale instance	CApplication
messages	CMessageSource	the application message translations	CApplication
modulePath	string	the directory that contains the application modules.	CModule
modules	array	the configuration of the currently installed modules (module ID => configuration)	CModule
name	string	the application name.	CApplication
numberFormatter	CNumberFormatter	the locale-dependent number formatter.	CApplication
params	CAttributeCollection	the list of user-defined parameters	CModule
parentModule	CModule	the parent module.	CModule
preload	array	the IDs of the application components that should be preloaded.	CModule
request	CHttpRequest	the request component	CApplication
runtimePath	string	the directory that stores runtime files.	CApplication
securityManager	CSecurityManager	the security manager application component.	CApplication
sourceLanguage	string	the language that the application is written in.	CApplication
statePersister	CStatePersister	the state persister application component.	CApplication
timeZone	string	Returns the time zone used by this application.	CApplication
urlManager	CUrlManager	the URL manager component	CApplication

公共方法

隐藏继承的方法

方法	描述	被定义在
__call()	Calls the named method which is not a class method.	CComponent
__construct()	Constructor.	CApplication
__get()	Getter magic method.	CModule
__isset()	Checks if a property value is null.	CModule
__set()	Sets value of a component property.	CComponent
__unset()	Sets a component property to be null.	CComponent
asa()	Returns the named behavior object.	CComponent
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
clearGlobalState()	Clears a global value.	CApplication
configure()	Configures the module with the specified configuration.	CModule
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
displayError()	Displays the captured PHP error.	CApplication
displayException()	Displays the uncaught PHP exception.	CApplication
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
end()	Terminates the application.	CApplication
findLocalizedFile()	Returns the localized version of a specified file.	CApplication
getBasePath()		CApplication
getCache()		CApplication
getComponent()	Retrieves the named application component.	CModule
getComponents()		CModule
getCoreMessages()		CApplication
getDateFormatter()		CApplication
getDb()		CApplication
getErrorHandler()		CApplication
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getExtensionPath()	Returns the root directory that holds all third-party extensions.	CApplication
getGlobalState()	Returns a global value.	CApplication
getId()		CApplication
getLanguage()		CApplication
getLocale()		CApplication
getMessages()		CApplication
getModule()	Retrieves the named application module.	CModule
getModulePath()		CModule
getModules()		CModule
getNumberFormatter()		CApplication
getParams()		CModule
getParentModule()		CModule
getRequest()		CApplication
getRuntimePath()		CApplication
getSecurityManager()		CApplication
getStatePersister()		CApplication
getTimeZone()	Returns the time zone used by this application.	CApplication
getUrlManager()		CApplication
handleError()	Handles PHP execution errors such as warnings, notices.	CApplication
handleException()	Handles uncaught PHP exceptions.	CApplication
hasComponent()		CModule
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasProperty()	Determines whether a property is defined.	CComponent
onBeginRequest()	Raised right BEFORE the application processes the request.	CApplication
onEndRequest()	Raised right AFTER the application processes the request.	CApplication
onError()	Raised when a PHP execution error occurs.	CApplication
onException()	Raised when an uncaught PHP exception occurs.	CApplication
processRequest()	Processes the request.	CApplication
raiseEvent()	Raises an event.	CComponent
run()	Runs the application.	CApplication
setAliases()	Defines the root aliases.	CModule
setBasePath()	Sets the root directory of the application.	CApplication
setComponent()	Puts a component under the management of the module.	CModule
setComponents()	Sets the application components.	CModule
setExtensionPath()		CApplication
setGlobalState()	Sets a global value.	CApplication
setId()		CApplication
setImport()	Sets the aliases that are used in the module.	CModule
setLanguage()	Specifies which language the application is targeted to.	CApplication
setModulePath()		CModule
setModules()	Configures the sub-modules of this module.	CModule
setParams()		CModule
setRuntimePath()		CApplication
setTimeZone()	Sets the time zone used by this application.	CApplication

受保护的方法

隐藏继承的方法

方法	描述	被定义在
init()	Initializes the module.	CModule
initSystemHandlers()	Initializes the class autoloader and error handlers.	CApplication
loadGlobalState()	Loads the global state data from persistent storage.	CApplication
preinit()	Preinitializes the module.	CModule
preloadComponents()	Loads static application components.	CModule
registerCoreComponents()	Registers the core application components.	CApplication
saveGlobalState()	Saves the global state data into persistent storage.	CApplication

事件

隐藏继承的事件

事件	描述	被定义在
onBeginRequest	Raised right BEFORE the application processes the request.	CApplication
onEndRequest	Raised right AFTER the application processes the request.	CApplication
onException	Raised when an uncaught PHP exception occurs.	CApplication
onError	Raised when a PHP execution error occurs.	CApplication

属性详情

basePath 属性

public string getBasePath()
public void setBasePath(string $path)

the root directory of the application. Defaults to 'protected'.

cache 属性只读

public CCache getCache()

the cache application component. Null if the component is not enabled.

charset 属性

public string $charset;

the charset currently used for the application. Defaults to 'UTF-8'.

coreMessages 属性只读

public CPhpMessageSource getCoreMessages()

the core message translations

dateFormatter 属性只读

public CDateFormatter getDateFormatter()

the locale-dependent date formatter. The current application locale will be used.

db 属性只读

public CDbConnection getDb()

the database connection

errorHandler 属性只读

public CErrorHandler getErrorHandler()

the error handler application component.

extensionPath 属性

public string getExtensionPath()
public void setExtensionPath(string $path)

Returns the root directory that holds all third-party extensions.

id 属性

public string getId()
public void setId(string $id)

a unique identifier for the application.

language 属性

public string getLanguage()
public void setLanguage(string $language)

the language that the user is using and the application should be targeted to. Defaults to the source language.

locale 属性只读

public CLocale getLocale(string $localeID=NULL)

the locale instance

messages 属性只读

public CMessageSource getMessages()

the application message translations

name 属性

public string $name;

the application name. Defaults to 'My Application'.

numberFormatter 属性只读

public CNumberFormatter getNumberFormatter()

the locale-dependent number formatter. The current application locale will be used.

request 属性只读

public CHttpRequest getRequest()

the request component

runtimePath 属性

public string getRuntimePath()
public void setRuntimePath(string $path)

the directory that stores runtime files. Defaults to 'protected/runtime'.

securityManager 属性只读

public CSecurityManager getSecurityManager()

the security manager application component.

sourceLanguage 属性

public string $sourceLanguage;

the language that the application is written in. This mainly refers to the language that the messages and view files are in. Defaults to 'en_us' (US English).

statePersister 属性只读

public CStatePersister getStatePersister()

the state persister application component.

timeZone 属性（自版本 v1.0.9 可用）

public string getTimeZone()
public void setTimeZone(string $value)

Returns the time zone used by this application. This is a simple wrapper of PHP function date_default_timezone_get().

参见

http://php.net/manual/en/function.date-default-timezone-get.php

urlManager 属性只读

public CUrlManager getUrlManager()

the URL manager component

方法详情

__construct() 方法

public void __construct(mixed $config=NULL)
$config	mixed	application configuration. If a string, it is treated as the path of the file that contains the configuration; If an array, it is the actual configuration information. Please make sure you specify the basePath property in the configuration, which should point to the directory containing all application logic, template and data. If not, the directory will be defaulted to 'protected'.

Constructor.

clearGlobalState() 方法

public void clearGlobalState(string $key)
$key	string	the name of the value to be cleared

Clears a global value.

The value cleared will no longer be available in this request and the following requests.

displayError() 方法

public void displayError(integer $code, string $message, string $file, string $line)
$code	integer	error code
$message	string	error message
$file	string	error file
$line	string	error line

Displays the captured PHP error. This method displays the error in HTML when there is no active error handler.

displayException() 方法

public void displayException(Exception $exception)
$exception	Exception	the uncaught exception

Displays the uncaught PHP exception. This method displays the exception in HTML when there is no active error handler.

end() 方法

public void end(integer $status=0)
$status	integer	exit status (value 0 means normal exit while other values mean abnormal exit).

Terminates the application. This method replaces PHP's exit() function by calling onEndRequest before exiting.

findLocalizedFile() 方法

public string findLocalizedFile(string $srcFile, string $srcLanguage=NULL, string $language=NULL)
$srcFile	string	the original file
$srcLanguage	string	the language that the original file is in. If null, the application source language is used.
$language	string	the desired language that the file should be localized to. If null, the application language will be used.
{return}	string	the matching localized file. The original file is returned if no localized version is found or if source language is the same as the desired language.

Returns the localized version of a specified file.

The searching is based on the specified language code. In particular, a file with the same name will be looked for under the subdirectory named as the locale ID. For example, given the file "path/to/view.php" and locale ID "zh_cn", the localized file will be looked for as "path/to/zh_cn/view.php". If the file is not found, the original file will be returned.

For consistency, it is recommended that the locale ID is given in lower case and in the format of LanguageID_RegionID (e.g. "en_us").

getBasePath() 方法

public string getBasePath()
{return}	string	the root directory of the application. Defaults to 'protected'.

getCache() 方法

public CCache getCache()
{return}	CCache	the cache application component. Null if the component is not enabled.

getCoreMessages() 方法

public CPhpMessageSource getCoreMessages()
{return}	CPhpMessageSource	the core message translations

getDateFormatter() 方法

public CDateFormatter getDateFormatter()
{return}	CDateFormatter	the locale-dependent date formatter. The current application locale will be used.

getDb() 方法

public CDbConnection getDb()
{return}	CDbConnection	the database connection

getErrorHandler() 方法

public CErrorHandler getErrorHandler()
{return}	CErrorHandler	the error handler application component.

getExtensionPath() 方法

public string getExtensionPath()
{return}	string	the directory that contains all extensions. Defaults to the 'extensions' directory under 'protected'.

Returns the root directory that holds all third-party extensions.

getGlobalState() 方法

public mixed getGlobalState(string $key, mixed $defaultValue=NULL)
$key	string	the name of the value to be returned
$defaultValue	mixed	the default value. If the named global value is not found, this will be returned instead.
{return}	mixed	the named global value

Returns a global value.

A global value is one that is persistent across users sessions and requests.

参见

setGlobalState

getId() 方法

public string getId()
{return}	string	a unique identifier for the application.

getLanguage() 方法

public string getLanguage()
{return}	string	the language that the user is using and the application should be targeted to. Defaults to the source language.

getLocale() 方法

public CLocale getLocale(string $localeID=NULL)
$localeID	string	locale ID (e.g. en_US). If null, the application language ID will be used.
{return}	CLocale	the locale instance

getMessages() 方法

public CMessageSource getMessages()
{return}	CMessageSource	the application message translations

getNumberFormatter() 方法

public CNumberFormatter getNumberFormatter()
{return}	CNumberFormatter	the locale-dependent number formatter. The current application locale will be used.

getRequest() 方法

public CHttpRequest getRequest()
{return}	CHttpRequest	the request component

getRuntimePath() 方法

public string getRuntimePath()
{return}	string	the directory that stores runtime files. Defaults to 'protected/runtime'.

getSecurityManager() 方法

public CSecurityManager getSecurityManager()
{return}	CSecurityManager	the security manager application component.

getStatePersister() 方法

public CStatePersister getStatePersister()
{return}	CStatePersister	the state persister application component.

getTimeZone() 方法（自版本 v1.0.9 可用）

public string getTimeZone()
{return}	string	the time zone used by this application.

Returns the time zone used by this application. This is a simple wrapper of PHP function date_default_timezone_get().

参见

http://php.net/manual/en/function.date-default-timezone-get.php

getUrlManager() 方法

public CUrlManager getUrlManager()
{return}	CUrlManager	the URL manager component

handleError() 方法

public void handleError(integer $code, string $message, string $file, integer $line)
$code	integer	the level of the error raised
$message	string	the error message
$file	string	the filename that the error was raised in
$line	integer	the line number the error was raised at

Handles PHP execution errors such as warnings, notices.

This method is implemented as a PHP error handler. It requires that constant YII_ENABLE_ERROR_HANDLER be defined true.

This method will first raise an onError event. If the error is not handled by any event handler, it will call errorHandler to process the error.

The application will be terminated by this method.

handleException() 方法

public void handleException(Exception $exception)
$exception	Exception	exception that is not caught

Handles uncaught PHP exceptions.

This method is implemented as a PHP exception handler. It requires that constant YII_ENABLE_EXCEPTION_HANDLER be defined true.

This method will first raise an onException event. If the exception is not handled by any event handler, it will call errorHandler to process the exception.

The application will be terminated by this method.

initSystemHandlers() 方法

protected void initSystemHandlers()

Initializes the class autoloader and error handlers.

loadGlobalState() 方法

protected void loadGlobalState()

Loads the global state data from persistent storage.

参见

getStatePersister

onBeginRequest() 方法

public void onBeginRequest(CEvent $event)
$event	CEvent	the event parameter

Raised right BEFORE the application processes the request.

onEndRequest() 方法

public void onEndRequest(CEvent $event)
$event	CEvent	the event parameter

Raised right AFTER the application processes the request.

onError() 方法

public void onError(CErrorEvent $event)
$event	CErrorEvent	event parameter

Raised when a PHP execution error occurs.

An event handler can set the handled property of the event parameter to be true to indicate no further error handling is needed. Otherwise, the errorHandler application component will continue processing the error.

onException() 方法

public void onException(CExceptionEvent $event)
$event	CExceptionEvent	event parameter

Raised when an uncaught PHP exception occurs.

An event handler can set the handled property of the event parameter to be true to indicate no further error handling is needed. Otherwise, the errorHandler application component will continue processing the error.

processRequest() 方法

abstract public void processRequest()

Processes the request. This is the place where the actual request processing work is done. Derived classes should override this method.

registerCoreComponents() 方法

protected void registerCoreComponents()

Registers the core application components.

参见

setComponents

run() 方法

public void run()

Runs the application. This method loads static application components. Derived classes usually overrides this method to do more application-specific tasks. Remember to call the parent implementation so that static application components are loaded.

saveGlobalState() 方法

protected void saveGlobalState()

Saves the global state data into persistent storage.

参见

getStatePersister

setBasePath() 方法

public void setBasePath(string $path)
$path	string	the root directory of the application.

Sets the root directory of the application. This method can only be invoked at the begin of the constructor.

setExtensionPath() 方法

public void setExtensionPath(string $path)
$path	string	the directory that contains all third-party extensions.

setGlobalState() 方法

public void setGlobalState(string $key, mixed $value, mixed $defaultValue=NULL)
$key	string	the name of the value to be saved
$value	mixed	the global value to be saved. It must be serializable.
$defaultValue	mixed	the default value. If the named global value is the same as this value, it will be cleared from the current storage.

Sets a global value.

A global value is one that is persistent across users sessions and requests. Make sure that the value is serializable and unserializable.

参见

getGlobalState

setId() 方法

public void setId(string $id)
$id	string	a unique identifier for the application.

setLanguage() 方法

public void setLanguage(string $language)
$language	string	the user language (e.g. 'en_US', 'zh_CN'). If it is null, the sourceLanguage will be used.

Specifies which language the application is targeted to.

This is the language that the application displays to end users. If set null, it uses the source language.

Unless your application needs to support multiple languages, you should always set this language to null to maximize the application's performance.

setRuntimePath() 方法

public void setRuntimePath(string $path)
$path	string	the directory that stores runtime files.

setTimeZone() 方法（自版本 v1.0.9 可用）

public void setTimeZone(string $value)
$value	string	the time zone used by this application.

Sets the time zone used by this application. This is a simple wrapper of PHP function date_default_timezone_set().

参见

http://php.net/manual/en/function.date-default-timezone-set.php