Класс AssetsTask

_copyDirectory()source protected

_copyDirectory( string $source , string $destination )

Копирование директории

Параметры

строка $source

Исходная директория

строка $destination

Директория назначения

Возвращает

boolean

_createDirectory()source protected

_createDirectory( string $dir )

Создание директории

Параметры

строка $dir

Имя директории

Возвращает

boolean

_createSymlink()source protected

_createSymlink( string $target , string $link )

Создание символической ссылки

Параметры

строка $target

Директория назначения

строка $link

Имя ссылки

Возвращает

boolean

_list()source protected

_list( string|null $name null )

Получение списка плагинов для обработки. Плагины без директории webroot пропускаются.

Параметры

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

Имя плагина, для которого следует создать символическую ссылку на ресурсы. Если null, будут обработаны все плагины.

Возвращает

массив
Список плагинов с метаданными.

_process()source protected

_process( array $plugins , boolean $copy false )

Обработка плагинов

Параметры

массив $plugins

Список плагинов для обработки

булево $copy необязательно false

Принудительный режим копирования. По умолчанию ложно.

copy()source public

copy( string|null $name null )

Копирование ресурсов плагинов в корень приложения. Для плагинов с именем пространства имен vendor, родительская папка для имени vendor создается при необходимости.

Параметры

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

Имя плагина, для которого следует создать символическую ссылку на ресурсы. Если null, будут обработаны все плагины.

getOptionParser()source public

getOptionParser( )

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

Возвращает

Cake\Console\ConsoleOptionParser

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

Cake\Console\Shell::getOptionParser()

symlink()source public

symlink( string|null $name null )

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

Параметры

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

Имя плагина, для которого следует создать символическую ссылку на ресурсы. Если null, будут обработаны все плагины.

__construct()source public

__construct( Cake\Console\ConsoleIo $io null )

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

Параметры

Cake\Console\ConsoleIo $io необязательно null

Экземпляр io.

Ссылка

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

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

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

Параметры

строка $name

Задача, которую нужно получить.

Возвращает

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

_displayHelp()source protected

_displayHelp( string $command )

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

Параметры

строка $command

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

Возвращает

целое число|булево

_setOutputLevel()source protected

_setOutputLevel( )

Устанавливает уровень вывода на основе параметров.

Это переконфигурирует уровень вывода для out() и настроенное протоколирование stdout/stderr

_stop()source protected

_stop( integer|string $status 0 )

Остановка выполнения текущего скрипта. Вызывает исключение StopException, чтобы попытаться остановить выполнение.

Параметры

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

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

Исключения

Cake\Console\Exception\StopException

_welcome()source protected

_welcome( )

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

abort()source public

abort( string $message , integer $exitCode self::CODE_ERROR )

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

Параметры

строка $message

Сообщение об ошибке

целое число $exitCode необязательно self::CODE_ERROR

Код завершения задачи оболочки.

Исключения

Cake\Console\Exception\StopException

Ссылка

http://book.cakephp.org/3.0/ru/console-and-shells.html#styling-output

clear()source public

clear( )

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

Ссылка

http://book.cakephp.org/3.0/ru/console-and-shells.html#console-output

createFile()source public

createFile( string $path , string $contents )

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

Параметры

строка $path

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

строка $contents

Содержание, которое нужно поместить в файл.

Возвращает

boolean
Успех

Ссылка

http://book.cakephp.org/3.0/ru/console-and-shells.html#creating-files

dispatchShell()source public

dispatchShell( )

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

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

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

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

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

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

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

С массивом, содержащим две пары ключ/значение: - command может принимать строку или массив. Представляет команду для диспетчеризации - extra может принимать массив дополнительных параметров для передачи диспетчеру. Эти параметры будут доступны в свойстве param вызываемой Shell

return $this->dispatchShell([ 'command' => 'schema create DbAcl', 'extra' => ['param' => 'value'] ]);

или

return $this->dispatchShell([ 'command' => ['schema', 'create', 'DbAcl'], 'extra' => ['param' => 'value'] ]);

Возвращает

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

Ссылка

http://book.cakephp.org/3.0/ru/console-and-shells.html#invoking-other-shells-from-your-shell

err()source public

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

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

Параметры

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

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

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

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

error()source public

error( string $title , string|null $message null , integer $exitCode self::CODE_ERROR )

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

Устарело

С версии 3.2.0. Используйте Shell::abort() вместо этого.

Параметры

строка $title

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

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

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

целое число $exitCode необязательно self::CODE_ERROR

Код завершения задачи оболочки.

Возвращает

целое число
Код ошибки

Исключения

Cake\Console\Exception\StopException

Ссылка

http://book.cakephp.org/3.0/ru/console-and-shells.html#styling-output

hasMethod()source public

hasMethod( string $name )

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

Параметры

строка $name

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

Возвращает

boolean

Ссылка

http://book.cakephp.org/3.0/ru/console-and-shells.html#shell-tasks

hasTask()source public

hasTask( string $task )

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

Параметры

строка $task

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

Возвращает

boolean
Успех

Ссылка

http://book.cakephp.org/3.0/ru/console-and-shells.html#shell-tasks

helper()source public

helper( string $name , array $settings [] )

Отображение помощника консоли

Создание и отображение вывода для объекта помощника. Если объект помощника еще не загружен, он будет загружен и создан.

Параметры

строка $name

Имя помощника для отображения

массив $settings необязательно []

Данные конфигурации для помощника.

Возвращает

Cake\Console\Helper
Созданный экземпляр помощника.

hr()source public

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

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

Параметры

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

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

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

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

Ссылка

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

in()source public

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

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

Параметры

строка $prompt

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

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

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

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

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

Возвращает

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

Ссылка

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

info()source public

info( string|array|null $message null , integer $newlines 1 , integer $level Cake\Shell\Task\Shell::NORMAL )

Удобный метод для out(), который оборачивает сообщение тегами

Параметры

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

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

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

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

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

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

Возвращает

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

См. также

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

initialize()source public

initialize( )

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

Ссылка

http://book.cakephp.org/3.0/ru/console-and-shells.html#Cake\Console\ConsoleOptionParser::initialize

io()source public

io( Cake\Console\ConsoleIo $io null )

Получение/установка объекта io для этого командного интерфейса.

Параметры

Cake\Console\ConsoleIo $io необязательно null

Объект ConsoleIo для использования.

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

Cake\Console\ConsoleIo
Текущий объект ConsoleIo.

loadTasks()source public

loadTasks( )

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

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

boolean

nl()source public

nl( integer $multiplier 1 )

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

Параметры

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

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

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

строка

Ссылка

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

out()source public

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

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

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

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

Параметры

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

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

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

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

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

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

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

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

Ссылка

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

param()source public

param( string $name )

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

Параметры

строка $name

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

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

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

parseDispatchArguments()source public

parseDispatchArguments( array $args )

Парсит аргументы для метода dispatchShell().

Параметры

массив $args

Аргументы, полученные из метода dispatchShell() с помощью func_get_args()

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

массив

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

quiet()source public

quiet( string|array $message , integer $newlines 1 )

Вывод на всех уровнях.

Параметры

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

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

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

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

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

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

runCommand()source public

runCommand( array $argv , boolean $autoMethod false , array $extra [] )

Выполняет командный интерфейс с предоставленными argv.

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

• Метод в командном интерфейсе.
• Соответствующее имя задачи.
• main() метод.

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

Для вызова задач они должны быть представлены в виде подкоманд. Если вы определяете подкоманды, вы должны определить все необходимые подкоманды командного интерфейса, независимо от того, являются ли они методами этого класса или методами задач.

Параметры

массив $argv

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

boolean $autoMethod необязательно false

Установите в значение true, чтобы разрешить вызов любого публичного метода, даже если он не был определён как подкоманда. Это используется ShellDispatcher для упрощения создания простых командных интерфейсов.

массив $extra необязательно []

Дополнительные параметры, которые можно вручную передать командному интерфейсу для обработки. Встроенный дополнительный параметр - : - requested : если используется, предотвратит отображение приветственного сообщения командного интерфейса

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

смешанный

Ссылка

http://book.cakephp.org/3.0/ru/console-and-shells.html#the-cakephp-console

shortPath()source public

shortPath( string $file )

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

Параметры

строка $file

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

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

строка
короткое имя пути

Ссылка

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

startup()source public

startup( )

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

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

Ссылка

http://book.cakephp.org/3.0/ru/console-and-shells.html#Cake\Console\ConsoleOptionParser::startup

success()source public

success( string|array|null $message null , integer $newlines 1 , integer $level Cake\Shell\Task\Shell::NORMAL )

Удобный метод для out(), который оборачивает сообщение тегом

Параметры

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

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

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

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

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

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

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

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

См. также

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

verbose()source public

verbose( string|array $message , integer $newlines 1 )

Вывод на уровне verbose.

Параметры

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

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

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

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

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

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

warn()source public

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

Удобный метод для err(), который оборачивает сообщение тегом

Параметры

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

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

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

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

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

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

См. также

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

wrapText()source public

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

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

Параметры

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

Параметры

string $text

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

integer|array $options optional []

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

Возвращает

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

См. также

\Cake\Utility\Text::wrap()

Ссылка

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

tableLocator()source public

tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator null )

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

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator optional null

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

log()source public

log( mixed $msg , integer|string $level LogLevel::ERROR , string|array $context [] )

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

Параметры

mixed $msg

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

integer|string $level optional LogLevel::ERROR

Уровень ошибки.

string|array $context optional []

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

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

_mergeProperty()source protected

_mergeProperty( string $property , array $parentClasses , array $options )

Объединение одного свойства со значениями, объявленными во всех родительских классах.

Параметры

string $property

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

array $parentClasses

Массив классов, которые нужно объединить.

array $options

Параметры для объединения свойства, см. _mergeVars()

_mergePropertyData()source protected

_mergePropertyData( array $current , array $parent , boolean $isAssoc )

Объединяет каждый из ключей в свойстве.

Параметры

array $current

Текущее объединённое значение.

array $parent

Значение родительского класса.

boolean $isAssoc

Флаг, определяющий, будет ли объединение происходить в ассоциативном режиме.

Возвращает

mixed
Обновленное значение.

_mergeVars()source protected

_mergeVars( array $properties , array $options [] )

Объединяет список $properties со всеми родительскими классами текущего класса.

Параметры:

• associative - Список свойств, которые должны обрабатываться как ассоциативные массивы. Свойства в этом списке будут переданы через Hash::normalize() перед объединением.

Параметры

array $properties

Массив свойств и стратегия их объединения.

array $options optional []

Параметры, используемые при объединении свойств.

_setModelClass()source protected

_setModelClass( string $name )

Устанавливает свойства modelClass и modelKey на основе соглашений.

Если свойства уже установлены, они не будут перезаписаны.

Параметры

string $name

Имя класса.

loadModel()source public

loadModel( string|null $modelClass null , string|null $modelType null )

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

Обычно используется для загрузки объектов таблиц ORM по мере необходимости. Также может использоваться для загрузки других типов объектов хранилища, используемых приложением.

Если поставщик хранилища не возвращает объект, будет выброшено исключение MissingModelException.

Параметры

string|null $modelClass optional null

Имя класса модели для загрузки. По умолчанию $this->modelClass

string|null $modelType optional null

Тип хранилища для загрузки. По умолчанию значение modelType().

Возвращает

Cake\Datasource\RepositoryInterface
Созданный экземпляр модели.

Исключения

Cake\Datasource\Exception\MissingModelException
Если класс модели не найден.
InvalidArgumentException
При использовании типа, который не зарегистрирован.
UnexpectedValueException
Если тип модели не определен

modelFactory()source public

modelFactory( string $type , callable $factory )

Регистрирует вызываемый объект для создания хранилищ заданного типа.

Параметры

string $type

Имя типа хранилища, для которого предназначена функция фабрики.

callable $factory

Функция-фабрика, используемая для создания экземпляров.

modelType()source public

modelType( string|null $modelType null )

Установка или получение типа модели, используемого этим классом.

Параметры

string|null $modelType optional null

Тип модели или null для получения текущего

Возвращает

string|Cake\Datasource\ModelAwareTrait
$this