Класс 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 )

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

Deprecated

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

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator optional null

Экземпляр LocatorInterface.

Returns

Cake\ORM\Locator\LocatorInterface

log()source public

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

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

Parameters

mixed $msg

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

integer|string $level optional LogLevel::ERROR

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

string|array $context optional []

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

Returns

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

_setModelClass()source protected

_setModelClass( string $name )

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

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

Parameters

string $name

Имя класса.

getModelType()source public

getModelType( )

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

Returns

string

loadModel()source public

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

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

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

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

Parameters

string|null $modelClass optional null

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

string|null $modelType optional null

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

Returns

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

Throws

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

modelFactory()source public

modelFactory( string $type , callable $factory )

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

Parameters

string $type

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

callable $factory

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

modelType()source public deprecated

modelType( string|null $modelType = null )

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

Deprecated

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

Parameters

string|null $modelType optional null

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

Returns

string|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

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

Parameters

string $modelType

Тип модели

Returns

$this

'cake unknown'