Класс HelpCommand

asText()source protected

asText( Cake\Console\ConsoleIo $io , ArrayIterator $commands )

Вывод текста.

Параметры

Cake\Console\ConsoleIo $io

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

ArrayIterator $commands

Коллекция команд для вывода.

asXml()source protected

asXml( Cake\Console\ConsoleIo $io , ArrayIterator $commands )

Вывод в формате XML

Параметры

Cake\Console\ConsoleIo $io

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

ArrayIterator $commands

Коллекция команд для вывода

buildOptionParser()source protected

buildOptionParser( Cake\Console\ConsoleOptionParser $parser )

Получение и настройка экземпляра анализатора опций.

Параметры

Cake\Console\ConsoleOptionParser $parser

Анализатор для построения

Возвращает

Cake\Console\ConsoleOptionParser

Переопределяет

Cake\Console\Command::buildOptionParser()

execute()source public

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

Основная функция Вывод списка команд.

Параметры

Cake\Console\Arguments $args

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

Cake\Console\ConsoleIo $io

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

Возвращает

integer

Переопределяет

Cake\Console\Command::execute()

setCommandCollection()source public

setCommandCollection( Cake\Console\CommandCollection $commands )

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

Параметры

Cake\Console\CommandCollection $commands

Используемые команды.

Реализация

Cake\Console\CommandCollectionAwareInterface::setCommandCollection()

__construct()source public

__construct( )

Конструктор

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

abort()source public

abort( integer $code = self::CODE_ERROR )

Прекратить текущий процесс с StopException.

Параметры

integer $code optional self::CODE_ERROR

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

Выбрасывает

Cake\Console\Exception\StopException

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

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

getName()source public

getName( )

Получение имени команды.

Возвращает

string

getOptionParser()source public

getOptionParser( )

Получение анализатора опций.

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

Возвращает

Cake\Console\ConsoleOptionParser

Выбрасывает

RuntimeException
Если анализатор недействителен

initialize()source public

initialize( )

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

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

run()source public

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

Выполнение команды.

Параметры

array $argv

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

Cake\Console\ConsoleIo $io

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

Возвращает

integer|null
Код выхода или null для успешного выполнения.

setName()source public

setName( string $name )

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

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

Параметры

string $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

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