Класс yii\console\controllers\CacheController
| Наследование | yii\console\controllers\CacheController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/console/controllers/CacheController.php |
Позволяет очистить кэш.
см. список доступных компонентов для очистки:
yii cache
очистить конкретные компоненты, указанные по их именам:
yii cache/flush first second third
очистить все компоненты кэша, которые можно найти в системе
yii cache/flush-all
Обратите внимание, что команда использует компоненты кэша, определенные в файле конфигурации вашего консольного приложения. Если настроенные компоненты отличаются от компонентов веб-приложения, кэш веб-приложения не будет очищен. Чтобы исправить это, продублируйте компоненты кэша веб-приложения в конфигурации консоли. Вы можете использовать любые имена компонентов.
APC не разделяется между процессами PHP, поэтому очистка кэша из командной строки не повлияет на веб-приложение. Очистка кэша веб-приложения может быть выполнена следующим образом:
- Размещение php-файла в корне веб-приложения и вызов его через HTTP
- Использование Cachetool
Публичные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $action | yii\base\Action | Действие, которое в настоящее время выполняется. | yii\base\Controller |
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений. | yii\base\Component |
| $color | boolean | Включить ANSI цвет в выводе. | yii\console\Controller |
| $defaultAction | string | Идентификатор действия, используемого, когда идентификатор действия не указан в запросе. | yii\base\Controller |
| $help | boolean | Отображать ли справку о текущей команде. | yii\console\Controller |
| $helpSummary | string | yii\console\Controller | |
| $id | string | Идентификатор этого контроллера. | yii\base\Controller |
| $interactive | boolean | Выполнять ли команду в интерактивном режиме. | yii\console\Controller |
| $layout | null|string|false | Имя макета, который будет применяться к представлениям этого контроллера. | yii\base\Controller |
| $module | yii\base\Module | Модуль, к которому относится этот контроллер. | yii\base\Controller |
| $modules | yii\base\Module[] | Все родительские модули, в которых находится этот контроллер. | yii\base\Controller |
| $passedOptionValues | array | Свойства, соответствующие переданным параметрам. | yii\console\Controller |
| $passedOptions | array | Имена параметров, переданных во время выполнения. | yii\console\Controller |
| $route | string | Маршрут (ID модуля, ID контроллера и ID действия) текущего запроса. | yii\base\Controller |
| $uniqueId | string | ID контроллера, префикс которого содержит ID модуля (если таковой имеется). | yii\base\Controller |
| $view | yii\base\View|yii\web\View | Объект представления, который может использоваться для рендеринга представлений или файлов представлений. | yii\base\Controller |
| $viewPath | string | Директория, содержащая файлы представлений для этого контроллера. | yii\base\Controller |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | yii\base\Controller | |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| actionFlush() | Очищает указанные компоненты кэша. | yii\console\controllers\CacheController |
| actionFlushAll() | Очищает все кэши, зарегистрированные в системе. | yii\console\controllers\CacheController |
| actionFlushSchema() | Очищает кэш схемы БД для указанного компонента подключения. | yii\console\controllers\CacheController |
| actionIndex() | Отображает список кэшей, которые можно очистить. | yii\console\controllers\CacheController |
| actions() | Объявляет внешние действия для контроллера. | yii\base\Controller |
| afterAction() | Этот метод вызывается сразу после выполнения действия. | yii\base\Controller |
| ansiFormat() | Форматирует строку с кодами ANSI. | yii\console\Controller |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| beforeAction() | Этот метод вызывается непосредственно перед выполнением действия. | yii\base\Controller |
| behaviors() | Возвращает список поведений, которые должен иметь этот компонент. | yii\base\Component |
| bindActionParams() | Связывает параметры с действием. | yii\console\Controller |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| confirm() | Запрашивает подтверждение у пользователя, введя y или n. | yii\console\Controller |
| createAction() | Создаёт действие на основе данного идентификатора действия. | yii\base\Controller |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| findLayoutFile() | Находит соответствующий файл макета. | yii\base\Controller |
| getActionArgsHelp() | Возвращает справочную информацию по анонимным аргументам для действия. | yii\console\Controller |
| getActionHelp() | Возвращает подробную справочную информацию по указанному действию. | yii\console\Controller |
| getActionHelpSummary() | Возвращает краткое описание указанного действия в одной строке. | yii\console\Controller |
| getActionOptionsHelp() | Возвращает справочную информацию по опциям для действия. | yii\console\Controller |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все присоединённые к этому компоненту поведения. | yii\base\Component |
| getHelp() | Возвращает справочную информацию для этого контроллера. | yii\console\Controller |
| getHelpSummary() | Возвращает краткое описание этого контроллера в одной строке. | yii\console\Controller |
| getModules() | Возвращает все родительские модули этого контроллера. | yii\base\Controller |
| getOptionValues() | Возвращает свойства, соответствующие опциям для идентификатора действия. Подклассы могут переопределить этот метод для указания возможных свойств. | yii\console\Controller |
| getPassedOptionValues() | Возвращает свойства, соответствующие переданным опциям. | yii\console\Controller |
| getPassedOptions() | Возвращает имена допустимых опций, переданных во время выполнения. | yii\console\Controller |
| getRoute() | Возвращает маршрут текущего запроса. | yii\base\Controller |
| getUniqueId() | Возвращает уникальный идентификатор контроллера. | yii\base\Controller |
| getView() | Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Controller |
| getViewPath() | Возвращает каталог, содержащий файлы представлений для этого контроллера. | yii\base\Controller |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли какой-либо обработчик, присоединённый к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| isColorEnabled() | Возвращает значение, указывающее, включен ли цвет ANSI. | yii\console\Controller |
| off() | Отсоединяет существующий обработчик событий от данного компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| optionAliases() | Возвращает псевдонимы опций. | yii\console\Controller |
| options() | Возвращает имена допустимых опций для действия (id). Опция требует существования публичного члена-переменной, имя которого совпадает с именем опции. | yii\console\Controller |
| prompt() | Запрашивает ввод пользователя и проверяет его. | yii\console\Controller |
| render() | Отображает представление и применяет макет, если он доступен. | yii\base\Controller |
| renderContent() | Отображает статическую строку, применяя макет. | yii\base\Controller |
| renderFile() | Отображает файл представления. | yii\base\Controller |
| renderPartial() | Отображает представление без применения макета. | yii\base\Controller |
| run() | Выполняет запрос, указанный в виде маршрута. | yii\base\Controller |
| runAction() | Выполняет действие с заданным идентификатором действия и параметрами. | yii\console\Controller |
| select() | Предлагает пользователю выбор из вариантов. Ввод '?' покажет список опций с их объяснениями. | yii\console\Controller |
| setView() | Устанавливает объект представления, используемый этим контроллером. | yii\base\Controller |
| setViewPath() | Устанавливает каталог, содержащий файлы представлений. | yii\base\Controller |
| stderr() | Выводит строку в STDERR | yii\console\Controller |
| stdout() | Выводит строку в STDOUT | yii\console\Controller |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| getActionMethodReflection() | yii\console\Controller | |
| parseDocCommentDetail() | Возвращает полное описание из docблока. | yii\console\Controller |
| parseDocCommentSummary() | Возвращает первую строку docблока. | yii\console\Controller |
| parseDocCommentTags() | Разбирает блок комментариев на теги. | yii\console\Controller |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_ACTION | yii\base\ActionEvent | Событие, срабатывающее сразу после выполнения действия контроллера. | yii\base\Controller |
| EVENT_BEFORE_ACTION | yii\base\ActionEvent | Событие, срабатывающее непосредственно перед выполнением действия контроллера. | yii\base\Controller |
Константы
| Константа | Значение | Описание | Определено в |
|---|---|---|---|
| EXIT_CODE_ERROR | 1 | yii\console\Controller | |
| EXIT_CODE_NORMAL | 0 | yii\console\Controller |
Подробное описание методов
actionFlush() общедоступный метод
Очищает заданные компоненты кеша.
Например,
# flushes caches specified by their id: "first", "second", "third" yii cache/flush first second third
| public void actionFlush ( ) |
|---|
actionFlushAll() общедоступный метод
Очищает все кеши, зарегистрированные в системе.
| public void actionFlushAll ( ) |
|---|
actionFlushSchema() общедоступный метод (доступен с версии 2.0.1)
Очищает кеш схемы БД для заданного компонента подключения.
# clears cache schema specified by component id: "db" yii cache/flush-schema db
| public целое число actionFlushSchema ( $db = 'db' ) | ||
|---|---|---|
| $db | строка |
Идентификатор компонента подключения |
| return | целое число |
Код выхода |
| throws | yii\console\Exception | |
| throws | yii\base\InvalidConfigException | |
actionIndex() общедоступный метод
Отображает кеши, которые можно очистить.
| public void actionIndex ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-console-controllers-cachecontroller.html
