CViewAction

Подробное описание свойств

basePath свойство

public string $basePath;

базовый путь для представлений. По умолчанию равен 'pages'. Базовый путь будет добавлен в качестве префикса к любому указанному пользователем представлению страницы. Например, если пользователь запросит tutorial.chap1, соответствующее имя представления будет pages/tutorial/chap1, предполагая, что базовый путь равен pages. Фактический файл представления определяется методом CController::getViewFile.

defaultView свойство

public string $defaultView;

имя представления по умолчанию, когда пользователь не предоставляет параметр GET viewParam. По умолчанию равно 'index'. Это должно быть в формате 'путь.к.представлению', аналогично тому, что указано в параметре GET.

layout свойство

public mixed $layout;

имя макета, которое будет применено к представлениям. Оно будет присвоено свойству CController::layout перед отрисовкой представления. По умолчанию равно null, что означает использование макета контроллера. Если false, макет не будет применён.

renderAsText свойство

public boolean $renderAsText;

определяет, должно ли представление отображаться как PHP-скрипт или статический текст. По умолчанию равно false.

requestedView свойство только для чтения

public string getRequestedView()

Возвращает имя представления, запрошенного пользователем. Если пользователь не указывает представление, возвращается значение defaultView.

view свойство

public string $view;

имя представления, которое будет отрисовано. Это свойство будет установлено после разрешения запрошенного пользователем представления.

viewParam свойство

public string $viewParam;

имя параметра GET, содержащего имя запрошенного представления. По умолчанию равно 'view'.

Подробное описание методов

getRequestedView() метод

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;
}

Возвращает имя представления, запрошенного пользователем. Если пользователь не указывает представление, возвращается значение defaultView.

onAfterRender() метод

public void onAfterRender(CEvent $event)

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

Вызывается сразу после того, как действие вызывает метод render.

onBeforeRender() метод

public void onBeforeRender(CEvent $event)

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

Вызывается сразу перед тем, как действие вызовет метод render. Обработчики событий могут установить свойство CEvent::handled в true, чтобы остановить дальнейшую отрисовку представления.

resolveView() метод

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)));
}

Разрешает указанное пользователем представление в действительное имя представления.

run() метод

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;
}

Выполняет действие. Этот метод отображает представление, запрошенное пользователем.