Класс Command

__construct()source public

__construct( )

Конструктор

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

abort()source public

abort( integer $code = self::CODE_ERROR )

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

Параметры

целое $code необязательно self::CODE_ERROR

Код выхода для использования.

Исключения

Cake\Console\Exception\StopException

buildOptionParser()source protected

buildOptionParser( Cake\Console\ConsoleOptionParser $parser )

Метод-обработчик для определения парсера опций этой команды.

Параметры

Cake\Console\ConsoleOptionParser $parser

Парсер для определения

Возвращаемое значение

Cake\Console\ConsoleOptionParser
Построенный парсер.

displayHelp()source protected

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

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

Параметры

Cake\Console\ConsoleOptionParser $parser

Парсер опций.

Cake\Console\Arguments $args

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

Cake\Console\ConsoleIo $io

Ввод-вывод консоли

execute()source public

execute( Cake\Console\Arguments $args , Cake\Console\ConsoleIo $io )

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

Параметры

Cake\Console\Arguments $args

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

Cake\Console\ConsoleIo $io

Ввод-вывод консоли

Возвращаемое значение

null|целое
Код выхода или null для успеха

getName()source public

getName( )

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

Возвращаемое значение

строка

getOptionParser()source public

getOptionParser( )

Получить парсер опций.

Вы можете переопределить buildOptionParser(), чтобы определить свои опции и аргументы.

Возвращаемое значение

Cake\Console\ConsoleOptionParser

Исключения

RuntimeException
При некорректном парсере

initialize()source public

initialize( )

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

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

run()source public

run( array $argv , Cake\Console\ConsoleIo $io )

Выполнить команду.

Параметры

массив $argv

Аргументы из среды командной строки.

Cake\Console\ConsoleIo $io

Ввод-вывод консоли

Возвращаемое значение

целое|null
Код выхода или null для успеха.

setName()source public

setName( string $name )

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

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

Параметры

строка $name

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

Возвращаемое значение

$this

Исключения

InvalidArgumentException

setOutputLevel()source protected

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

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

Параметры

Cake\Console\Arguments $args

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

Cake\Console\ConsoleIo $io

Ввод-вывод консоли

getTableLocator()source public

getTableLocator( )

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

Возвращаемое значение

Cake\ORM\Locator\LocatorInterface

setTableLocator()source public

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

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

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator

Экземпляр LocatorInterface.

Возвращаемое значение

$this

tableLocator()source public deprecated

tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator = null )

Устанавливает локатор таблиц. Если параметры не переданы, возвращает текущий используемый локатор.

Устаревшее

3.5.0 Используйте getTableLocator()/setTableLocator() вместо этого.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator необязательно null

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

log()source public

log( mixed $msg , integer|string $level = LogLevel::ERROR , string|array $context = [] )

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

Параметры

mixed $msg

Сообщение журнала.

integer|string $level необязательно LogLevel::ERROR

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

string|array $context необязательно []

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

Возвращает

boolean
Результат записи в журнал.

_setModelClass()source protected

_setModelClass( string $name )

Устанавливает свойства modelClass и modelKey, основываясь на соглашениях.

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

Параметры

string $name

Имя класса.

getModelType()source public

getModelType( )

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

Возвращает

string

loadModel()source public

loadModel( string|null $modelClass = null , string|null $modelType = null )

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

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

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

Параметры

string|null $modelClass необязательно null

Имя класса модели для загрузки. По умолчанию $this->modelClass

string|null $modelType необязательно null

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

Возвращает

Cake\Datasource\RepositoryInterface
Созданный экземпляр модели.

Выбрасывает

Cake\Datasource\Exception\MissingModelException
Если класс модели не найден.
InvalidArgumentException
При использовании типа, который не был зарегистрирован.
UnexpectedValueException
Если тип модели не определен

modelFactory()source public

modelFactory( string $type , callable $factory )

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

Параметры

string $type

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

callable $factory

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

modelType()source public deprecated

modelType( string|null $modelType = null )

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

Устаревшее

3.5.0 Используйте getModelType()/setModelType() вместо этого.

Параметры

string|null $modelType необязательно null

Тип модели или null для получения текущего

Возвращает

string|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

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

Параметры

string $modelType

Тип модели

Возвращает

$this

'cake unknown'