Spec-Zone.ru › CakePHP 3.4

Класс CommandCollection

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

Используется приложениями для добавления в белый список своих команд консоли. CakePHP будет использовать сопоставленные команды для построения и отправки команд оболочки.

Cake\Console\CommandCollection реализует IteratorAggregate, Countable
Пространство имён: Cake\Console
Расположение: Console/CommandCollection.php

Краткое описание свойств

  • $commands protected
    array
    Список команд

Краткое описание методов

  • __construct() public
    Конструктор
  • add() public
    Добавление команды в коллекцию
  • addMany() public
    Добавление нескольких команд сразу.
  • autoDiscover() public
    Автоматическое обнаружение команд оболочки в CakePHP, приложении и всех плагинах.
  • count() public
    Реализация Countable.
  • get() public
    Получение целевой команды.
  • getIterator() public
    Реализация IteratorAggregate.
  • has() public
    Проверка наличия команды в коллекции по её имени.
  • remove() public
    Удаление команды из коллекции, если она существует.

Подробное описание методов

__construct()source public

__construct( array $commands [] )

Конструктор

Параметры

массив $commands необязательно []
Список команд для добавления в коллекцию.

add()source public

add( string $name , string|Cake\Console\Shell $command )

Добавление команды в коллекцию

Параметры

строка $name
Имя команды, которую нужно сопоставить.
строка|Cake\Console\Shell $command
Команда для сопоставления.

Возвращает


$this

addMany()source public

addMany( array $commands )

Добавление нескольких команд сразу.

Параметры

массив $commands
Список имен команд => классов/экземпляров команд.

Возвращает


$this

См. также

\Cake\Console\CommandCollection::add()

autoDiscover()source public

autoDiscover( )

Автоматическое обнаружение команд оболочки в CakePHP, приложении и всех плагинах.

Команды будут обнаружены с использованием соглашений о файловой системе. Команды обнаруживаются в следующем порядке:

  • Команды CakePHP
  • Команды приложения
  • Команды плагинов

Команды из плагинов будут добавлены в соответствии с порядком загрузки плагинов. Команды оболочки из плагинов будут пытаться использовать короткое имя. Однако, если плагин предоставляет команду оболочки, которая конфликтует с CakePHP или командами приложения, будет использоваться полное plugin_name.shell имя. Команды оболочки плагинов добавляются в порядке загрузки плагинов.

Возвращает

массив
Массив имён команд и их классов.

count()source public

count( )

Реализация Countable.

Получение количества команд в коллекции.

Возвращает

целое число

Реализация

Countable::count()

get()source public

get( string $name )

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

Параметры

строка $name
Имя команды оболочки.

Возвращает

строка|Cake\Console\Shell
Класс или экземпляр команды.

Исключения

InvalidArgumentException
при попытке получить неизвестную команду.

getIterator()source public

getIterator( )

Реализация IteratorAggregate.

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $name )

Проверка наличия команды в коллекции по её имени.

Параметры

строка $name
Имя команды оболочки.

Возвращает

логическое значение

remove()source public

remove( string $name )

Удаление команды из коллекции, если она существует.

Параметры

строка $name
Имя команды оболочки.

Возвращает


$this

Подробное описание свойств

$commandssource

protected массив

Список команд

[]

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Console.CommandCollection.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API