CApplication

Package	system.base
Inheritance	abstract class CApplication » CModule » CComponent
Subclasses	CConsoleApplication, CWebApplication
Since	1.0
Source Code	framework/base/CApplication.php

Property Details

Returns the root path of the application.

Returns the relative URL for the application. This is a shortcut method to CHttpRequest::getBaseUrl().

Returns the cache component.

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

the currently active controller. Null is returned in this base class.

Returns the core message translations component.

Returns the locale-dependent date formatter.

Returns the database connection component.

Returns the error handler component.

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

Returns the formatter component.

the homepage URL

Returns the unique identifier for the application.

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

Returns the locale instance.

the class used to get locale data. Defaults to 'CLocale'.

Returns the directory that contains the locale data.

Returns the application message translations component.

the application name. Defaults to 'My Application'.

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

Returns the request component.

Returns the directory that stores runtime files.

Returns the security manager component.

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).

Returns the state persister component.

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

Returns the URL manager component.

Method Details

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.

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.

public string createAbsoluteUrl(string $route, array $params=array ( ), string $schema='', string $ampersand='&')
$route	string	the URL route. This should be in the format of 'ControllerID/ActionID'.
$params	array	additional GET parameters (name=>value). Both the name and value will be URL-encoded.
$schema	string	schema to use (e.g. http, https). If empty, the schema used for the current request will be used.
$ampersand	string	the token separating name-value pairs in the URL.
{return}	string	the constructed URL

Creates an absolute URL based on the given controller and action information.

public string createUrl(string $route, array $params=array ( ), string $ampersand='&')
$route	string	the URL route. This should be in the format of 'ControllerID/ActionID'.
$params	array	additional GET parameters (name=>value). Both the name and value will be URL-encoded.
$ampersand	string	the token separating name-value pairs in the URL.
{return}	string	the constructed URL

Creates a relative URL based on the given controller and action information.

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.

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.

public void end(integer $status=0, boolean $exit=true)
$status	integer	exit status (value 0 means normal exit while other values mean abnormal exit).
$exit	boolean	whether to exit the current request. This parameter has been available since version 1.1.5. It defaults to true, meaning the PHP's exit() function will be called at the end of this method.

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

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").

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

Returns the root path of the application.

public string getBaseUrl(boolean $absolute=false)
$absolute	boolean	whether to return an absolute URL. Defaults to false, meaning returning a relative one.
{return}	string	the relative URL for the application

Returns the relative URL for the application. This is a shortcut method to CHttpRequest::getBaseUrl().

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

Returns the cache component.

public CController getController()
{return}	CController	the currently active controller. Null is returned in this base class.

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

Returns the core message translations component.

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

Returns the locale-dependent date formatter.

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

Returns the database connection component.

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

Returns the error handler component.

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.

public CFormatter getFormat()
{return}	CFormatter	the formatter component

Returns the formatter component.

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.

public string getHomeUrl()
{return}	string	the homepage URL

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

Returns the unique identifier for the application.

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

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

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

Returns the locale instance.

public string getLocaleDataPath()
{return}	string	the directory that contains the locale data. It defaults to 'framework/i18n/data'.

Returns the directory that contains the locale data.

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

Returns the application message translations component.

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

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

Returns the request component.

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

Returns the directory that stores runtime files.

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

Returns the security manager component.

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

Returns the state persister component.

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().

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

Returns the URL manager component.

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.

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.

protected void initSystemHandlers()

Initializes the error handlers.

public void loadGlobalState()

Loads the global state data from persistent storage.

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

Raised right BEFORE the application processes the request.

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

Raised right AFTER the application processes the request.

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.

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.

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.

protected void registerCoreComponents()

Registers the core application components.

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.

public void saveGlobalState()

Saves the global state data into persistent storage.

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.

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

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

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.

public void setHomeUrl(string $value)
$value	string	the homepage URL

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

Sets the unique identifier for the application.

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.

public void setLocaleDataPath(string $value)
$value	string	the directory that contains the locale data.

Sets the directory that contains the locale data.

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

Sets the directory that stores runtime files.

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().