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

findPrefixedName()source protected

findPrefixedName( array $names )

Параметры

массив $names

Имена

Возвращает

string|null

getShortestName()source protected

getShortestName( array $names )

Параметры

массив $names

Имена

Возвращает

string

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.

Параметры

целое $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

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

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

Параметры

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. Имя может быть псевдонимом, например, '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