CViewAction

Property Details

basePath property

public string $basePath;

the base path for the views. Defaults to 'pages'. The base path will be prefixed to any user-specified page view. For example, if a user requests for tutorial.chap1, the corresponding view name will be pages/tutorial/chap1, assuming the base path is pages. The actual view file is determined by CController::getViewFile.

defaultView property

public string $defaultView;

the name of the default view when viewParam GET parameter is not provided by user. Defaults to 'index'. This should be in the format of 'path.to.view', similar to that given in the GET parameter.

layout property

public mixed $layout;

the name of the layout to be applied to the views. This will be assigned to CController::layout before the view is rendered. Defaults to null, meaning the controller's layout will be used. If false, no layout will be applied.

renderAsText property

public boolean $renderAsText;

whether the view should be rendered as PHP script or static text. Defaults to false.

requestedView property read-only

public string getRequestedView()

Returns the name of the view requested by the user. If the user doesn't specify any view, the defaultView will be returned.

view property

public string $view;

the name of the view to be rendered. This property will be set once the user requested view is resolved.

viewParam property

public string $viewParam;

the name of the GET parameter that contains the requested view name. Defaults to 'view'.

Method Details

getRequestedView() method

public string getRequestedView()

public function getRequestedView()
{
    if($this->_viewPath===null)
    {
        if(!empty($_GET[$this->viewParam]) && is_string($_GET[$this->viewParam]))
            $this->_viewPath=$_GET[$this->viewParam];
        else
            $this->_viewPath=$this->defaultView;
    }
    return $this->_viewPath;
}

Returns the name of the view requested by the user. If the user doesn't specify any view, the defaultView will be returned.

onAfterRender() method

public void onAfterRender(CEvent $event)

public function onAfterRender($event)
{
    $this->raiseEvent('onAfterRender',$event);
}

Raised right after the action invokes the render method.

onBeforeRender() method

public void onBeforeRender(CEvent $event)

public function onBeforeRender($event)
{
    $this->raiseEvent('onBeforeRender',$event);
}

Raised right before the action invokes the render method. Event handlers can set the CEvent::handled property to be true to stop further view rendering.

resolveView() method

protected string resolveView(string $viewPath)

protected function resolveView($viewPath)
{
    // start with a word char and have word chars, dots and dashes only
    if(preg_match('/^\w[\w\.\-]*$/',$viewPath))
    {
        $view=strtr($viewPath,'.','/');
        if(!empty($this->basePath))
            $view=$this->basePath.'/'.$view;
        if($this->getController()->getViewFile($view)!==false)
        {
            $this->view=$view;
            return;
        }
    }
    throw new CHttpException(404,Yii::t('yii','The requested view "{name}" was not found.',
        array('{name}'=>$viewPath)));
}

Resolves the user-specified view into a valid view name.

run() method

public void run()

public function run()
{
    $this->resolveView($this->getRequestedView());
    $controller=$this->getController();
    if($this->layout!==null)
    {
        $layout=$controller->layout;
        $controller->layout=$this->layout;
    }

    $this->onBeforeRender($event=new CEvent($this));
    if(!$event->handled)
    {
        if($this->renderAsText)
        {
            $text=file_get_contents($controller->getViewFile($this->view));
            $controller->renderText($text);
        }
        else
            $controller->render($this->view);
        $this->onAfterRender(new CEvent($this));
    }

    if($this->layout!==null)
        $controller->layout=$layout;
}

Runs the action. This method displays the view requested by the user.