Yii Framework v1.1.10 类参考

CApplication

包	system.base
继承	abstract class CApplication » CModule » CComponent
子类	CConsoleApplication, CWebApplication
源自	1.0
版本	$Id: CApplication.php 3515 2011-12-28 12:29:24Z mdomba $
源码	framework/base/CApplication.php

属性详细

返回应用程序的根目录。

返回应用程序的相对URL。 快捷方法就是CHttpRequest::getBaseUrl()。

返回缓存组件。

应用程序当前使用的字符集。默认为‘UTF-8’。

当前活动控制器。为Null返回它的基类。

返回核心信息翻译组件。

返回本地化的日期格式。

返回数据库连接组件。

返回错误处理组件。

返回第三方扩展根目录。

主页URL

返回应用程序的唯一标识符。

返回用户正在使用的应用程序语言。

返回本地（环境）实例。

返回包含本地化的数据目录。

返回应用程序信息翻译组件。

应用程序名字。默认为‘My Application’。

本地化数字格式。 将使用当前application locale。

返回请求组件。

返回存储运行时文件目录。

返回安全管理器组件。

应用程序使用语言. 这个语言主要指信息和视图文件中的语言。 默认是‘en_us’（US English）。

返回持久状态组件。

返回应用程序所使用的时区。 这个一个简单的PHP函数date_default_timezone_get()的封装。

返回URL管理器组件。

方法详细

public void __construct(mixed $config=NULL)
$config	mixed	应用程序配置。 如果是一个字符串，它将被当作包含配置的文件路径； 如果是一个数组，它将被当作具体的配置信息， 你确保在配置文件中指定basePath属性， 它通常应该指向含所有的应用程序逻辑、模板和数据的目录包。 如果没有，那么默认将指定为‘protected’目录。

构造器。

public void clearGlobalState(string $key)
$key	string	要清除的值的名称

清空一个全局值。

被清除的值在这次请求或随后的请求中不可使用。

public string createAbsoluteUrl(string $route, array $params=array ( ), string $schema='', string $ampersand='&')
$route	string	URL路由。它的格式应该是：‘ControllerID/ActionID’。
$params	array	附加的GET参数（name=>value）。名称和值会被URL-encoded（URL编码）。
$schema	string	要使用的模式（例如： http，https）。如果为空，schema使用当前请求使用的模式。
$ampersand	string	URL中name-value对的分隔标记。
{return}	string	已构造的URL

创建一个基于给定控制器和动作（信息）绝对的URL。

public string createUrl(string $route, array $params=array ( ), string $ampersand='&')
$route	string	URL路由。它的格式应该是：‘ControllerID/ActionID’。
$params	array	附加的GET参数（name=>value）。名称和值会被URL-encoded（URL编码）。
$ampersand	string	URL中name-value对的分隔标记。
{return}	string	已构造的URL

创建一个基于给定控制器和动作（信息）相对的URL。

public void displayError(integer $code, string $message, string $file, string $line)
$code	integer	错误代码
$message	string	错误信息
$file	string	error 错误文件
$line	string	error 错误行号

显示捕获的PHP错误。 当没有激活错误处理时， 这个方将在HTML显示错误。

public void displayException(Exception $exception)
$exception	Exception	未捕获的异常

显示未捕获的PHP异常。 当没有激活错误处理时， 这个方法将在HTML显示未捕获异常。

public void end(integer $status=0, boolean $exit=true)
$status	integer	退出状态（0代表正常退出，其它值表示异常退出）。
$exit	boolean	是否要退出当前的请求。这个参数可用自1.1.5。 如果默认为ture，意味着将在这个方法结束时调用PHP的exit()函数。

终止应用程序。 这个方法通过在退出前调用onEndRequest 替换PHP的exit()方法。

public string findLocalizedFile(string $srcFile, string $srcLanguage=NULL, string $language=NULL)
$srcFile	string	原文件
$srcLanguage	string	原文件中的语言，如果为null，将使用source language。
$language	string	所需要的本地语言.如果为null, 将使用application language。
{return}	string	匹配的本地化文件。如果没有本地化文件或如果源语言和要求语言相同， 将返回原始文件。

返回指定文件的本地化版本。

基于指定语言代码搜索。 特别是，具有相同名称的文件将在以本地ID命名子目录下查找。 例如。给定文件“path/to/view.php”和本地ID标识：“zh_cn”， 本地化文件将以这种形式查找“path/to/zh_cn/view.php”。 如果该文件没有找到， 将返回原始文件。

为了保持一致性，建议本地语言id使用小写格式 LanguageID_RegionID（例如，“en_us”）。

public string getBasePath()
{return}	string	应用程序的根目录。默认为‘protected’。

返回应用程序的根目录。

public string getBaseUrl(boolean $absolute=false)
$absolute	boolean	是否返回一个绝对URL。默认为false，意味着返回一个相对的URL。
{return}	string	相关URL的应用。

返回应用程序的相对URL。 快捷方法就是CHttpRequest::getBaseUrl()。

public CCache getCache()
{return}	CCache	应用程序缓存组件。null为不启用这个组件。

返回缓存组件。

public CController getController()
{return}	CController	当前活动控制器。为Null返回它的基类。

public CPhpMessageSource getCoreMessages()
{return}	CPhpMessageSource	核心信息翻译

返回核心信息翻译组件。

public CDateFormatter getDateFormatter()
{return}	CDateFormatter	本地化的日期格式。 将会使用当前application locale。

返回本地化的日期格式。

public CDbConnection getDb()
{return}	CDbConnection	数据库连接

返回数据库连接组件。

public CErrorHandler getErrorHandler()
{return}	CErrorHandler	错误处理应用程序组件。

返回错误处理组件。

public string getExtensionPath()
{return}	string	包含所有扩展的目录。默认是‘protected’下的‘extensions’目录。

返回第三方扩展根目录。

public mixed getGlobalState(string $key, mixed $defaultValue=NULL)
$key	string	要返回的值的名称
$defaultValue	mixed	默认值。如果该名称的全局值没有找到，将返回默认值。
{return}	mixed	全局值的名称

返回一个全局值

一个全局值，持续在是用户的sessions与requests之间。

public string getHomeUrl()
{return}	string	主页URL

public string getId()
{return}	string	$id 应用程序唯一的标识符。

返回应用程序的唯一标识符。

public string getLanguage()
{return}	string	用户正在使用的应用程序语言。 默认为source language。

返回用户正在使用的应用程序语言。

public CLocale getLocale(string $localeID=NULL)
$localeID	string	本地（环境）实例ID（例如，en_US）。如果null，将使用application language ID。
{return}	CLocale	本地（环境）实例

返回本地（环境）实例。

public string getLocaleDataPath()
{return}	string	包含本地的数据化目录。默认为‘framework/i18n/data’。

返回包含本地化的数据目录。

public CMessageSource getMessages()
{return}	CMessageSource	应用程序信息翻译组件

返回应用程序信息翻译组件。

public CNumberFormatter getNumberFormatter()
{return}	CNumberFormatter	本地化数字格式。 将使用当前application locale。

public CHttpRequest getRequest()
{return}	CHttpRequest	请求组件

返回请求组件。

public string getRuntimePath()
{return}	string	存储运行时文件目录。默认为‘protected/runtime’。

返回存储运行时文件目录。

public CSecurityManager getSecurityManager()
{return}	CSecurityManager	安全管理器组件。

返回安全管理器组件。

public CStatePersister getStatePersister()
{return}	CStatePersister	持久状态组件。

返回持久状态组件。

public string getTimeZone()
{return}	string	应用程序使用的时区。

返回应用程序所使用的时区。 这个一个简单的PHP函数date_default_timezone_get()的封装。

public CUrlManager getUrlManager()
{return}	CUrlManager	URL管理器组件

返回URL管理器组件。

public void handleError(integer $code, string $message, string $file, integer $line)
$code	integer	发起错误的等级
$message	string	发起错误的信息
$file	string	发起错误的文件
$line	integer	发起错误的行号

处理PHP异常错误，如警告，通知。

这个方法实现了一个PHP的错误处理。 它需要常量YII_ENABLE_ERROR_HANDLER被定义为true。

这个方法将首先发起一个onError事件。 如果该错误没有被任何事件处理程序处理，它将调用 errorHandler处理错误。

应用程序将被此方法终止。

public void handleException(Exception $exception)
$exception	Exception	异常没有被捕获

处理未捕获的PHP异常。

这个方法实现了一个PHP的异常处理。 它需要它需要常量YII_ENABLE_EXCEPTION_HANDLER被定义为true.

这个方法将首先发起一个onException事件。 如果异常没有被任何事件处理程序处理，它将调用 errorHandler处理异常。

应用程序将被此方法终止。

protected void initSystemHandlers()

初始化类自动加载器和错误处理。

public void loadGlobalState()

从持久存储加载全局状态数据。

public void onBeginRequest(CEvent $event)
$event	CEvent	事件参数

应用程序处理请求之前发起。

public void onEndRequest(CEvent $event)
$event	CEvent	事件参数

应用程序处理请求之后发起。

public void onError(CErrorEvent $event)
$event	CErrorEvent	事件参数

当一个PHP异常错误发生时发起。

可以设置一个事件处理handled， 事件参数的属性为true表示不再需要进一步处理错误。 否则，errorHandler 应用组件将继续处理错误。

public void onException(CExceptionEvent $event)
$event	CExceptionEvent	事件参数

当一个未捕获的PHP异常发生时发起。

可以设置一个事件处理handled， 事件参数的属性为true表示不再需要进一步处理错误。 否则，errorHandler 应用组件将继续处理错误。

abstract public void processRequest()

处理请求。 这实际是请处理工作已经完成的地方。 派生类应该重写此方法。

protected void registerCoreComponents()

注册核心应用组件。

public void run()

运行应用程序。 此方法加载静态应用组件。 派生类通常重写此方法去做更多特定应用。 记住要调用父类实现，以使静态应用组件被加载。

public void saveGlobalState()

保存全局状态数据到持久存储。

public void setBasePath(string $path)
$path	string	应用程序根目录。

设置应用程序根目录。 这个方法仅在构造函数时调用。

public void setExtensionPath(string $path)
$path	string	第三方扩展目录。

设置第三方扩展目录。

public void setGlobalState(string $key, mixed $value, mixed $defaultValue=NULL)
$key	string	要保存的值的名称
$value	mixed	被保存的全局值，它必须是序例化的。
$defaultValue	mixed	默认值。如果这个值与全局值上同，它将清除当前存储。

设置一个全局值。

一个全局值，持续在是用户的sessions与requests之间。 确保这个值可以序例化和反序例化。

public void setHomeUrl(string $value)
$value	string	设置主页URL

public void setId(string $id)
$id	string	应用程序唯一的标识符。

设置应用程序唯一的标识符。

public void setLanguage(string $language)
$language	string	用户的语言（例如，‘en_US’，‘zh_CN’）。 如果为null，将使用sourceLanguage。

指定应用程序语言。

这个是应用程序显示最终用户的语言。 如果为null，它将使用source language。

除非你的应用程序需要支持多语言， 否则你应该总是设置language为null，以最大化应用程序的性能。

public void setLocaleDataPath(string $value)
$value	string	包含本地化数据的目录。

设置包含本地化数据的目录。

public void setRuntimePath(string $path)
$path	string	存储运行时文件目录。

设置存储运行时文件目录。

public void setTimeZone(string $value)
$value	string	应用程序使用的时区。

设置应用程序所使用的时区。 这个一个简单的PHP函数date_default_timezone_set()的封装。

Copyright © 2008-2011 by Yii Software LLC
All Rights Reserved.