Класс ConsoleShell

Предоставляет очень базовый «интерактивный» консоль для приложений CakePHP.

AppShell

ConsoleShell

Пакет: Cake\Console\Command
Устаревшее: 3.0.0 Устарело начиная с версии 2.4, будет удалено в версии 3.0
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Console/Command/ConsoleShell.php

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

$_finished protected

mixed
_finished
$_methodPatterns protected

array
_methodPatterns
$associations public

array
Доступные типы связывания
$badCommandChars public

array
Символы, описывающие недопустимые команды
$models public

array
Доступные модели

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

_bind() protected
Связать ассоциацию
_columns() protected
Отобразить столбцы для модели
_exit() protected
Установить свойство finiished, чтобы цикл в методе main завершился
_find() protected
Выполнить поиск
_isValidModel() protected
Указывает, включена ли указанная модель в список доступных моделей
_loadRoutes() protected

Перезагружает конфигурацию маршрутов из app/Config/routes.php и компилирует все найденные маршруты
_method() protected
Определить метод для обработки текущей команды
_models() protected
Список всех моделей
_routeToArray() protected
Разбор строкового URL и отображение в виде массива
_routeToString() protected
Разбор массива URL и отображение эквивалентного URL в виде строки
_routesReload() protected
Перезагрузить определения маршрутов
_routesShow() protected
Показать все маршруты
_save() protected
Сохранить запись
_unbind() protected
Отвязать ассоциацию
getOptionParser() public
Получить экземпляр парсера опций и настроить его.
help() public
Выводит сообщение справки
main() public
Переопределяет main() для обработки действия
startup() public
Переопределяет запуск Shell

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

_bind()source protected

_bind( mixed $command )

Связать ассоциацию

Параметры

mixed $command: Команда для выполнения.

_columns()source protected

_columns( mixed $command )

Отобразить столбцы для модели

Параметры

mixed $command: Команда для выполнения.

_exit()source protected

_exit( )

Установить свойство finiished, чтобы цикл в методе main завершился

_find()source protected

_find( mixed $command )

Выполнить поиск

Параметры

mixed $command: Команда для выполнения.

_isValidModel()source protected

_isValidModel( string $modelToCheck )

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

Параметры

string $modelToCheck: Модель для проверки.

Возвращает

boolean
true, если модель доступна, иначе false

_loadRoutes()source protected

_loadRoutes( )

Перезагружает конфигурацию маршрутов из app/Config/routes.php и компилирует все найденные маршруты

Возвращает

boolean
True, если перезагрузка конфигурации прошла успешно, иначе false

_method()source protected

_method( string $command )

Определить метод для обработки текущей команды

Параметры

string $command: Команда для выполнения.

Возвращает

string
или false

_models()source protected

_models( )

Список всех моделей

_routeToArray()source protected

_routeToArray( mixed $command )

Разбор строкового URL и отображение в виде массива

Параметры

mixed $command: Команда для выполнения.

_routeToString()source protected

_routeToString( mixed $command )

Разбор массива URL и отображение эквивалентного URL в виде строки

Параметры

mixed $command: Команда для выполнения.

_routesReload()source protected

_routesReload( )

Перезагрузить определения маршрутов

_routesShow()source protected

_routesShow( )

Отобразить все маршруты

_save()source protected

_save( mixed $command )

Сохранить запись

Параметры

mixed $command: Команда для выполнения.

_unbind()source protected

_unbind( mixed $command )

Отвязать ассоциацию

Параметры

mixed $command: Команда для выполнения.

getOptionParser()source public

getOptionParser( )

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

Возвращает

ConsoleOptionParser

END_OF_DOCUMENT_MARKER

help()source public

help( )

Выводит сообщение справки

main()source public

main( string $command null )

Переопределите main() для обработки действия

Параметры

строка $command необязательно null: Команда для выполнения.

startup()source public

startup( )

Переопределите запуск Shell

Подробности свойств

$_finishedsource

protected mixed

_finished

Этот shell работает постоянно, установка этого свойства в true завершает процесс

false

$_methodPatternssource

protected массив

_methodPatterns

array(
    'help' => '/^(help|\?)/',
    '_exit' => '/^(quit|exit)/',
    '_models' => '/^models/i',
    '_bind' => '/^(\w+) bind (\w+) (\w+)/',
    '_unbind' => '/^(\w+) unbind (\w+) (\w+)/',
    '_find' => '/.+->find/',
    '_save' => '/.+->save/',
    '_columns' => '/^(\w+) columns/',
    '_routesReload' => '/^routes\s+reload/i',
    '_routesShow' => '/^routes\s+show/i',
    '_routeToString' => '/^route\s+(\(.*\))$/i',
    '_routeToArray' => '/^route\s+(.*)$/i',
)

$associationssource

public массив

Доступные типы связывания

array('hasOne', 'hasMany', 'belongsTo', 'hasAndBelongsToMany')

$badCommandCharssource

public массив

Символы, описывающие недопустимые команды

array('$', ';')

$modelssource

public массив

Доступные модели

array()

© 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/2.10/class-ConsoleShell.html