Класс ProjectTask

_replaceCorePathsource protected

_replaceCorePath( string $filename , boolean $hardCode )

Заменяет плацехолдер __CAKE_PATH__ в шаблонах файлов.

Параметры

строка $filename

Имя файла для обработки.

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

Нужно ли раскомментировать определение.

Возвращает

boolean
Успех

bakesource public

bake( string $path , string $skel null , string $skip array('empty') )

Ищет шаблон скелета приложения Cake, и если не находит, запрашивает путь у пользователя. При наличии пути этот метод создаст глубокую копию скелета в директорию проекта.

Параметры

строка $path

Путь к проекту

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

Путь для копирования

строка $skip необязательно array('empty')

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

Возвращает

mixed
смешанное значение

cachePrefixsource public

cachePrefix( string $dir )

Записывает префикс кэша, используя имя приложения

Параметры

строка $dir

Путь к проекту

Возвращает

boolean
Успех

cakeAdminsource public

cakeAdmin( string $name )

Включает Configure::read('Routing.prefixes') в /app/Config/core.php

Параметры

строка $name

Имя для использования в маршрутизации админа

Возвращает

boolean
Успех

cakeOnIncludePathsource public

cakeOnIncludePath( )

Проверяет include_path PHP на наличие CakePHP.

Возвращает

boolean
Указывает, существует ли CakePHP в include_path

consolePathsource public

consolePath( string $path )

Генерирует правильный путь к библиотекам CakePHP, которые генерируют проект, и указывает app/console/cake.php на правильное место

Параметры

строка $path

Путь к проекту.

Возвращает

boolean
успешно

corePathsource public

corePath( string $path , boolean $hardCode true )

Генерирует и записывает CAKE_CORE_INCLUDE_PATH

Параметры

строка $path

Путь к проекту

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

Нужно ли жестко кодировать вызовы define.

Возвращает

boolean
Успех

executesource public

execute( )

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

Возвращает

mixed
смешанное значение

getOptionParsersource public

getOptionParser( )

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

Возвращает

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

getPrefixsource public

getPrefix( )

Проверяет Configure::read('Routing.prefixes') и заставляет пользователя ввести его, если он не включён

Возвращает

string
Маршрут админа для использования

securityCipherSeedsource public

securityCipherSeed( string $path )

Генерирует и записывает 'Security.cipherSeed'

Параметры

строка $path

Путь к проекту

Возвращает

boolean
Успех

securitySaltsource public

securitySalt( string $path )

Генерирует и записывает 'Security.salt'

Параметры

строка $path

Путь к проекту

Возвращает

boolean
Успех

__constructsource public

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

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

Параметры

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

Объект ConsoleOutput для вывода.

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

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

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

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

Ссылка

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

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

Object::__construct()

__getsource public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

Shell
Объект Task

__issetsource public

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTestsource protected

_checkUnitTest( )

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

Возвращает

boolean
Успех

_controllerNamesource protected

_controllerName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_controllerPathsource protected

_controllerPath( string $name )

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

Параметры

строка $name

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

Возвращает

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

_displayHelpsource protected

_displayHelp( string $command )

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

Параметры

строка $command

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

_getInputsource protected

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

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

Параметры

строка $prompt

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

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

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

строка $default

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

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

Either
значение по умолчанию или входные данные, введенные пользователем.

_loadModelssource protected

_loadModels( )

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

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

boolean
bool

_modelKeysource protected

_modelKey( string $name )

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

Параметры

строка $name

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

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

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

_modelNamesource protected

_modelName( string $name )

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

Параметры

строка $name

Имя

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

string
Имя модели с верблюжьим случаем (единственное число)

_modelNameFromKeysource protected

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

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

string
Имя модели

_pluginPathsource protected

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

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

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

_pluralHumanNamesource protected

_pluralHumanName( string $name )

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

Параметры

строка $name

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

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

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

_pluralNamesource protected

_pluralName( string $name )

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

Параметры

строка $name

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

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

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

_singularHumanNamesource protected

_singularHumanName( string $name )

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

Параметры

строка $name

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

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

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

_singularNamesource protected

_singularName( string $name )

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

Параметры

строка $name

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

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

string
Имя

_useLoggersource protected

_useLogger( boolean $enable true )

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

Параметры

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

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

_welcomesource protected

_welcome( )

Отображает заголовок для командной оболочки

clearsource public

clear( )

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

Ссылка

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

createFilesource public

createFile( string $path , string $contents )

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

Параметры

строка $path

Куда сохранить файл.

строка $contents

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

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

boolean
Успех

Ссылка

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

dispatchShellsource public

dispatchShell( )

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

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

С текстовой командой:

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

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

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

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

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

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

Ссылка

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

errsource 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

errorsource public

error( string $title , string $message null )

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

Параметры

строка $title

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

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

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

Ссылка

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

hasMethodsource public

hasMethod( string $name )

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

Параметры

строка $name

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

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

boolean
bool

Ссылка

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

hasTasksource public

hasTask( string $task )

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

Параметры

строка $task

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

Возвращает

boolean
Успех

Ссылка

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

hrsource 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

insource public

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

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

Параметры

строка $prompt

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

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

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

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

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

Возвращает

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

Ссылка

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

initializesource public

initialize( )

Инициализирует Shell, выступает как конструктор для подклассов, позволяет настроить задачи до выполнения шелла.

Ссылка

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

loadModelsource public

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

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

Параметры

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

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

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

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

Возвращает

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

Выбрасывает

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

loadTaskssource public

loadTasks( )

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

Возвращает

boolean
bool

nlsource public

nl( integer $multiplier 1 )

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

Параметры

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

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

Возвращает

string
строка

Ссылка

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

outsource 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 означает, что оно будет отображаться только при включённом подробном выводе.

Параметры

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

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

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

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

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

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

Возвращает

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

Ссылка

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

overwritesource public

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

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

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

paramsource public

param( string $name )

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

Параметры

строка $name

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

Возвращает

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

runCommandsource public

runCommand( string $command , array $argv )

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

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

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

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

Параметры

строка $command

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

массив $argv

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

Ссылка

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

shortPathsource public

shortPath( string $file )

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

Параметры

строка $file

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

Возвращает

string
сокращённый путь

Ссылка

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

startupsource public

startup( )

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

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

Ссылка

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

wrapTextsource 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

_mergeVarssource protected

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

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

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

Параметры

array $properties

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

string $class

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

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

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

_setsource protected

_set( array $properties array() )

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

Параметры

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

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

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethodsource public

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

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

Параметры

string $method

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

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

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

Возвращает

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

logsource 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
Успех записи в журнал

requestActionsource 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 об успехе/неудачи, или содержимое рендерного действия, если в $extra установлен ключ 'return'.

toStringsource public

toString( )

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

Возвращает

string
Название этого класса

null

array()

array()

true

null

null

array()

null

array()

array()

array()