Класс UpgradeShell

_filesRegexpUpdateисходный код защищенное

_filesRegexpUpdate( array $patterns )

Обновляет файлы на основе регулярных выражений.

Параметры

массив $patterns

Массив шаблонов поиска и замены.

_findFilesисходный код защищенное

_findFiles( string $extensions '' )

Ищет пути и находит файлы по расширению.

Параметры

строка $extensions необязательно ''

Расширения для включения. По умолчанию — не задано.

_moveAppClassesисходный код защищенное

_moveAppClasses( )

Перемещает классы AppController и AppModel.

_movePhpFilesисходный код защищенное

_movePhpFiles( string $path , array $options )

Перемещает файлы php приложения в необходимое местоположение.

Находит все php-файлы в папке (с учетом рекурсии) и определяет, где CakePHP ожидает найти файл. Если файл не находится там, где его ожидает CakePHP, переместить его.

Параметры

строка $path

Путь для перемещения файлов.

массив $options

массив(рекурсивно, проверка папки)

_moveViewFilesисходный код защищенное

_moveViewFiles( )

Перемещает файлы представлений приложения в необходимое местоположение.

Находит все файлы представлений в папке и определяет, где CakePHP ожидает найти файл.

_updateFileисходный код защищенное

_updateFile( string $file , array $patterns )

Обновляет один файл.

Параметры

строка $file

Файл для обновления

массив $patterns

Шаблоны замены для выполнения.

allисходный код общедоступное

all( )

Выполняет все шаги обновления по одному.

basicsисходный код общедоступное

basics( )

Обновление удалённых базовых функций.

• a() -> array()
• e(*) -> echo *
• ife(, *, *) -> !empty() ? * : *
• a() -> array()
• r(, *, *) -> str_replace(, *, *)
• up() -> strtoupper()
• low(, *, *) -> strtolower()
• getMicrotime() -> microtime(true)

componentsисходный код общедоступное

components( )

Обновить компоненты.

• Сделать компоненты, которые расширяют Object, чтобы они расширяли Component.

configureисходный код общедоступное

configure( )

Обновление вызовов Configure::read() без параметров.

constantsисходный код общедоступное

constants( )

Константы

controller_redirectsисходный код общедоступное

controller_redirects( )

Обновить перенаправления контроллеров.

• Сделать, чтобы инструкции redirect возвращались раньше.

exceptionsисходный код общедоступное

exceptions( )

Заменить cakeError встроенными исключениями. ПРИМЕЧАНИЕ: этот код игнорирует вызовы, где вы передали свои собственные вторичные параметры в cakeError().

getOptionParserисходный код общедоступное

getOptionParser( )

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

Возвращает

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

helpersисходный код общедоступное

helpers( )

Обновить помощники.

• Преобразует использование помощников в новый формат.

i18nисходный код общедоступное

i18n( )

Обновить i18n.

• Удаляет дополнительный параметр true.
• Добавляет echo к вызовам __*(), которые раньше его не имели.

locationsисходный код общедоступное

locations( )

Перемещает файлы и папки в новые места.

Перемещает папки, содержащие файлы, которые не могут быть автоматически обнаружены (libs и templates), а затем ищет все php-файлы, кроме vendors, и перемещает их туда, где Cake 2.0 ожидает их найти.

requestисходный код общедоступное

request( )

Обновляет свойства, перемещённые в CakeRequest.

startupисходный код общедоступное

startup( )

Запуск оболочки, выводит сообщение об информационном режиме.

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

Shell::startup()

testsисходный код общедоступное

tests( )

Обновить тесты.

• Обновить имена классов тестов на FooTest вместо FooTestCase.

__constructисходный код общедоступное

__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/ru/console-and-shells.html#Shell

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

Object::__construct()

__getисходный код общедоступное

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

__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. Если вы не хотите видеть всё, что регистрируется через CakeLog, в stdout или stderr, вызовите эту функцию с первым параметром 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( )

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

Ссылка

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

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

Возвращает

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

Выполняет оболочку с предоставленным 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

wrapTextsource public

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

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

Параметры

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

Параметры

string $text

Текст, подлежащий форматированию.

string|integer|array $options optional 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 optional true

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

_setsource protected

_set( array $properties array() )

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

Параметры

array $properties optional array()

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

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

integer|string $status optional 0

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

dispatchMethodsource public

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

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

Параметры

string $method

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

array $params optional array()

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

Возвращает

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

logsource public

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

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

Параметры

string $msg

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

integer $type optional LOG_ERR

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

null|string|array $scope optional 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 optional array()

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

Возвращает

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

toStringsource public

toString( )

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

Возвращает

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

array()

array(
    'Controller' => 'Controller',
    'Component' => 'Controller/Component',
    'Model' => 'Model',
    'Behavior' => 'Model/Behavior',
    'Datasource' => 'Model/Datasource',
    'Dbo' => 'Model/Datasource/Database',
    'View' => 'View',
    'Helper' => 'View/Helper',
    'Shell' => 'Console/Command',
    'Task' => 'Console/Command/Task',
    'Case' => 'Test/Case',
    'Fixture' => 'Test/Fixture',
    'Error' => 'Lib/Error',
)

array()

array()

array()

true

null

null

array()

null

array()

array()

array()