Docs For Class Controller

Class Controller

Description

Base controller class

This class is inherited by all script controllers. All methods of this class are reserved - there can't be actions with that names (for instance, there can't be execute actions in real controllers).

version: 1.0
abstract:

Located in /environment/classes/controller/Controller.class.php (line 14)

Direct descendents

Class	Description
ApiController	API controller is used for handling API requests
PageController	Page controller is special controller that is able to map controller name and actions name with layout and template and automaticly display them.

Method Summary

null __construct (void 0)

InvalidControllerActionError execute (string $action)

null forward (string $action, [ $controller = null], string $controller.)

string getAction (null 0)

string getControllerName (null 0)

string getSystemControllerClass (null 0)

null setAction (string $value)

null setControllerName (string $value)

null setSystemControllerClass (string $value)

boolean validAction (string $action)

Methods

Constructor __construct (line 46)

Contruct controller and set controller name

access: public

null __construct (void 0)

void 0

Redefined in descendants as:

ApiController::__construct() : Construct the ApiController
PageController::__construct() : Construct controller
ErrorController::__construct() : Construct the ErrorController
FeedController::__construct() : Construct the controller
ApplicationController::__construct() : Add application level constroller
DashboardController::__construct() : Construct controller and check if we have logged in user
MessageController::__construct() : Construct the MessageController
TimeController::__construct() : Construct the TimeController
AdministrationController::__construct() : Construct the AdministrationController
AccountController::__construct() : Construct the AccountController
MilestoneController::__construct() : Construct the MilestoneController
AccessController::__construct() : Construct controller
FilesController::__construct() : Construct the FilesController
CommentController::__construct() : Construct the CommentController
TaskController::__construct() : Construct the MilestoneController
FormController::__construct() : Construct the MessageController
ConfigController::__construct() : Construct the ApplicationController
ProjectController::__construct() : Prepare this controller
CompanyController::__construct() : Construct the CompanyController
TagController::__construct() : Construct the TagController
UserController::__construct() : Construct the UserController

execute (line 61)

Execute specific controller action

return: if action name is not valid or true
access: public

InvalidControllerActionError execute (string $action)

string $action

Redefined in descendants as:

PageController::execute() : Execute action

forward (line 86)

Forward to specific contrller / action

access: public

null forward (string $action, [ $controller = null], string $controller.)

string $action
string $controller.: If this value is NULL current controller will be used
$controller

getAction (line 147)

Get action

access: public

string getAction (null 0)

null 0

getControllerName (line 125)

Get controller_name

access: public

string getControllerName (null 0)

null 0

getSystemControllerClass (line 169)

Get system_controller_class

access: public

string getSystemControllerClass (null 0)

null 0

setAction (line 158)

Set action value

access: public

null setAction (string $value)

string $value

setControllerName (line 136)

Set controller_name value

access: public

null setControllerName (string $value)

string $value

setSystemControllerClass (line 180)

Set system_controller_class value

access: public

null setSystemControllerClass (string $value)

string $value

validAction (line 97)

Check if specific $action is valid controller action (method exists and it is not reserved)

return: or Error
access: public

boolean validAction (string $action)

string $action

Documentation generated on Wed, 23 Jan 2008 01:58:30 +0000 by phpDocumentor 1.4.0