SiteController

All Packages | Properties | Methods

Inheritance	class SiteController » Controller » CController » CBaseController » CComponent
Views	contact, error, index, login, loginbckup
Source Code	app/controllers/SiteController.php

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
clips	CMap	Returns the list of clips.	CController
defaultAction	string	the name of the default action.	CController
id	string	ID of the controller	CController
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
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()		SiteController
actionContact()	Displays the contact page	SiteController
actionError()	This is the action to handle external exceptions.	SiteController
actionExcel()		SiteController
actionExcel2()		SiteController
actionIndex()	This is the default 'index' action that is invoked	SiteController
actionLogin()	Displays the login page	SiteController
actionLogout()	Logs out the current user and redirect to homepage.	SiteController
actions()	Declares class-based actions.	SiteController
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()		SiteController
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
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()	Initializes the controller.	CController
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

Method Details

accessRules() method

public void accessRules()

Source Code: app/controllers/SiteController.php#128 (show)


public function accessRules()
{
    return array(
    
        array('allow',  // allow all users to access 'index' and 'view' actions.
            'actions'=>array('view', 'login'),
            'users'=>array('*'),
        ),
        array('allow', // allow authenticated users to access all actions
            'users'=>array('@'),
        ),
        array('deny',  // deny all users
            'users'=>array('*'),
        ),
    );
}

actionContact() method

public void actionContact()

Source Code: app/controllers/SiteController.php#53 (show)


public function actionContact()
{
        
    $model=new ContactForm;
            
    if(isset($_POST['ContactForm']))
    {
        $model->attributes=$_POST['ContactForm'];
        if($model->validate())
        {
            $name='=?UTF-8?B?'.base64_encode($model->name).'?=';
            $subject='=?UTF-8?B?'.base64_encode($model->subject).'?=';
            $headers="From: $name <{$model->email}>\r\n".
                "Reply-To: {$model->email}\r\n".
                "MIME-Version: 1.0\r\n".
                "Content-type: text/plain; charset=UTF-8";

            mail(Yii::app()->params['adminEmail'],$subject,$model->body,$headers);
            Yii::app()->user->setFlash('contact','Thank you for contacting us. We will respond to you as soon as possible.');
            $this->refresh();
        }
    }
    $this->render('contact',array('model'=>$model));
}

Displays the contact page

actionError() method

public void actionError()

Source Code: app/controllers/SiteController.php#39 (show)


public function actionError()
{
    if($error=Yii::app()->errorHandler->error)
    {
        if(Yii::app()->request->isAjaxRequest)
            echo $error['message'];
        else
            $this->render('error', $error);
    }
}

This is the action to handle external exceptions.

actionExcel() method

public void actionExcel()

Source Code: app/controllers/SiteController.php#150 (show)


public function actionExcel(){
    $objPHPExcel = new PHPExcel();

    // Set document properties
    $objPHPExcel->getProperties()->setCreator("K'iin Balam")
         ->setLastModifiedBy("K'iin Balam")
         ->setTitle("thing YiiExcel Test Document")
         ->setSubject("YiiExcel Test Document")
         ->setDescription("Test document for YiiExcel, generated using PHP classes.")
         ->setKeywords("office PHPExcel php YiiExcel UPNFM")
         ->setCategory("Test result file");        
    
    // Add some data
    $objPHPExcel->setActiveSheetIndex(0)
        ->setCellValue('A1', 'Hello')
        ->setCellValue('B2', 'world!')
        ->setCellValue('C1', 'Hello')
        ->setCellValue('D2', 'world!');
    
    // Miscellaneous glyphs, UTF-8
    $objPHPExcel->setActiveSheetIndex(0)
        ->setCellValue('A4', 'Miscellaneous glyphs')
        ->setCellValue('A5', 'éàèùâêîôûëïüÿäöüç');
    
    // Rename worksheet
    $objPHPExcel->getActiveSheet()->setTitle('YiiExcel');
    
    // Set active sheet index to the first sheet, so Excel opens this as the first sheet
    $objPHPExcel->setActiveSheetIndex(0);
    
    // Save a xls file
    $filename = 'YiiExcel';
    header('Content-Type: application/vnd.ms-excel');
    header('Content-Disposition: attachment;filename="'.$filename.'.xls"');
    header('Cache-Control: max-age=0');
    
    $objWriter = PHPExcel_IOFactory::createWriter($objPHPExcel, 'Excel5');

    $objWriter->save('php://output');
    unset($this->objWriter);
    unset($this->objWorksheet);
    unset($this->objReader);
    unset($this->objPHPExcel);
    exit();
}//fin del método actionExcel

actionExcel2() method

public void actionExcel2()

Source Code: app/controllers/SiteController.php#198 (show)


public function actionExcel2(){
    
    //Some data
    $students = array(
        array('name'=>'Some Name','obs'=>'Mat'),
        array('name'=>'Another Name','obs'=>'Tec'),
        array('name'=>'Yet Another Name','obs'=>'Mat')
    );
    
    $r = new YiiReport(array('template'=> 'students.xls'));
    /*
    $r->load(array(
            array(
                'id' => 'ong',
                'data' => array(
                    'name' => 'UNIVERSIDAD PADAGÓGICA NACIONAL'
                )
            ),
            array(
                'id'=>'estu',
                'repeat'=>true,
                'data'=>$students,
                'minRows'=>2
            )
        )
    );*/
    
    //echo $r->render('excel5', 'Students');
    //echo $r->render('excel2007', 'Students');
    echo $r->render('pdf', 'Students');
    
}//actionExcel method end

actionIndex() method

public void actionIndex()

Source Code: app/controllers/SiteController.php#28 (show)


public function actionIndex()
{
    // renders the view file 'protected/views/site/index.php'
    // using the default layout 'protected/views/layouts/main.php'
    $this->layout = "main";
    $this->render('index');
}

This is the default 'index' action that is invoked when an action is not explicitly requested by users.

actionLogin() method

public void actionLogin()

Source Code: app/controllers/SiteController.php#81 (show)


public function actionLogin()
{
    $model=new LoginForm;

    // if it is ajax validation request
    if(isset($_POST['ajax']) && $_POST['ajax']==='login-form')
    {
        echo CActiveForm::validate($model);
        Yii::app()->end();
    }

    // collect user input data
    if(isset($_POST['LoginForm']))
    {
        $model->attributes=$_POST['LoginForm'];
        // validate user input and redirect to the previous page if valid
        if($model->validate() && $model->login())
            //$this->redirect(Yii::app()->user->returnUrl);
            /*{
                $this->layout = "main";
                $this->render('index');
            }*/
            $this->redirect('index.php');
    }
    // display the login form
    $this->layout = "column1";
    $this->render('login',array('model'=>$model));
}

Displays the login page

actionLogout() method

public void actionLogout()

Source Code: app/controllers/SiteController.php#113 (show)


public function actionLogout()
{
    Yii::app()->user->logout();
    $this->redirect(Yii::app()->homeUrl);
}

Logs out the current user and redirect to homepage.

actions() method

public void actions()

Source Code: app/controllers/SiteController.php#8 (show)


public function actions()
{
    return array(
        // captcha action renders the CAPTCHA image displayed on the contact page
        'captcha'=>array(
            'class'=>'CCaptchaAction',
            'backColor'=>0xFFFFFF,
        ),
        // page action renders "static" pages stored under 'protected/views/site/pages'
        // They can be accessed via: index.php?r=site/page&view=FileName
        'page'=>array(
            'class'=>'CViewAction',
        ),
    );
}

Declares class-based actions.

filters() method

public void filters()

Source Code: app/controllers/SiteController.php#121 (show)


public function filters()
{
    return array(
        'accessControl',
    );
}