Класс AclShell

_dataVarssource protected

_dataVars( string $type null )

Строит параметры данных на основе типа узла

Параметры

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

Тип узла (ARO/ACO)

Возвращает

array
Переменные

_getNodeIdsource protected

_getNodeId( string $class , string|array|null $identifier )

Получает узел для заданного идентификатора. $identifier может быть строковым псевдонимом или массивом свойств для использования в AcoNode::node()

Параметры

строка $class

Тип класса, который вы хотите (Aro/Aco)

строка|массив|null $identifier

Смешанный идентификатор для поиска узла, в противном случае null.

Возвращает

integer
Целое число NodeId. Вызовет ошибку, если ничего не найдено.

_getParamssource protected

_getParams( )

Получает параметры для стандартных методов ACL

Возвращает

array
aro, aco, action

_outputNodesource protected

_outputNode( string $class , array $node , integer $indent )

Выводит отдельный узел, используя псевдоним или Model.key

Параметры

строка $class

Имя класса, который используется.

массив $node

Массив информации об узле.

целое число $indent

Уровень отступа.

checksource public

check( )

Проверка разрешения для заданного ARO на заданный ACO.

createsource public

create( )

Создает узел ARO/ACO

deletesource public

delete( )

Удаление узла ARO/ACO. Обратите внимание, что (в результате неправильной настройки) может быть несколько записей с одинаковым логическим идентификатором. Все они будут удалены.

denysource public

deny( )

Отказ в доступе для ARO к ACO.

getOptionParsersource public

getOptionParser( )

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

Возвращает

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

getPathsource public

getPath( )

Получение пути к заданному узлу ARO/ACO.

grantsource public

grant( )

Предоставление разрешения для заданного ARO на заданный ACO.

inheritsource public

inherit( )

Устанавливает ARO для наследования разрешений на ACO.

initdbsource public

initdb( )

Инициализация базы данных ACL.

Возвращает

mixed
смешанное

mainsource public

main( )

Переопределите main() для обработки сообщений справки

nodeExistssource public

nodeExists( )

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

Возвращает

boolean
Успех

parseIdentifiersource public

parseIdentifier( string $identifier )

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

Параметры

строка $identifier

Идентификатор для разбора

Возвращает

mixed
строка для псевдонимов и массив для model.foreignKey

setParentsource public

setParent( )

Установка родителя для узла ARO/ACO.

startupsource public

startup( )

Переопределение запуска оболочки

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

Shell::startup()

viewsource public

view( )

Показать конкретный узел ARO/ACO.

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

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

Object::__construct()

__getsource public

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

Параметры

boolean $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

Параметры

string $title

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

string $message optional null

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

Ссылка

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

hasMethodsource public

hasMethod( string $name )

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

Параметры

string $name

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

Возвращает

boolean
bool

Ссылка

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

hasTasksource public

hasTask( string $task )

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

Параметры

string $task

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

Возвращает

boolean
Успех

Ссылка

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

hrsource public

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

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

Параметры

integer $newlines optional 0

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

integer $width optional 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 )

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

Параметры

string $prompt

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

string|array $options optional null

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

string $default optional 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 )

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

Параметры

string $modelClass optional null

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

mixed $id optional null

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

Возвращает

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

Выбрасывает

MissingModelException
если класс модели не найден.

loadTaskssource public

loadTasks( )

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

Возвращает

boolean
bool

nlsource public

nl( integer $multiplier 1 )

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

Параметры

integer $multiplier optional 1

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

Возвращает

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

Параметры

string|array $message optional null

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

integer $newlines optional 1

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

integer $level optional 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 )

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

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

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

Параметры

array|string $message

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

integer $newlines optional 1

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

integer $size optional null

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

Возвращает

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

paramsource public

param( string $name )

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

Параметры

string $name

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

Возвращает

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

runCommandsource public

runCommand( string $command , array $argv )

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

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

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

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

Параметры

string $command

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

array $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.

Параметры

строка $text

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

строка|целое число|массив $options необязательно массив()

Массив с параметрами, или целое число для ширины разбиения.

Возвращает

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. Если вы хотите отключить это, переопределите этот метод как пустую функцию.

Параметры

массив $properties

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

строка $class

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

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

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

_setsource protected

_set( array $properties array() )

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

Параметры

массив $properties необязательно массив()

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

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethodsource public

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

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

Параметры

строка $method

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

массив $params необязательно массив()

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

Возвращает

mixed
Результат вызова метода

logsource public

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

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

Параметры

строка $msg

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

целое число $type необязательно LOG_ERR

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

null|строка|массив $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.

Параметры

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

Строковый или массивный URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

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

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

Возвращает

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

toStringsource public

toString( )

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

Возвращает

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

'default'

array('DbConfig')

array()

true

null

null

array()

null

array()

array()