Класс TestsuiteShell

_parseArgs()source protected

_parseArgs( )

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

Возвращает

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

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

TestShell::_parseArgs()

getOptionParser()source public

getOptionParser( )

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

Возвращает

ConsoleOptionParser

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

TestShell::getOptionParser()

main()source public

main( )

Основная точка входа в этот shell

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

TestShell::main()

_mapFileToCase()source protected

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

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

Параметры

строка $file

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

строка $category

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

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

Бросить ли исключение.

Возвращает

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

Выбрасывает

Exception

_mapFileToCategory()source protected

_mapFileToCategory( string $file )

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

Параметры

строка $file

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

Возвращает

строка

_run()source protected

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

Запускает тестовый случай из $runnerArgs

Параметры

массив $runnerArgs

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

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

список опций, сконструированный _runnerOptions()

_runnerOptions()source protected

_runnerOptions( )

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

Возвращает

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

available()source public

available( )

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

initialize()source public

initialize( )

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

Выбрасывает

Exception

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

Shell::initialize()

__construct()source public

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

Создаёт экземпляр Shell.

Параметры

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

Объект ConsoleOutput для вывода на стандартный вывод.

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

Объект ConsoleOutput для вывода в стандартный поток ошибок.

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

Объект ConsoleInput для стандартного ввода.

Ссылка

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

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

CakeObject::__construct()

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

__isset()source public

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTest()source protected

_checkUnitTest( )

Действие для создания Unit Test

Возвращает

булево
Успех

_configureStdErrLogger()source protected

_configureStdErrLogger( )

Настройка логирования ошибок

_configureStdOutLogger()source protected

_configureStdOutLogger( )

Настройка логирования вывода

_controllerName()source protected

_controllerName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_controllerPath()source protected

_controllerPath( string $name )

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

Параметры

строка $name

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

Возвращает

строка
Путь к контроллеру

_displayHelp()source protected

_displayHelp( string $command )

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

Параметры

строка $command

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

_getInput()source protected

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

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

Параметры

строка $prompt

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

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

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

строка $default

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

Возвращает

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

_loadModels()source protected

_loadModels( )

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

Возвращает

boolean

_loggerIsConfigured()source protected

_loggerIsConfigured( string $logger )

Проверяет, настроен ли данный логгер

Параметры

строка $logger

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

Возвращает

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( )

Перенаправить команду в другую оболочку. Похоже на CakeObject::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 )

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

Параметры

string $name

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

Возвращаемое значение

boolean

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

string $task

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

Возвращаемое значение

boolean
Успех

Ссылка

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

helper()source public

helper( string $name )

Загрузка заданного класса помощника шелла.

Параметры

string $name

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

Возвращаемое значение

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

Исключения

RuntimeException
Если указано неверное имя класса

hr()source public

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

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

Параметры

integer $newlines optional 0

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

integer $width optional 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 )

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

Параметры

string $prompt

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

string|array $options optional null

Массив или строка параметров.

string $default optional null

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

Возвращаемое значение

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

Ссылка

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

loadModel()source public

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

Загружает и создаёт модели, необходимые для этого шелла.

Параметры

string $modelClass optional null

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

mixed $id optional null

Начальный ID, который должен иметь созданный экземпляр класса модели

Возвращаемое значение

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

Исключения

MissingModelException
если модель не может быть найдена.

loadTasks()source public

loadTasks( )

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

Возвращаемое значение

boolean

nl()source public

nl( integer $multiplier 1 )

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

Параметры

integer $multiplier optional 1

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

Возвращаемое значение

string

Ссылка

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 )

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

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

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

Параметры

string|array $message optional null

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

integer $newlines optional 1

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

integer $level optional Shell::NORMAL

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

Возвращаемое значение

integer|boolean
Возвращает количество байтов, возвращенных при записи в стандартный вывод.

Ссылка

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 )

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

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

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

Параметры

array|string $message

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

integer $newlines optional 1

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

integer $size optional null

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

Возвращаемое значение

integer|boolean
Возвращает количество байтов, возвращенных при записи в стандартный вывод.

param()source public

param( string $name )

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

Параметры

string $name

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

Возвращаемое значение

string|boolean|null
Значение. Возвращает null, если параметр не существует.

runCommand()source public

runCommand( string $command , array $argv )

Выполняет Shell с предоставленным argv.

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

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

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

Параметры

string $command

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

array $argv

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

Ссылка

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

shortPath()source public

shortPath( string $file )

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

Параметры

string $file

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

Возвращаемое значение

string
Укороченный путь

Ссылка

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

startup()source public

startup( )

Инициализирует Shell и отображает приветственное сообщение. Позволяет выполнять проверку и конфигурацию перед выполнением команды или основной частью

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

Ссылка

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.

Параметры

string $text

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

string|integer|array $options необязательно array()

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

Возвращает

string
Оборачиваемый/отступаемый текст

См. также

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. Если вы хотите ее отключить, переопределите этот метод как пустую функцию.

Параметры

array $properties

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

string $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

array $properties необязательно array()

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

integer|string $status необязательно 0

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

dispatchMethod()source public

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

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

Параметры

string $method

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

array $params необязательно array()

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

Возвращает

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

log()source public

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

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

Параметры

string $msg

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

integer $type необязательно LOG_ERR

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

null|string|array $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.

Параметры

string|array $url

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

array $extra необязательно array()

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

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