Класс TestsuiteShell

_parseArgs()source protected

_parseArgs( )

Парсит опции командной строки в массив, который может использовать CakeTestDispatcher.

Возвращает

array
Массив параметров для CakeTestDispatcher

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

TestShell::_parseArgs()

getOptionParser()source public

getOptionParser( )

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

Возвращает

ConsoleOptionParser

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

TestShell::getOptionParser()

main()source public

main( )

Основная точка входа в эту оболочку

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

TestShell::main()

_mapFileToCase()source protected

_mapFileToCase( string $file , string $category , boolean $throwOnMissingFile true )

Находит тестовый случай для переданного файла. Сам файл может быть тестом.

Параметры

string $file

Файл для сопоставления.

string $category

Категория тестового файла.

boolean $throwOnMissingFile необязательно true

Вызывать ли исключение.

Возвращает

array
array(тип, случай)

Выбрасывает

Исключение

_mapFileToCategory()source protected

_mapFileToCategory( string $file )

Для данного файла, к какой категории тестов он относится? Возвращает приложение, ядро или имя плагина.

Параметры

string $file

Файл для сопоставления.

Возвращает

string

_run()source protected

_run( array $runnerArgs , array $options array() )

Выполняет тестовый случай из $runnerArgs

Параметры

array $runnerArgs

список аргументов, полученных из _parseArgs()

array $options необязательно массив()

список опций, созданных _runnerOptions()

_runnerOptions()source protected

_runnerOptions( )

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

Возвращает

array
Массив параметров для CakeTestDispatcher

available()source public

available( )

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

initialize()source public

initialize( )

Метод инициализации устанавливает PHPUnit и загружает все плагины

Выбрасывает

Исключение

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

Shell::initialize()

__construct()source public

__construct( ConsoleOutput $stdout null , ConsoleOutput $stderr null , ConsoleInput $stdin null )

Создаёт экземпляр этой оболочки.

Параметры

ConsoleOutput $stdout необязательно null

Объект ConsoleOutput для stdout.

ConsoleOutput $stderr необязательно null

Объект ConsoleOutput для stderr.

ConsoleInput $stdin необязательно null

Объект ConsoleInput для stdin.

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell

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

Object::__construct()

__get()source public

__get( string $name )

Перегрузка get для ленивой загрузки задач

Параметры

string $name

Имя свойства для доступа.

Возвращает

Shell
Объект задачи

__isset()source public

__isset( string $name )

Лениво загружает модели, используя метод loadModel(), если объявлен в $uses

Параметры

string $name

Имя модели для поиска.

_checkUnitTest()source protected

_checkUnitTest( )

Действие по созданию тестового модуля

Возвращает

boolean
Успех

_controllerName()source protected

_controllerName( string $name )

Создаёт правильное множественное имя контроллера для указанного имени класса контроллера

Параметры

string $name

Имя класса контроллера

Возвращает

string
Множественное имя контроллера

_controllerPath()source protected

_controllerPath( string $name )

Создаёт правильный путь к контроллеру для указанного имени класса контроллера

Параметры

string $name

Имя класса контроллера

Возвращает

string
Путь к контроллеру

_displayHelp()source protected

_displayHelp( string $command )

Отображает справку в правильном формате

Параметры

string $command

Команда, для которой требуется справка.

_getInput()source protected

_getInput( string $prompt , string|array $options , string $default )

Запрашивает у пользователя ввод и возвращает его.

Параметры

строка $prompt

Текст запроса.

строка|массив $options

Массив или строка опций.

строка $default

Значение ввода по умолчанию.

Возвращает

Либо
значение по умолчанию, либо введенное пользователем значение.

_loadModels()source protected

_loadModels( )

Если $uses — массив, загружает каждый из моделей в массиве.

Возвращает

boolean

_modelKey()source protected

_modelKey( string $name )

Создаёт правильный подчеркнутый ключ модели для ассоциаций.

Параметры

строка $name

Имя класса модели

Возвращает

строка
Единичный ключ модели

_modelName()source protected

_modelName( string $name )

Создаёт правильное именованное имя модели (единственного числа) для указанного имени.

Параметры

строка $name

Имя

Возвращает

строка
Камелизированное и единственное число модели имя

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

Создаёт правильное имя модели из внешнего ключа.

Параметры

строка $key

Внешний ключ

Возвращает

строка
Имя модели

_pluginPath()source protected

_pluginPath( string $pluginName )

Находит правильный путь для плагина. Сканирует $pluginPaths для нужного плагина.

Параметры

строка $pluginName

Имя плагина, например DebugKit

Возвращает

строка
Путь к нужному плагину.

_pluralHumanName()source protected

_pluralHumanName( string $name )

Создаёт множественное имя, используемое в представлениях.

Параметры

строка $name

Имя контроллера

Возвращает

строка
Множественное имя

_pluralName()source protected

_pluralName( string $name )

Создаёт множественное имя для представлений.

Параметры

строка $name

Используемое имя

Возвращает

строка
Множественное имя для представлений

_singularHumanName()source protected

_singularHumanName( string $name )

Создаёт единственное имя, используемое в представлениях.

Параметры

строка $name

Имя контроллера

Возвращает

строка
Единственное имя

_singularName()source protected

_singularName( string $name )

Создаёт единственное имя для использования в представлениях.

Параметры

строка $name

Множественное подчеркнутое значение.

Возвращает

строка
Имя

_useLogger()source protected

_useLogger( boolean $enable true )

Используется для включения или выключения вывода логов в stdout и stderr. Если вы не хотите видеть всё, что регистрируется через CakeLog в stdout или stderr, вызовите эту функцию с первым параметром false.

Параметры

boolean $enable опционально true

Включить ли вывод CakeLog

_welcome()source protected

_welcome( )

Отображает заголовок оболочки.

clear()source public

clear( )

Очистить консоль

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::clear

createFile()source public

createFile( string $path , string $contents )

Создаёт файл по заданному пути.

Параметры

строка $path

Куда поместить файл.

строка $contents

Содержимое файла.

Возвращает

boolean
Успех

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::createFile

dispatchShell()source public

dispatchShell( )

Перенаправить команду другой оболочке. Аналогично Object::requestAction(), но предназначено для запуска оболочек из других оболочек.

Использование:

С командной строкой:

return $this->dispatchShell('schema create DbAcl');

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

С массивом команд:

return $this->dispatchShell('schema', 'create', 'i18n', '--dry');

Возвращает

смешанный
Результат работы другой оболочки.

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::dispatchShell

err()source public

err( string|array $message null , integer $newlines 1 )

Выводит одно или несколько сообщений об ошибках в stderr. Если параметры не переданы, выводится только символ новой строки.

Параметры

строка|массив $message опционально null

Строка или массив строк для вывода

целое число $newlines опционально 1

Количество символов новой строки для добавления

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::err

error()source public

error( string $title , string $message null )

Отображает отформатированное сообщение об ошибке и завершает приложение с кодом состояния 1.

Параметры

строка $title

Заголовок ошибки

строка $message опционально null

Дополнительное сообщение об ошибке

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::error

hasMethod()source public

hasMethod( string $name )

Проверяет наличие вызываемого метода с данным именем в этой оболочке.

Параметры

строка $name

Имя метода для проверки.

Возвращает

boolean

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::hasMethod

hasTask()source public

hasTask( string $task )

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

Параметры

строка $task

Имя задачи для проверки.

Возвращает

boolean
Успех

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::hasTask

helper()source public

helper( string $name )

Загрузить указанный помощник оболочки

Параметры

строка $name

Имя класса помощника. Поддерживает синтаксис плагина.

Возвращает

BaseShellHelper
Экземпляр класса помощника

Выбрасывает

RuntimeException
Если указано недопустимое имя класса

hr()source public

hr( integer $newlines 0 , integer $width 63 )

Выводит серию символов «минус» в стандартный вывод, служит визуальным разделителем.

Параметры

целое число $newlines необязательно 0

Количество новых строк для добавления до и после

целое число $width необязательно 63

Ширина линии, по умолчанию 63

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::hr

in()source public

in( string $prompt , string|array $options null , string $default null )

Запрашивает у пользователя ввод и возвращает его.

Параметры

строка $prompt

Текст запроса.

строка|массив $options необязательно null

Массив или строка вариантов.

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

Значение ввода по умолчанию.

Возвращает

смешанный тип
Либо значение по умолчанию, либо введенное пользователем значение.

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::in

loadModel()source public

loadModel( string $modelClass null , mixed $id null )

Загружает и инициализирует модели, необходимые для этой оболочки.

Параметры

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

Имя модели для загрузки

смешанный тип $id необязательно null

Изначальный идентификатор, которым должна обладать инициализированная модель

Возвращает

смешанный тип
true, когда найдена и создана одна модель, в противном случае возвращается ошибка.

Выбрасывает

MissingModelException
если класс модели не найден.

loadTasks()source public

loadTasks( )

Загружает задачи, определенные в public $tasks

Возвращает

булево значение

nl()source public

nl( integer $multiplier 1 )

Возвращает последовательность одной или нескольких новой строки.

Параметры

целое число $multiplier необязательно 1

Количество раз, которое последовательность новой строки должна повторяться

Возвращает

строка

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::nl

out()source public

out( string|array $message null , integer $newlines 1 , integer $level Shell::NORMAL )

Выводит одно или несколько сообщений в stdout. Если параметры не переданы, выводится только новая строка.

Уровни вывода

Существует 3 встроенных уровня вывода. Shell::QUIET, Shell::NORMAL, Shell::VERBOSE. Уровни вывода verbose и quiet соответствуют переключателям вывода verbose и quiet в большинстве оболочек. Использование Shell::QUIET для сообщения означает, что оно всегда будет отображаться. Использование Shell::VERBOSE означает, что оно будет отображаться только при включенном режиме подробного вывода.

Параметры

строка|массив $message необязательно null

Строка или массив строк для вывода

целое число $newlines необязательно 1

Количество новых строк для добавления

целое число $level необязательно Shell::NORMAL

Уровень вывода сообщения, см. выше.

Возвращает

целое число|булево значение
Возвращает количество байтов, возвращенных при записи в stdout.

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::out

overwrite()source public

overwrite( array|string $message , integer $newlines 1 , integer $size null )

Перезапись уже выведенного текста.

Полезно для создания прогресс-баров или когда вы хотите заменить текст, уже выведенный на экран, новым текстом.

Предупреждение Вы не можете перезаписывать текст, содержащий новые строки.

Параметры

массив|строка $message

Сообщение для вывода.

целое число $newlines необязательно 1

Количество новых строк для добавления.

целое число $size необязательно null

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

Возвращает

целое число|булево значение
Возвращает количество байтов, возвращенных при записи в stdout.

param()source public

param( string $name )

Безопасный доступ к значениям в $this->params.

Параметры

строка $name

Имя параметра для получения.

Возвращает

строка|булево значение|null
Значение. Возвращает null, если значение не существует.

runCommand()source public

runCommand( string $command , array $argv )

Выполняет оболочку с предоставленным argv.

Делегирует вызовы задачам и разрешает методы внутри класса. Команды ищутся в следующем порядке:

• Метод в оболочке.
• Соответствующее имя задачи.
• main() метод.

Если оболочка реализует метод main(), все отсутствующие вызовы методов будут отправлены в main() с оригинальным именем метода в argv.

Параметры

строка $command

Имя команды для запуска в этой оболочке. Если этот аргумент пустой, а оболочка имеет метод main(), этот метод будет вызван вместо этого.

массив $argv

Массив аргументов для запуска оболочки. Этот массив должен быть без имени оболочки.

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::runCommand

shortPath()source public

shortPath( string $file )

Делает абсолютный путь к файлу более читаемым

Параметры

строка $file

Абсолютный путь к файлу

Возвращает

строка
Короткий путь

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::shortPath

startup()source public

startup( )

Запускает оболочку и отображает приветственное сообщение. Позволяет проверять и настраивать перед выполнением команды или основного выполнения.

Переопределите этот метод, если вы хотите удалить приветственную информацию или иным образом изменить предварительный поток команды.

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::startup

wrapText()source public

wrapText( string $text , string|integer|array $options array() )

Обернуть блок текста. Позволяет задать ширину и отступы в блоке текста.

Опции

• width Ширина обертки. По умолчанию 72
• wordWrap Обрезка только по словам (пробелы). По умолчанию true.
• indent Отступ текста с помощью предоставленной строки. По умолчанию null.

Параметры

строка $text

Текст для форматирования.

строка|целое число|массив $options необязательно массив()

Массив опций для использования или целое число для обертки текста.

Возвращает

строка
Отформатированный/отступленный текст

См. также

CakeText::wrap()

Ссылка

http://book.cakephp.org/2.0/ru/console-and-shells.html#Shell::wrapText

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойства объекта $property со свойствами в определении $class. Значение свойства этого класса будет объединено поверх значений $class.

Это обеспечивает часть «магии» DRY, предоставляемой CakePHP. Если вы хотите отключить эту функцию, переопределите этот метод как пустую функцию.

Параметры

массив $properties

Имя свойств для объединения.

строка $class

Класс для объединения свойства с.

булево $normalize необязательно true

Установите в значение true, чтобы выполнить свойства через Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

Разрешает установку нескольких свойств объекта в одной строке кода. Будет устанавливать только свойства, которые являются частью объявления класса.

Параметры

массив $properties необязательно array()

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stop()source protected

_stop( integer|string $status 0 )

Останавливает выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.

Параметры

целое число/строка $status необязательно 0

см. http://php.net/exit для значений

dispatchMethod()source public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет ОО оболочку для call_user_func_array

Параметры

строка $method

Имя вызываемого метода

массив $params необязательно array()

Список параметров для использования при вызове $method

Возвращает

mixed
Возвращает результат вызова метода

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. Подробнее о записи в журналы см. в CakeLog::write().

Параметры

строка $msg

Сообщение журнала

целое число $type необязательно LOG_ERR

Постоянная типа ошибки. Определена в app/Config/core.php.

null|строка|массив $scope необязательно null

Область(и), в которой создается сообщение журнала. Подробнее о областях ведения журнала см. в CakeLog::config().

Возвращает

boolean
Успешность записи в журнал

requestAction()source public

requestAction( string|array $url , array $extra array() )

Вызывает метод контроллера из любого места. Может использоваться для подключения контроллеров друг к другу или связи плагинов с основным приложением. requestAction может использоваться для возврата рендеренных представлений или получения возвращаемого значения из действий контроллеров.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строку URL. Вы должны использовать форматы URL, совместимые с Router::reverse().

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

строка/массив $url

Строка или массив-URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

массив $extra необязательно array()

Если массив включает ключ "return", он устанавливает AutoRender в значение true. Также может использоваться для отправки данных GET/POST и именованных/переданных аргументов.

Возвращает

mixed

Булево значение true или false при успехе/неудачи, или содержимое рендеренного действия, если в $extra установлен ключ 'return'.

toString()source public

toString( )

Преобразование объекта в строку. Каждый класс может переопределить этот метод по необходимости.

Возвращает

строка
Имя этого класса