CExtController
| Пакет | system.web |
|---|---|
| Наследование | class CExtController » CController » CBaseController » CComponent |
| С момента | 1.0 |
| Исходный код | framework/web/CExtController.php |
CExtController — базовый класс для контроллеров, распространяемых в виде расширений.
Основное назначение CExtController — переопределение свойства viewPath, чтобы оно указывало на подкаталог «views» в каталоге, содержащем файл класса контроллера.
Основное назначение CExtController — переопределение свойства viewPath, чтобы оно указывало на подкаталог «views» в каталоге, содержащем файл класса контроллера.
Свойства public
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| action | CAction | действие, которое выполняется в настоящее время; null, если активное действие отсутствует. | CController |
| actionParams | массив | Возвращает параметры запроса, которые будут использованы для привязки параметров действия. | CController |
| cachingStack | CStack | стек объектов COutputCache | CController |
| clips | CMap | Возвращает список фрагментов. | CController |
| defaultAction | строка | имя действия по умолчанию. | CController |
| id | строка | Идентификатор контроллера | CController |
| layout | смешанный тип | имя макета, который будет применяться к представлениям этого контроллера. | CController |
| module | CWebModule | модуль, к которому принадлежит этот контроллер. | CController |
| pageTitle | строка | заголовок страницы. | CController |
| route | строка | маршрут (ID модуля, ID контроллера и ID действия) текущего запроса. | CController |
| uniqueId | строка | Идентификатор контроллера, дополненный ID модуля (если применён). | CController |
| viewPath | строка | Возвращает каталог, содержащий файлы представлений для данного контроллера. | CExtController |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | CComponent |
| __construct() | CController | |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства null. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| accessRules() | Возвращает правила доступа для данного контроллера. | CController |
| actions() | Возвращает список внешних классов действий. | CController |
| asa() | Возвращает объект именованного поведения. | CComponent |
| attachBehavior() | Присоединяет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Присоединяет список поведений к компоненту. | CComponent |
| attachEventHandler() | Присоединяет обработчик событий к событию. | CComponent |
| beginCache() | Начинает кэширование фрагмента. | CBaseController |
| beginClip() | Начинает запись клипа. | CBaseController |
| beginContent() | Начинает отображение содержимого, которое должно быть оформлено указанным представлением. | CBaseController |
| beginWidget() | Создаёт виджет и выполняет его. | CBaseController |
| behaviors() | Возвращает список поведений, по которым должен действовать этот контроллер. | CController |
| canGetProperty() | Определяет, можно ли прочитать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| clearPageStates() | Удаляет все состояния страницы. | CController |
| createAbsoluteUrl() | Создаёт абсолютный URL для указанного действия, определённого в этом контроллере. | CController |
| createAction() | Создаёт экземпляр действия на основе имени действия. | CController |
| createUrl() | Создаёт относительный URL для указанного действия, определённого в этом контроллере. | CController |
| createWidget() | Создаёт виджет и инициализирует его. | CBaseController |
| detachBehavior() | Отсоединяет поведение от компонента. | CComponent |
| detachBehaviors() | Отсоединяет все поведения от компонента. | CComponent |
| detachEventHandler() | Отсоединяет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает присоединённое поведение. | CComponent |
| disableBehaviors() | Отключает все присоединённые поведения для этого компонента. | CComponent |
| enableBehavior() | Включает присоединённое поведение. | CComponent |
| enableBehaviors() | Включает все присоединённые поведения для этого компонента. | CComponent |
| endCache() | Завершает кэширование фрагмента. | CBaseController |
| endClip() | Завершает запись клипа. | CBaseController |
| endContent() | Завершает отображение содержимого. | CBaseController |
| endWidget() | Завершает выполнение указанного виджета. | CBaseController |
| evaluateExpression() | Вычисляет PHP-выражение или обратный вызов в контексте этого компонента. | CComponent |
| filterAccessControl() | Метод фильтра для фильтра 'accessControl'. | CController |
| filterAjaxOnly() | Метод фильтра для фильтра 'ajaxOnly'. | CController |
| filterPostOnly() | Метод фильтра для фильтра 'postOnly'. | CController |
| filters() | Возвращает конфигурации фильтров. | CController |
| forward() | Обрабатывает запрос, используя другое действие контроллера. | CController |
| getAction() | Возвращает действие, которое выполняется в настоящее время; null, если активного действия нет. | CController |
| getActionParams() | Возвращает параметры запроса, которые будут использованы для связывания параметров действия. | CController |
| getCachingStack() | Возвращает стек объектов COutputCache. | CController |
| getClips() | Возвращает список клипов. | CController |
| getEventHandlers() | Возвращает список присоединённых обработчиков событий для события. | CComponent |
| getId() | Возвращает идентификатор контроллера. | CController |
| getLayoutFile() | Ищет шаблон представления на основе имени шаблона. | CController |
| getModule() | Возвращает модуль, к которому принадлежит этот контроллер. Возвращает null, если контроллер не принадлежит ни одному модулю. | CController |
| getPageState() | Возвращает значение состояния страницы. | CController |
| getPageTitle() | Возвращает заголовок страницы. По умолчанию — имя контроллера и имя действия. | CController |
| getRoute() | Возвращает маршрут (идентификатор модуля, идентификатор контроллера и идентификатор действия) текущего запроса. | CController |
| getUniqueId() | Возвращает идентификатор контроллера, префикс которого — идентификатор модуля (если имеется). | CController |
| getViewFile() | Ищет файл представления по заданному имени представления. | CController |
| getViewPath() | Возвращает директорию, содержащую файлы представлений для этого контроллера. | CExtController |
| hasEvent() | Определяет, определен ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли обработчики для указанного события. | CComponent |
| hasProperty() | Определяет, определена ли свойство. | CComponent |
| init() | Инициализирует контроллер. | CController |
| invalidActionParams() | Этот метод вызывается, когда параметры запроса не удовлетворяют требованиям указанного действия. | CController |
| isCachingStackEmpty() | Возвращает, пуст ли кэш-стек. | CController |
| missingAction() | Обрабатывает запрос, действие которого не распознано. | CController |
| processDynamicOutput() | Последовательная обработка динамического вывода. | CController |
| processOutput() | Последовательная обработка вывода, сгенерированного методом render(). | CController |
| raiseEvent() | Возбуждает событие. | CComponent |
| recordCachingAction() | Записывает вызов метода, когда активен кэш вывода. | CController |
| redirect() | Перенаправляет браузер на указанный URL или маршрут (контроллер/действие). | CController |
| refresh() | Обновляет текущую страницу. | CController |
| render() | Отображает представление с макетом. | CController |
| renderClip() | Отображает фрагмент с заданными параметрами. | CController |
| renderDynamic() | Отображает динамическое содержимое, возвращаемое указанной функцией обратного вызова. | CController |
| renderDynamicInternal() | Этот метод используется внутренним образом. | CController |
| renderFile() | Отображает файл представления. | CBaseController |
| renderInternal() | Отображает файл представления. | CBaseController |
| renderPartial() | Отображает представление. | CController |
| renderText() | Отображает статическую строку текста. | CController |
| resolveViewFile() | Находит файл представления по его имени. | CController |
| run() | Выполняет указанное действие. | CController |
| runAction() | Выполняет действие после прохождения всех фильтров. | CController |
| runActionWithFilters() | Выполняет действие с указанными фильтрами. | CController |
| setAction() | Устанавливает действие, которое в данный момент выполняется. | CController |
| setPageState() | Сохраняет значение состояния страницы для дальнейшего использования. | CController |
| setPageTitle() | Устанавливает заголовок страницы. | CController |
| setViewPath() | Устанавливает директорию, содержащую файлы представлений для данного контроллера. | CExtController |
| widget() | Создаёт виджет и выполняет его. | CBaseController |
Защищённые методы
| Метод | Описание | Определён в |
|---|---|---|
| afterAction() | Этот метод вызывается сразу после выполнения действия. | CController |
| afterRender() | Этот метод вызывается после отображения указанного представления с помощью метода render(). | CController |
| beforeAction() | Этот метод вызывается непосредственно перед выполнением действия (после всех возможных фильтров). | CController |
| beforeRender() | Этот метод вызывается в начале метода render(). | CController |
| createActionFromMap() | Создаёт экземпляр действия на основе карты действий. | CController |
| loadPageStates() | Загружает состояние страницы из скрытого поля ввода. | CController |
| replaceDynamicOutput() | Заменяет заглушки динамического содержимого фактическим содержимым. | CController |
| savePageStates() | Сохраняет состояние страницы в виде строки base64. | CController |
Подробное описание свойств
viewPath свойство
public string getViewPath()
public void setViewPath(string $value)
Возвращает директорию, содержащую файлы представлений для данного контроллера. Этот метод переопределяет родительскую реализацию, задавая путь к представлению как поддиректорию "views" в директории файла класса контроллера.
Подробное описание методов
getViewPath() метод
public string getViewPath() | ||
| {return} | строка | директория, содержащая файлы представлений для данного контроллера. |
Исходный код: framework/web/CExtController.php#36 (показать)
public function getViewPath()
{
if($this->_viewPath===null)
{
$class=new ReflectionClass(get_class($this));
$this->_viewPath=dirname($class->getFileName()).DIRECTORY_SEPARATOR.'views';
}
return $this->_viewPath;
}
Возвращает директорию, содержащую файлы представлений для этого контроллера. Этот метод переопределяет родительскую реализацию, задавая путь к представлению как поддиректорию "views" в директории файла класса контроллера.
setViewPath() метод
public void setViewPath(string $value) | ||
| $value | строка | директория, содержащая файлы представлений для этого контроллера. |
Исходный код: framework/web/CExtController.php#49 (показать)
public function setViewPath($value)
{
$this->_viewPath=$value;
}
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CExtController
