My FIU Curriculum Class Reference. Yii Framework

# Controller

Package | application
Inheritance | class Controller » CController » CBaseController » CComponent
Subclasses | CourseController, CoursePrefixController, DguController, GroupController, MajorController, ManageController, SetController, SiteController, TrackController
Source Code |

Controller is the customized base controller class. All controller classes for this application should extend from this base class.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
action | CAction | the action currently being executed, null if no active action. | CController
actionParams | array | Returns the request parameters that will be used for action parameter binding. | CController
breadcrumbs | array | the breadcrumbs of the current page. | Controller
cachingStack | CStack | stack of COutputCache objects | CController
catalogActivated |  |  | Controller
catalogId |  |  | Controller
catalogName |  |  | Controller
clips | CMap | Returns the list of clips. | CController
defaultAction | string | the name of the default action. | CController
id | string | ID of the controller | CController
lastActivatedCatalog |  |  | Controller
layout | string | the default layout for the controller view. | Controller
menu | array | context menu items. | Controller
module | CWebModule | the module that this controller belongs to. | CController
pageTitle | string | the page title. | CController
route | string | the route (module ID, controller ID and action ID) of the current request. | CController
showCatalog |  |  | Controller
uniqueId | string | the controller ID that is prefixed with the module ID (if any). | CController
viewPath | string | Returns the directory containing view files for this controller. | CController

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | CComponent
__construct() |  | CController
__get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent
__isset() | Checks if a property value is null. | CComponent
__set() | Sets value of a component property. | CComponent
__unset() | Sets a component property to be null. | CComponent
accessRules() | Returns the access rules for this controller. | CController
actions() | Returns a list of external action classes. | CController
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
beginCache() | Begins fragment caching. | CBaseController
beginClip() | Begins recording a clip. | CBaseController
beginContent() | Begins the rendering of content that is to be decorated by the specified view. | CBaseController
beginWidget() | Creates a widget and executes it. | CBaseController
behaviors() | Returns a list of behaviors that this controller should behave as. | CController
canGetProperty() | Determines whether a property can be read. | CComponent
canSetProperty() | Determines whether a property can be set. | CComponent
clearPageStates() | Removes all page states. | CController
createAbsoluteUrl() | Creates an absolute URL for the specified action defined in this controller. | CController
createAction() | Creates the action instance based on the action name. | CController
createUrl() | Creates a relative URL for the specified action defined in this controller. | CController
createWidget() | Creates a widget and initializes it. | CBaseController
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
enableBehavior() | Enables an attached behavior. | CComponent
enableBehaviors() | Enables all behaviors attached to this component. | CComponent
endCache() | Ends fragment caching. | CBaseController
endClip() | Ends recording a clip. | CBaseController
endContent() | Ends the rendering of content. | CBaseController
endWidget() | Ends the execution of the named widget. | CBaseController
evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent
filterAccessControl() | The filter method for 'accessControl' filter. | CController
filterAjaxOnly() | The filter method for 'ajaxOnly' filter. | CController
filterPostOnly() | The filter method for 'postOnly' filter. | CController
filters() | Returns the filter configurations. | CController
forward() | Processes the request using another controller action. | CController
getAction() | Returns the action currently being executed, null if no active action. | CController
getActionParams() | Returns the request parameters that will be used for action parameter binding. | CController
getCachingStack() | Returns stack of COutputCache objects | CController
getClips() | Returns the list of clips. | CController
getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent
getId() | Returns ID of the controller | CController
getLastActivatedCatalog() |  | Controller
getLayoutFile() | Looks for the layout view script based on the layout name. | CController
getModule() | Returns the module that this controller belongs to. It returns null if the controller does not belong to any module | CController
getPageState() | Returns a persistent page state value. | CController
getPageTitle() | Returns the page title. Defaults to the controller name and the action name. | CController
getRoute() | Returns the route (module ID, controller ID and action ID) of the current request. | CController
getUniqueId() | Returns the controller ID that is prefixed with the module ID (if any). | CController
getViewFile() | Looks for the view file according to the given view name. | CController
getViewPath() | Returns the directory containing view files for this controller. | CController
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
init() |  | Controller
invalidActionParams() | This method is invoked when the request parameters do not satisfy the requirement of the specified action. | CController
isCachingStackEmpty() | Returns whether the caching stack is empty. | CController
missingAction() | Handles the request whose action is not recognized. | CController
processDynamicOutput() | Postprocesses the dynamic output. | CController
processOutput() | Postprocesses the output generated by render(). | CController
raiseEvent() | Raises an event. | CComponent
recordCachingAction() | Records a method call when an output cache is in effect. | CController
redirect() | Redirects the browser to the specified URL or route (controller/action). | CController
refresh() | Refreshes the current page. | CController
render() | Renders a view with a layout. | CController
renderClip() | Renders a named clip with the supplied parameters. | CController
renderDynamic() | Renders dynamic content returned by the specified callback. | CController
renderDynamicInternal() | This method is internally used. | CController
renderFile() | Renders a view file. | CBaseController
renderInternal() | Renders a view file. | CBaseController
renderPartial() | Renders a view. | CController
renderText() | Renders a static text string. | CController
resolveViewFile() | Finds a view file based on its name. | CController
run() | Runs the named action. | CController
runAction() | Runs the action after passing through all filters. | CController
runActionWithFilters() | Runs an action with the specified filters. | CController
setAction() | Sets the action currently being executed. | CController
setPageState() | Saves a persistent page state value. | CController
setPageTitle() | Sets the page title. | CController
widget() | Creates a widget and executes it. | CBaseController

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
afterAction() | This method is invoked right after an action is executed. | CController
afterRender() | This method is invoked after the specified is rendered by calling render(). | CController
beforeAction() | This method is invoked right before an action is to be executed (after all possible filters.) | CController
beforeRender() | This method is invoked at the beginning of render(). | CController
createActionFromMap() | Creates the action instance based on the action map. | CController
loadPageStates() | Loads page states from a hidden input. | CController
replaceDynamicOutput() | Replaces the dynamic content placeholders with actual content. | CController
savePageStates() | Saves page states as a base64 string. | CController

## Property Details

public array $breadcrumbs;

the breadcrumbs of the current page. The value of this property will be assigned to CBreadcrumbs::links. Please refer to CBreadcrumbs::links for more details on how to specify this property.

catalogActivated property
public $catalogActivated;

catalogId property
public $catalogId;

catalogName property
public $catalogName;

lastActivatedCatalog property read-only
public void getLastActivatedCatalog()

layout property
public string $layout;

the default layout for the controller view. Defaults to '//layouts/column1', meaning using a single column layout. See 'protected/views/layouts/column1.php'.

public array $menu;

context menu items. This property will be assigned to CMenu::items.

showCatalog property
public $showCatalog;

## Method Details

getLastActivatedCatalog() method

public void getLastActivatedCatalog()

Source Code: (show)
`public function getLastActivatedCatalog(){
$catalog = Catalog::model()->find('activated=1 ORDER BY startingDate DESC');
return $catalog;
}`

init() method

public void init()

Source Code: (show)
`public function init (){
if(isset(Yii::app()->session['catalogId']) || isset(Yii::app()->session['catalogName']) || isset(Yii::app()->session['catalogActivated'])){
$this->catalogId = Yii::app()->session['catalogId'];
$this->catalogName = Yii::app()->session['catalogName'];
$this->catalogActivated = Yii::app()->session['catalogActivated'];
}
}`

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