Класс 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|integer
Код завершения или null для успеха

executeCommand()source public

executeCommand( string|Cake\Console\Command $command , array $args = [] , Cake\Console\ConsoleIo $io = null )

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

Параметры

строка|Cake\Console\Command $command

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

массив $args необязательно []

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

Cake\Console\ConsoleIo $io необязательно null

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

Возвращает

integer|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

Объект ввода-вывода консоли

Возвращает

integer|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 optional 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 optional LogLevel::ERROR

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

string|array $context optional []

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

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

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 Table, как требуется. Также может использоваться для загрузки других типов объектов хранилища, используемых вашим приложением.

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

Параметры

string|null $modelClass optional null

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

string|null $modelType optional 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 optional null

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

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

string|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

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

Параметры

string $modelType

Тип модели

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

$this

'cake unknown'