Класс VersionCommand

execute()source public

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

Выводит версию используемой CakePHP.

Параметры

Cake\Console\Arguments $args

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

Cake\Console\ConsoleIo $io

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

Возвращает

integer

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

Cake\Console\Command::execute()

__construct()source public

__construct( )

Конструктор

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

abort()source public

abort( integer $code = self::CODE_ERROR )

Прекращает текущий процесс с исключением StopException.

Параметры

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

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

executeCommand()source public

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

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

Параметры

string|Cake\Console\Command $command

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

array $args необязательно []

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

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

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

Возвращает

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

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 необязательно 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 необязательно LogLevel::ERROR

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

string|array $context необязательно []

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

Возвращает

boolean
Успех записи в журнал.

_setModelClass()source protected

_setModelClass( string $name )

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

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

Параметры

строка $name

Имя класса.

getModelType()source public

getModelType( )

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

Возвращает

строка

loadModel()source public

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

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

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

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

Параметры

строка|null $modelClass необязательно null

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

строка|null $modelType необязательно null

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

Возвращает

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

Выбрасывает

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

modelFactory()source public

modelFactory( string $type , callable $factory )

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

Параметры

строка $type

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

вызываемый $factory

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

modelType()source public deprecated

modelType( string|null $modelType = null )

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

Устарело

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

Параметры

строка|null $modelType необязательно null

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

Возвращает

строка|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

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

Параметры

строка $modelType

Тип модели

Возвращает

$this