Yii Framework v1.0.3 Class Reference

CWebApplication

Package	system.web
Inheritance	class CWebApplication » CApplication » CComponent
Since	1.0
Version	$Id: CWebApplication.php 771 2009-02-28 14:18:20Z qiang.xue $

Property Details

the asset manager component

the authorization manager component

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

the configuration specifying a controller which should handle all user requests. This is mainly used when the application is in maintenance mode and we should use a controller to handle all incoming requests. The configuration specifies the controller route (the first element) and GET parameters (the rest name-value pairs). For example,

array(
    'offline/notice',
    'param1'=>'value1',
    'param2'=>'value2',
)

Defaults to null, meaning catch-all is not effective.

Returns the client script manager.

the currently active controller

mapping from controller ID to controller configurations. Each name-value pair specifies the configuration for a single controller. A controller configuration can be either a string or an array. If the former, the string should be the class name or class path alias of the controller. If the latter, the array must contain a 'class' element which specifies the controller's class name or class path alias. The rest name-value pairs in the array are used to initialize the corresponding controller properties. For example,

array(
  'post'=>array(
     'class'=>'path.to.PostController',
     'pageTitle'=>'something new',
  ),
  'user'=>'path.to.UserController',,
)

Note, when processing an incoming request, the controller map will first be checked to see if the request can be handled by one of the controllers in the map. If not, a controller will be searched for under the default controller path.

the directory that contains the controller classes. Defaults to 'protected/controllers'.

the ID of the default controller. Defaults to 'site'.

the homepage URL

the application-wide layout. Defaults to 'main' (relative to layoutPath). If this is false, then no layout will be used.

the root directory of layout files. Defaults to 'protected/views/layouts'.

the directory that contains the application modules. Defaults to 'protected/modules'.

the configurations of the currently installed modules (id=>configuration)

the request component

the session component

the root directory of system view files. Defaults to 'protected/views/system'.

the theme used currently. Null if no theme is being used.

the theme manager.

the URL manager component

the user session information

the root directory of view files. Defaults to 'protected/views'.

Returns the view renderer. If this component is registered and enabled, the default view rendering logic defined in CBaseController will be replaced by this renderer.

Method Details

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 array createController(string $route, CWebModule $owner=NULL)
$route	string	the route of the request.
$owner	CWebModule	the module that the new controller will belong to. Defaults to null, meaning the application instance is the owner.
{return}	array	the controller instance and the action ID. Null if the controller class does not exist or the route is invalid.

Creates a controller instance based on a route. The route should contain the controller ID and the action ID. It may also contain additional GET variables. All these must be concatenated together with slashes.

This method will attempt to create a controller in the following order:

1. If the first segment is found in controllerMap, the corresponding controller configuration will be used to create the controller;
2. If the first segment is found to be a module ID, the corresponding module will be used to create the controller;
3. Otherwise, it will search under the controllerPath to create the corresponding controller. For example, if the route is "admin/user/create", then the controller will be created using the class file "protected/controllers/admin/UserController.php".

public CWebModule createModule(string $id, array $config, CWebModule $owner=NULL)
$id	string	the module ID
$config	array	module configuration
$owner	CWebModule	the parent module. Null if no parent.
{return}	CWebModule	the create module instance. Null if the module is not enabled.

Creates an application module based on the given configuration. The module created will be initialized with the given configuration. And its CWebModule::init() method will also be invoked.

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 CWebModule findModule(string $id)
$id	string	module ID
{return}	CWebModule	the module that has the specified ID. Null if no module is found.

Searches for a module by its ID. This method is used internally. Do not call this method.

public CAssetManager getAssetManager()
{return}	CAssetManager	the asset manager component

public IAuthManager getAuthManager()
{return}	IAuthManager	the authorization manager component

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

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

public CClientScript getClientScript()
{return}	CClientScript	the client script manager

Returns the client script manager.

public CController getController()
{return}	CController	the currently active controller

public string getControllerPath()
{return}	string	the directory that contains the controller classes. Defaults to 'protected/controllers'.

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

public string getLayoutPath()
{return}	string	the root directory of layout files. Defaults to 'protected/views/layouts'.

public CWebModule getModule(string $id)
$id	string	application module ID (case-sensitive)
{return}	CWebModule	the application module instance, null if the application module is disabled or does not exist.

Retrieves the named application module.

public string getModulePath()
{return}	string	the directory that contains the application modules. Defaults to 'protected/modules'.

public array getModules()
{return}	array	the configurations of the currently installed modules (id=>configuration)

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

public CHttpSession getSession()
{return}	CHttpSession	the session component

public string getSystemViewPath()
{return}	string	the root directory of system view files. Defaults to 'protected/views/system'.

public CTheme getTheme()
{return}	CTheme	the theme used currently. Null if no theme is being used.

public CThemeManager getThemeManager()
{return}	CThemeManager	the theme manager.

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

public CWebUser getUser()
{return}	CWebUser	the user session information

public string getViewPath()
{return}	string	the root directory of view files. Defaults to 'protected/views'.

public IViewRenderer getViewRenderer()
{return}	IViewRenderer	the view renderer.

Returns the view renderer. If this component is registered and enabled, the default view rendering logic defined in CBaseController will be replaced by this renderer.

protected string parseActionParams(string $pathInfo)
$pathInfo	string	path info
{return}	string	action ID

Parses a path info into an action ID and GET variables.

public void processRequest()

Processes the current request. It first resolves the request into controller and action, and then creates the controller to perform the action.

protected void registerCoreComponents()

Registers the core application components. This method overrides the parent implementation by registering additional core components.

public void runController(string $route)
$route	string	the route of the current request. See createController for more details.

Creates the controller and performs the specified action.

public void setControllerPath(string $value)
$value	string	the directory that contains the controller classes.

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

public void setLayoutPath(string $path)
$path	string	the root directory of layout files.

public void setModulePath(string $value)
$value	string	the directory that contains the application modules.

public void setModules(array $modules)
$modules	array	application module configuration.

Configures the modules of this application.

Call this method to declare modules and configure them with their initial property values. The parameter should be an array of module configurations. Each array element represents a single module, which can be either a string representing the module ID or an ID-config pair representing a module with the specified ID and the initial property values.

For example, the following array declares two modules:

array(
    'admin',
    'payment'=>array(
        'server'=>'paymentserver.com',
    ),
)

By default, the module class is determined using the expression ucfirst($moduleID).'Module'. And the class file is located under modules/$moduleID. You may override this default by explicitly specifying the 'class' option in the configuration.

You may also enable or disable a module by specifying the 'enabled' option in the configuration.

public void setSystemViewPath(string $path)
$path	string	the root directory of system view files.

public void setTheme(string $value)
$value	string	the theme name

public void setViewPath(string $path)
$path	string	the root directory of view files.

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