Класс 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

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

_remove()source protected

_remove( array $config )

Удаление папки/символической ссылки.

Параметры

массив $config

Настройка плагина.

Возвращает

boolean

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

remove()source public

remove( string|null $name null )

Удаление ресурсов плагинов из веб-корня приложения.

Параметры

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

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

Since

3.5.12

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.

Ссылка

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

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

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

Параметры

строка $name

Задача для получения.

Возвращает

Cake\Console\Shell
Объект Task

_displayHelp()source protected

_displayHelp( string $command )

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

Параметры

строка $command

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

Возвращает

целое число/булево значение
Количество байтов, возвращённых при записи в стандартный вывод.

_setOutputLevel()source protected

_setOutputLevel( )

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

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

_stop()source protected

_stop( integer|string $status self::CODE_SUCCESS )

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

Параметры

целое число/строка $status необязательно self::CODE_SUCCESS

см. https://secure.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

Ссылка

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

clear()source public

clear( )

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

Ссылка

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

createFile()source public

createFile( string $path , string $contents )

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

Параметры

строка $path

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

строка $contents

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

Возвращает

булево значение
Успех

Ссылка

https://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'] ]);

Возвращает

целое число
Код завершения команды cli. 0 - успех.

Ссылка

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

Ссылка

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

getIo()source public

getIo( )

Получить объект io для этой оболочки.

Возвращает

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

hasMethod()source public

hasMethod( string $name )

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

Параметры

строка $name

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

Возвращает

булево значение

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

строка $task

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

Возвращает

булево значение
Успех

Ссылка

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

helper()source public

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

Отобразить Console Helper

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

Параметры

строка $name

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

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

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

Возвращает

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

hr()source public

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

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

Параметры

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

Количество символов новой строки для предварительного и последующего добавления

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

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

Ссылка

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

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

Параметры

string $prompt

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

string|array|null $options необязательно null

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

string|null $default необязательно null

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

Возвращает

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

Ссылка

https://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(), который оборачивает сообщение тегом .

Параметры

string|array|null $message необязательно null

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

integer $newlines необязательно 1

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

integer $level необязательно Cake\Shell\Task\Shell::NORMAL

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

Возвращает

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

См. также

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

initialize()source public

initialize( )

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

Ссылка

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

io()source public

io( Cake\Console\ConsoleIo $io null )

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

Устарело

3.5.0 Используйте getIo()/setIo() вместо этого.

Параметры

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

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

Возвращает

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

loadTasks()source public

loadTasks( )

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

Возвращает

boolean

nl()source public

nl( integer $multiplier 1 )

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

Параметры

integer $multiplier необязательно 1

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

Возвращает

string

Ссылка

https://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 выводе.

Параметры

string|array|null $message необязательно null

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

integer $newlines необязательно 1

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

integer $level необязательно Cake\Shell\Task\Shell::NORMAL

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

Возвращает

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

Ссылка

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

param()source public

param( string $name )

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

Параметры

string $name

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

Возвращает

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

parseDispatchArguments()source public

parseDispatchArguments( array $args )

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

Параметры

array $args

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

Возвращает

array

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

quiet()source public

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

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

Параметры

string|array $message

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

integer $newlines необязательно 1

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

Возвращает

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

runCommand()source public

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

Выполняет оболочку с предоставленными argv.

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

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

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

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

Параметры

array $argv

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

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

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

array $extra необязательно []

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

Возвращает

integer|boolean|null

Ссылка

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

setIo()source public

setIo( Cake\Console\ConsoleIo $io )

Установка объекта io для этой оболочки.

Параметры

Cake\Console\ConsoleIo $io

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

setRootName()source public

setRootName( string $name )

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

Параметры

string $name

Имя корневой команды.

Возвращает

$this

shortPath()source public

shortPath( string $file )

Упрощает чтение абсолютного пути к файлу.

Параметры

string $file

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

Возвращает

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

Ссылка

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

startup()source public

startup( )

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

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

Ссылка

https://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(), который оборачивает сообщение тегами

Параметры

string|array|null $message необязательно null

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

integer $newlines необязательно 1

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

integer $level необязательно Cake\Shell\Task\Shell::NORMAL

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

Возвращает

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

См. также

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

verbose()source public

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

Вывод на уровне подробности.

Параметры

string|array $message

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

integer $newlines необязательно 1

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

Возвращает

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

warn()source public

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

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

Параметры

string|array|null $message необязательно null

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

integer $newlines необязательно 1

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

Возвращает

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

См. также

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

wrapMessageWithType()source protected

wrapMessageWithType( string $messageType , string|array $message )

Оборачивает сообщение заданным типом сообщения, например:

Параметры

string $messageType

Тип сообщения, например, "предупреждение".

string|array $message

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

Возвращает

array|string
Сообщение, обернутое заданным типом сообщения.

wrapText()source public

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

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

Параметры

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

Параметры

string $text

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

integer|array $options необязательно []

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

Возвращает

string
Отображенный/отстуженный текст

См. также

\Cake\Utility\Text::wrap()

Ссылка

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

getTableLocator()source public

getTableLocator( )

Возвращает локатор таблицы.

Возвращает

Cake\ORM\Locator\LocatorInterface

setTableLocator()source public

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

Устанавливает локатор таблицы.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator

Экземпляр LocatorInterface.

Возвращает

$this

tableLocator()source public

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

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

Устарело

3.5.0 Используйте getTableLocator()/setTableLocator() вместо этого.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator необязательно 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 необязательно LogLevel::ERROR

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

string|array $context необязательно []

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

Возвращает

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 необязательно []

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

_setModelClass()source protected

_setModelClass( string $name )

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

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

Параметры

string $name

Имя класса.

getModelType()source public

getModelType( )

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

Возвращает

string

loadModel()source public

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

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

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

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

Параметры

string|null $modelClass необязательный null

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

string|null $modelType необязательный 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 )

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

Устаревшее

3.5.0 Используйте getModelType()/setModelType() вместо этого.

Параметры

string|null $modelType необязательный null

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

Возвращает

string|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

Установить тип модели, который будет использоваться этим классом

Параметры

string $modelType

Тип модели

Возвращает

$this