CourseController
| Package | application |
|---|---|
| Inheritance | class CourseController » Controller » CController » CBaseController » CComponent |
| Source Code |
Public 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 views. | CourseController |
| 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
| 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() | Specifies the access control rules. | CourseController |
| actionAdmin() | Manages all models. | CourseController |
| actionCreate() | Creates a new model for a course. | CourseController |
| actionDelete() | Deletes a particular model. | CourseController |
| actionIndex() | Lists all models. | CourseController |
| actionUpdate() | Updates a particular model. | CourseController |
| actionView() | Displays a particular model. | CourseController |
| 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() | CourseController | |
| 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 |
| loadModel() | Returns the data model based on the primary key given in the GET variable. | CourseController |
| 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
| 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 |
| performAjaxValidation() | Performs the AJAX validation. | CourseController |
| replaceDynamicOutput() | Replaces the dynamic content placeholders with actual content. | CController |
| savePageStates() | Saves page states as a base64 string. | CController |
Property Details
layout
property
public string $layout;
the default layout for the views. Defaults to '//layouts/column2', meaning using two-column layout. See 'protected/views/layouts/column2.php'.
Method Details
accessRules()
method
|
public array accessRules()
| ||
| {return} | array | access control rules |
Source Code: (show)
public function accessRules()
{
return array(
array('allow', // allow all users to perform 'index' and 'view' actions
'actions'=>array('index','view'),
'users'=>array('*'),
),
array('allow', // allow authenticated user to perform 'create' and 'update' actions
'actions'=>array('create','update'),
'users'=>array('@'),
),
array('allow', // allow admin user to perform 'admin' and 'delete' actions
'actions'=>array('admin','delete'),
'users'=>array('@'),
),
array('deny', // deny all users
'users'=>array('*'),
),
);
}
Specifies the access control rules. This method is used by the 'accessControl' filter.
actionAdmin()
method
|
public void actionAdmin()
|
Source Code: (show)
public function actionAdmin()
{
$model=new CurrCourse('search');
$model->unsetAttributes(); // clear any default values
if(isset($_GET['CurrCourse']))
$model->attributes=$_GET['CurrCourse'];
$this->render('admin',array(
'model'=>$model,
));
}
Manages all models.
actionCreate()
method
|
public void actionCreate()
|
Source Code: (show)
public function actionCreate()
{
$currModel=new CurrCourse();
$hisModel=new HisCourse();
// Uncomment the following line if AJAX validation is needed
//$this->performAjaxValidation($currModel);
//$this->performAjaxValidation($hisModel);
if(isset($_POST['CurrCourse']) && isset($_POST['HisCourse']))
{
$currModel->attributes=$_POST['CurrCourse'];
$hisModel->attributes=$_POST['HisCourse'];
$currModel->catalog_id = $this->catalogId;
$hisModel->catalog_id = $this->catalogId;
//Validate
$hisValid = $hisModel->validate();
if($currModel->validate() && $hisValid){
try{
$newModelId = Course::createNewEntity($currModel, $hisModel);
$this->redirect(array('view','id'=>$newModelId));
}
catch (Exception $e){
var_dump($e);
}
}
}
$this->render('create',array(
'currModel'=>$currModel, 'hisModel'=>$hisModel,
));
}
Creates a new model for a course. A course is built from the history table and the course table. If creation is successful, the browser will be redirected to the 'view' page.
actionDelete()
method
|
public void actionDelete(integer $id)
| ||
| $id | integer | the ID of the model to be deleted |
Source Code: (show)
public function actionDelete($id)
{
$entity = new Course($id, $this->catalogId);
if($entity->deleteOrRevertEntity())
$this->redirect(array('index'));
else
Yii::app()->request->redirect($_SERVER['HTTP_REFERER']);
}
Deletes a particular model. If deletion is successful, the browser will be redirected to the 'admin' page.
actionIndex()
method
|
public void actionIndex()
|
Source Code: (show)
public function actionIndex()
{
$dataProvider=new CActiveDataProvider('CurrCourse');
$this->render('index',array(
'dataProvider'=>$dataProvider,
));
}
Lists all models.
actionUpdate()
method
|
public void actionUpdate(integer $id)
| ||
| $id | integer | the ID of the model to be updated |
Source Code: (show)
public function actionUpdate($id)
{
$entity = new Course($id, $this->catalogId);
$currModel = $entity->getEntity();
$hisModel = $currModel->hisCourses[0];
// Uncomment the following line if AJAX validation is needed
$this->performAjaxValidation($hisModel);
if(isset($_POST['CurrCourse']) && isset($_POST['HisCourse']))
{
$entityAttributes = $entity->getEntity();
$entityData = $entityAttributes->hisCourses[0];
$entityData->attributes = $_POST['HisCourse'];
if($entityData->validate()){
if($entity->updateData())
$this->redirect(array('view','id'=>$entityAttributes->id));
}
}
$this->render('update',array(
'currModel'=>$currModel, 'hisModel'=>$hisModel,
));
}
Updates a particular model. If update is successful, the browser will be redirected to the 'view' page.
actionView()
method
|
public void actionView(integer $id)
| ||
| $id | integer | the ID of the model to be displayed |
Source Code: (show)
public function actionView($id)
{
$this->render('view',array(
'model'=>$this->loadModel($id),
));
}
Displays a particular model.
filters()
method
|
public array filters()
| ||
| {return} | array | action filters |
Source Code: (show)
public function filters()
{
return array(
'accessControl', // perform access control for CRUD operations
'postOnly + delete', // we only allow deletion via POST request
);
}
loadModel()
method
|
public void loadModel(integer $id)
| ||
| $id | integer | the ID of the model to be loaded |
Source Code: (show)
public function loadModel($id)
{
$entity = new Course($id, $this->catalogId);
$model = $entity->getEntity();
if($model===null)
throw new CHttpException(404,'The requested entity does not exist.');
return $model;
}
Returns the data model based on the primary key given in the GET variable. If the data model is not found, an HTTP exception will be raised.
performAjaxValidation()
method
|
protected void performAjaxValidation(CModel $model)
| ||
| $model | CModel | the model to be validated |
Source Code: (show)
protected function performAjaxValidation($model)
{
if(isset($_POST['ajax']) && $_POST['ajax']==='curr-course-form')
{
echo CActiveForm::validate($model);
Yii::app()->end();
}
}
Performs the AJAX validation.