Класс 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 необязательно 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 )

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

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

Если поставщик репозитория не возвращает объект, будет выброшено исключение 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