Класс TestShell

_mapFileToCase()source protected

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

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

Параметры

строка $file

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

строка $category

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

логическое значение $throwOnMissingFile необязательно true

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

Возвращает

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

Исключения

Исключение

_mapFileToCategory()source protected

_mapFileToCategory( string $file )

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

Параметры

строка $file

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

Возвращает

строка

_parseArgs()source protected

_parseArgs( )

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

Возвращает

массив|null
Массив параметров для CakeTestDispatcher или null.

_run()source protected

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

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

Параметры

массив $runnerArgs

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

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

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

_runnerOptions()source protected

_runnerOptions( )

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

Возвращает

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

available()source public

available( )

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

getOptionParser()source public

getOptionParser( )

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

Возвращает

ConsoleOptionParser

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

Shell::getOptionParser()

initialize()source public

initialize( )

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

Исключения

Исключение

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

Shell::initialize()

main()source public

main( )

Точка входа в эту оболочку

__construct()source public

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

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

Параметры

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

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

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

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

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

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

Ссылка

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

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

CakeObject::__construct()

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

Shell
Объект Task

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

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

Параметры

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 )

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

Параметры

string $prompt

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

string|array $options

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

string $default

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

Возвращает

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

_loadModels()source protected

_loadModels( )

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

Возвращает

boolean

_loggerIsConfigured()source protected

_loggerIsConfigured( string $logger )

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

Параметры

string $logger

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

Возвращает

boolean

_modelKey()source protected

_modelKey( string $name )

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

Параметры

string $name

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

Возвращает

string
Единичный ключ модели

_modelName()source protected

_modelName( string $name )

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

Параметры

string $name

Имя

Возвращает

string
Именованное и единственное имя модели

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

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

Параметры

string $key

Внешний ключ

Возвращает

string
Имя модели

_pluginPath()source protected

_pluginPath( string $pluginName )

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

Параметры

string $pluginName

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

Возвращает

string
Путь к плагину.

_pluralHumanName()source protected

_pluralHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_pluralName()source protected

_pluralName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularHumanName()source protected

_singularHumanName( string $name )

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

Параметры

string $name

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

Возвращает

string
Единственное человекочитаемое имя

_singularName()source protected

_singularName( string $name )

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

Параметры

string $name

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

Возвращает

string
Имя

_useLogger()source protected

_useLogger( boolean $enable true )

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

Параметры

boolean $enable optional true

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

_welcome()source protected

_welcome( )

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

clear()source public

clear( )

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

Ссылка

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

createFile()source public

createFile( string $path , string $contents )

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

Параметры

string $path

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

string $contents

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

Возвращает

boolean
Успех

Ссылка

https://book.cakephp.org/2.0/en/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');

Возвращает

mixed
Результат работы другой оболочки.

Ссылка

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

err()source public

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

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

Параметры

string|array $message optional null

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

integer $newlines optional 1

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

Ссылка

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

error()source public

error( string $title , string $message null )

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

Параметры

string $title

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

string $message optional null

Необязательное сообщение об ошибке

Ссылка

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

hasMethod()source public

hasMethod( string $name )

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

Параметры

string $name

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

Возвращает

boolean

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

string $task

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

Возвращает

boolean
Успех

Ссылка

https://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

Ссылка

https://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
Либо значение по умолчанию, либо введенное пользователем.

Ссылка

https://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

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

Возвращает

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

Исключения

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

loadTasks()source public

loadTasks( )

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

Возвращает

boolean

nl()source public

nl( integer $multiplier 1 )

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

Параметры

integer $multiplier optional 1

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

Возвращает

string

Ссылка

https://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
Возвращает количество байт, возвращенных при записи в стандартный вывод.

Ссылка

https://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

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

Ссылка

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

shortPath()source public

shortPath( string $file )

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

Параметры

строка $file

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

Возвращает

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

Ссылка

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

startup()source public

startup( )

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

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

Ссылка

https://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()

Ссылка

https://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 необязательно массив()

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

_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 необязательно массив()

Список параметров для использования при вызове $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 необязательно массив()

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

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

null