Класс AssetsTask

_copyDirectorysource protected

_copyDirectory( string $source , string $destination )

Копирование каталога

Параметры

string $source

Исходный каталог

string $destination

Каталог назначения

Возвращает

boolean
bool

_createDirectorysource protected

_createDirectory( string $dir )

Создание каталога

Параметры

string $dir

Имя каталога

Возвращает

boolean
bool

_createSymlinksource protected

_createSymlink( string $target , string $link )

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

Параметры

string $target

Каталог назначения

string $link

Имя ссылки

Возвращает

boolean
bool

_listsource protected

_list( string|string $name null )

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

Параметры

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

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

Возвращает

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

_processsource protected

_process( array $plugins , boolean $copy false )

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

Параметры

array $plugins

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

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

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

copysource public

copy( string|null $name null )

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

Параметры

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

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

getOptionParsersource public

getOptionParser( )

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

Возвращает

Cake\Console\ConsoleOptionParser
\Cake\Console\ConsoleOptionParser

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

Cake\Console\Shell::getOptionParser()

symlinksource public

symlink( string|null $name null )

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

Параметры

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

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

__constructsource public

__construct( Cake\Console\ConsoleIo $io null )

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

Параметры

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

Экземпляр io.

Ссылка

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

__debugInfosource public

__debugInfo( )

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

Возвращает

array
array

__getsource public

__get( string $name )

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

Параметры

string $name

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

Возвращает

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

_displayHelpsource protected

_displayHelp( string $command )

Выводит справку в правильном формате

Параметры

string $command

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

Возвращает

integer|boolean
int|bool

_setOutputLevelsource protected

_setOutputLevel( )

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

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

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

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

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

_welcomesource protected

_welcome( )

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

clearsource public

clear( )

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

Ссылка

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

createFilesource public

createFile( string $path , string $contents )

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

Параметры

string $path

Место размещения файла.

string $contents

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

Возвращает

boolean
Успех

Ссылка

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

dispatchShellsource public

dispatchShell( )

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

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

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

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

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

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

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

errsource public

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

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

Параметры

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

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

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

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

errorsource public

error( string $title , string|null $message null )

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

Параметры

строка $title

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

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

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

Возвращает

integer
Код ошибки

Ссылка

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

hasMethodsource public

hasMethod( string $name )

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

Параметры

строка $name

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

Возвращает

boolean
bool

Ссылка

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

hasTasksource public

hasTask( string $task )

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

Параметры

строка $task

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

Возвращает

boolean
Успех

Ссылка

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

helpersource public

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

Отображает Console Helper

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

Параметры

строка $name

Имя helper для отображения

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

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

Возвращает

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

hrsource 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

insource 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

initializesource public

initialize( )

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

Ссылка

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

iosource public

io( Cake\Console\ConsoleIo $io null )

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

Параметры

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

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

Возвращает

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

loadTaskssource public

loadTasks( )

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

Возвращает

boolean
bool

nlsource public

nl( integer $multiplier 1 )

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

Параметры

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

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

Возвращает

string
строка

Ссылка

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

Ссылка

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

paramsource public

param( string $name )

Безопасно получить значения из $this->params.

Параметры

строка $name

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

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

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

parseDispatchArgumentssource public

parseDispatchArguments( array $args )

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

Параметры

массив $args

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

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

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

quietsource public

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

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

Параметры

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

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

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

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

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

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

runCommandsource public

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

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

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

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

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

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

Параметры

массив $argv

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

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

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

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

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

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

mixed
смешанный тип

Ссылка

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

shortPathsource public

shortPath( string $file )

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

Параметры

строка $file

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

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

string
короткое имя пути

Ссылка

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

startupsource public

startup( )

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

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

Ссылка

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

verbosesource public

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

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

Параметры

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

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

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

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

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

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

wrapTextsource public

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

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

Параметры

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

Параметры

строка $text

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

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

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

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

string
Отформатированный/отступленный текст

См. также

Cake\Utility\Text::wrap()

Ссылка

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

tableLocatorsource public

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

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

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator необязательно null

Экземпляр LocatorInterface.

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

Cake\ORM\Locator\LocatorInterface
\Cake\ORM\Locator\LocatorInterface

logsource public

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

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

Параметры

смешанный тип $msg

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

целое число или строка $level необязательно LogLevel::ERROR

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

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

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

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

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

_mergePropertysource protected

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

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

Параметры

строка $property

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

массив $parentClasses

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

массив $options

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

_mergePropertyDatasource protected

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

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

Параметры

массив $current

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

массив $parent

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

булево $isAssoc

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

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

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

_mergeVarssource protected

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

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

Параметры:

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

Параметры

массив $properties

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

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

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

_setModelClasssource protected

_setModelClass( string $name )

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

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

Параметры

строка $name

Имя класса.

loadModelsource public

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

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

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

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

Параметры

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

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

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

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

Возвращает

object
Созданный экземпляр модели.

Выбрасывает

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

modelFactorysource public

modelFactory( string $type , callable $factory )

Зарегистрировать вызываемый объект для создания репозиториев заданного типа.

Параметры

строка $type

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

вызываемый объект $factory

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

modelTypesource public

modelType( string|null $modelType null )

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

Параметры

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

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

Возвращает

string|$this
$this

[]

[]

true

null

[]

null

[]

[]

[]

'Table'