Spec-Zone.ru › CakePHP 4.2

Класс CacheClearallCommand

Команда CacheClearall.

Пространство имен: Cake\Command

Константы

  • int
    CODE_ERROR 
    1

    Код ошибки по умолчанию

  • int
    CODE_SUCCESS 
    0

    Код успешного выполнения по умолчанию

Краткое описание полей

  • $_modelFactories protected
    (callableCake\Datasource\Locator\LocatorInterface)[]

    Список переопределенных функций фабрики моделей.

  • $_modelType protected
    string

    Тип модели для использования.

  • $_tableLocator protected
    Cake\ORM\Locator\LocatorInterface|null

    Экземпляр локатора таблиц

  • $modelClass protected
    string|null

    Имя основного класса модели этого объекта. Должно быть во множественном числе. CakePHP не будет склонять имя.

  • $name protected
    string

    Имя этой команды.

Краткое описание методов

  • __construct() public

    Конструктор

  • _setModelClass() protected

    Устанавливает свойство modelClass на основе соглашений.

  • abort() public

    Приостанавливает текущий процесс с помощью StopException.

  • buildOptionParser() public

    Метод-хук для определения парсера параметров этой команды.

  • defaultName() public static

    Получить имя команды.

  • displayHelp() protected

    Вывод справки

  • execute() public

    Реализуйте этот метод с логикой вашей команды.

  • executeCommand() public

    Выполнить другую команду с заданным набором аргументов.

  • getModelType() public

    Получить тип модели, который будет использоваться этим классом

  • getName() public

    Получить имя команды.

  • getOptionParser() public

    Получить парсер параметров.

  • getRootName() public

    Получить имя корневой команды.

  • getTableLocator() public

    Получает локатор таблиц.

  • initialize() public

    Метод-хук, вызываемый CakePHP, когда команда вот-вот будет выполнена.

  • loadModel() public

    Загружает и создает объекты репозитория, необходимые этому объекту

  • log() public

    Удобный метод для записи сообщения в Log. См. Log::write() для получения дополнительной информации о записи в журналы.

  • modelFactory() public

    Переопределить существующий вызываемый объект для генерации репозиториев заданного типа.

  • run() public

    Запустить команду.

  • setModelType() public

    Установить тип модели, который будет использоваться этим классом

  • setName() public

    Установить имя, которое эта команда использует в коллекции.

  • setOutputLevel() protected

    Установить уровень вывода на основе Arguments.

  • setTableLocator() public

    Устанавливает локатор таблиц.

END_OF_DOCUMENT_MARKER

Краткое описание методов

__construct() public 

__construct()

Конструктор

По умолчанию CakePHP создает объекты команд при построении CommandCollection для вашего приложения.

_setModelClass() protected 

_setModelClass(string $name): void

Устанавливает свойство modelClass на основе соглашений.

Если свойство уже установлено, оно не будет перезаписано

Параметры

string $name

Имя класса.

Возвращает

void

abort() public 

abort(int $code = self::CODE_ERROR): void

Приостанавливает текущий процесс с помощью StopException.

Параметры

int $code optional

Код выхода, который нужно использовать.

Возвращает

void

Вызывает исключение

Cake\Console\Exception\StopException

buildOptionParser() public 

buildOptionParser(Cake\Console\ConsoleOptionParser $parser): Cake\Console\ConsoleOptionParser

Метод-хук для определения парсера параметров этой команды.

Параметры

Cake\Console\ConsoleOptionParser $parser

Парсер, который нужно определить

Возвращает

Cake\Console\ConsoleOptionParser

См. также

https://book.cakephp.org/4/en/console-commands/option-parsers.html

defaultName() public static 

defaultName(): string

Получить имя команды.

Возвращает имя команды на основе имени класса. Например, для команды с именем класса UpdateTableCommand возвращаемое имя по умолчанию будет 'update_table'.

Возвращает

string

displayHelp() protected 

displayHelp(Cake\Console\ConsoleOptionParser $parser, Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

Вывод содержимого справки

Параметры

Cake\Console\ConsoleOptionParser $parser

Парсер параметров.

Cake\Console\Arguments $args

Аргументы команды.

Cake\Console\ConsoleIo $io

Консольный ввод/вывод

Возвращает

void

execute() public 

execute(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): int|null

Реализуйте этот метод с логикой вашей команды.

Параметры

Cake\Console\Arguments $args

Аргументы команды.

Cake\Console\ConsoleIo $io

Консольный ввод/вывод

Возвращает

int|null

executeCommand() public 

executeCommand(stringCake\Console\CommandInterface $command, array $args = [], Cake\Console\ConsoleIo $io = null): int|null

Выполнить другую команду с заданным набором аргументов.

Если вы используете строковое имя команды, зависимости этой команды не будут разрешены с помощью контейнера приложения. Вместо этого вам нужно будет передать команду как объект со всеми её зависимостями.

Параметры

stringCake\Console\CommandInterface $command

Имя класса команды или экземпляр команды.

array $args optional

Аргументы для вызова команды.

Cake\Console\ConsoleIo $io optional

Экземпляр ConsoleIo для использования с выполненной командой.

Возвращает

int|null

getModelType() public 

getModelType(): string

Получить тип модели, который будет использоваться этим классом

Возвращает

string

getName() public 

getName(): string

Получить имя команды.

Возвращает

string

getOptionParser() public 

getOptionParser(): Cake\Console\ConsoleOptionParser

Получить парсер параметров.

Вы можете переопределить buildOptionParser() для определения ваших параметров и аргументов.

Возвращает

Cake\Console\ConsoleOptionParser

Вызывает исключение

RuntimeException
Когда парсер недействителен

getRootName() public 

getRootName(): string

Получить имя корневой команды.

Возвращает

string

getTableLocator() public 

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Получает локатор таблиц.

Возвращает

Cake\ORM\Locator\LocatorInterface

initialize() public 

initialize(): void

Метод-хук, вызываемый CakePHP, когда команда собирается быть выполнена.

Переопределите этот метод и реализуйте дорогостоящие/важные этапы настройки, которые не должны выполняться при каждом запуске команды. Этот метод будет вызван до того, как параметры и аргументы будут проверены и обработаны.

Возвращает

void

loadModel() public 

loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterface

Загружает и создает объекты хранилища, необходимые этому объекту

Обычно используется для загрузки объектов таблиц ORM по мере необходимости. Может также использоваться для загрузки других типов объектов хранилища, используемых вашим приложением.

Если поставщик хранилища не возвращает объект, будет выброшено исключение MissingModelException.

Параметры

string|null $modelClass optional

Имя класса модели для загрузки. По умолчанию $this->modelClass. Имя может быть псевдонимом, например 'Post' или FQCN, например App\Model\Table\PostsTable::class.

string|null $modelType optional

Тип хранилища для загрузки. По умолчанию значение getModelType().

Возвращает

Cake\Datasource\RepositoryInterface

Вызывает исключение

Cake\Datasource\Exception\MissingModelException
Если класс модели не может быть найден.
UnexpectedValueException
Если аргумент $modelClass не указан, и значение свойства ModelAwareTrait::$modelClass пустое.

log() public 

log(string $message, int|string $level = LogLevel::ERROR, string|array $context = []): bool

Удобный метод для записи сообщения в Log. См. Log::write() для получения дополнительной информации о записи в журналы.

Параметры

string $message

Журнальное сообщение.

int|string $level optional

Уровень ошибки.

string|array $context optional

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

bool

modelFactory() public 

modelFactory(string $type, callableCake\Datasource\Locator\LocatorInterface $factory): void

Переопределите существующую вызываемую функцию для генерации хранилищ заданного типа.

Параметры

string $type

Имя типа хранилища, для которого предназначена функция фабрики.

callableCake\Datasource\Locator\LocatorInterface $factory

Функция фабрики, используемая для создания экземпляров.

Возвращает

void

run() public 

run(array $argv, Cake\Console\ConsoleIo $io): int|null

Запустить команду.

Параметры

array $argv
Cake\Console\ConsoleIo $io

Возвращает

int|null

setModelType() public 

setModelType(string $modelType): $this

Установить тип модели, который будет использоваться этим классом

Параметры

string $modelType

Тип модели

Возвращает

$this

setName() public 

setName(string $name): $this

Установить имя, которое эта команда использует в коллекции.

Обычно вызывается CommandCollection при добавлении команды. Необходимо иметь хотя бы один пробел в имени, чтобы можно было вычислить корневую команду.

Параметры

string $name

Возвращает

$this

setOutputLevel() protected 

setOutputLevel(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

Установить уровень вывода на основе аргументов.

Parameters

Cake\Console\Arguments $args

Аргументы команды.

Cake\Console\ConsoleIo $io

Консольный ввод/вывод

Returns

void

setTableLocator() public 

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

Устанавливает локатор таблицы.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator

Экземпляр LocatorInterface.

Returns

$this

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

$_modelFactories protected

Список переопределенных функций фабрики моделей.

Type

(callableCake\Datasource\Locator\LocatorInterface)[]

$_modelType protected

Тип модели для использования.

Type

string

$_tableLocator protected

Экземпляр локатора таблицы

Type

Cake\ORM\Locator\LocatorInterface|null

$modelClass protected

Имя основного класса модели этого объекта. Должно быть во множественном числе. CakePHP не будет склонять имя.

Пример: Для объекта с именем 'Comments', modelClass будет 'Comments'. Классы плагинов должны использовать имена в стиле Plugin.Comments для корректной загрузки моделей из правильного плагина.

Используйте пустую строку, чтобы не использовать автозагрузку для этого объекта. Null определяет автоматически на основе имени контроллера.

Type

string|null

$name protected

Имя этой команды.

Type

string

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Command.CacheClearallCommand.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API