Spec-Zone.ru › Yii 2.0

Класс yii\console\controllers\FixtureController

Все классы | Свойства | Методы | События | Константы
Наследование yii\console\controllers\FixtureController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable, yii\base\ViewContextInterface
Использует трайты yii\test\FixtureTrait
Подклассы yii\faker\FixtureController
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/console/controllers/FixtureController.php

Управляет загрузкой и выгрузкой данных фикстур.

#load fixtures from UsersFixture class with default namespace "tests\unit\fixtures"
yii fixture/load User

#also a short version of this command (generate action is default)
yii fixture User

#load all fixtures
yii fixture "*"

#load all fixtures except User
yii fixture "*, -User"

#load fixtures with different namespace.
yii fixture/load User --namespace=alias\my\custom\namespace\goes\here

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

Публичные свойства

Свойство Тип Описание Определено в
$action yii\base\Action Действие, которое в данный момент выполняется. yii\base\Controller
$behaviors yii\base\Behavior[] Список прикрепленных к данному компоненту поведений. yii\base\Component
$color boolean Включает ли ANSI цвет в выводе. yii\console\Controller
$defaultAction string Идентификатор действия по умолчанию контроллера. yii\console\controllers\FixtureController
$fixtures yii\test\Fixture[] Загруженные фикстуры для текущего тестового случая. yii\test\FixtureTrait
$globalFixtures array Глобальные фикстуры, которые должны быть применены при загрузке и выгрузке. yii\console\controllers\FixtureController
$help boolean Отображать ли справку о текущей команде. yii\console\Controller
$helpSummary string yii\console\Controller
$id string Идентификатор данного контроллера. yii\base\Controller
$interactive boolean Выполнять команду в интерактивном режиме. yii\console\Controller
$layout null|string|false Имя макета, который следует применять к представлениям этого контроллера. yii\base\Controller
$module yii\base\Module Модуль, к которому принадлежит этот контроллер. yii\base\Controller
$modules yii\base\Module[] Все родительские модули, в которых находится этот контроллер. yii\base\Controller
$namespace string По умолчанию пространство имен для поиска фикстур yii\console\controllers\FixtureController
$passedOptionValues array Свойства, соответствующие переданным опциям. yii\console\Controller
$passedOptions array Имена опций, переданных во время выполнения. yii\console\Controller
$route string Путь (ID модуля, ID контроллера и ID действия) текущего запроса. yii\base\Controller
$uniqueId string Идентификатор контроллера, который префикс с ID модуля (если есть). yii\base\Controller
$view yii\base\View|yii\web\View Объект представления, который может использоваться для рендеринга представлений или файлов представлений. yii\base\Controller
$viewPath string Директория, содержащая файлы представлений для этого контроллера. yii\base\Controller

Публичные методы

Метод Описание Определено в
__call() Вызывает метод с заданным именем, который не является методом класса. yii\base\Object
__clone() Этот метод вызывается после создания объекта путем клонирования существующего. yii\base\Component
__construct() yii\base\Controller
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в значение null. yii\base\Object
actionLoad() Загружает указанные данные фикстуры. yii\console\controllers\FixtureController
actionUnload() Выгружает указанные фикстуры. yii\console\controllers\FixtureController
actions() Объявляет внешние действия для контроллера. yii\base\Controller
afterAction() Этот метод вызывается сразу после выполнения действия. yii\base\Controller
ansiFormat() Форматирует строку с кодами ANSI. yii\console\Controller
attachBehavior() Присоединяет поведение к компоненту. yii\base\Component
attachBehaviors() Присоединяет список поведений к компоненту. yii\base\Component
beforeAction() Этот метод вызывается сразу перед выполнением действия. yii\base\Controller
behaviors() Возвращает список поведений, которые должен использовать этот компонент. yii\base\Component
bindActionParams() Связывает параметры с действием. yii\console\Controller
canGetProperty() Возвращает значение, указывающее, можно ли прочитать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное имя этого класса. yii\base\Object
confirm() Просит пользователя подтвердить, набрав y или n. yii\console\Controller
createAction() Создает действие на основе заданного идентификатора действия. yii\base\Controller
detachBehavior() Отсоединяет поведение от компонента. yii\base\Component
detachBehaviors() Отсоединяет все поведения от компонента. yii\base\Component
ensureBehaviors() Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. yii\base\Component
findLayoutFile() Ищет соответствующий файл макета. yii\base\Controller
fixtures() Объявляет фикстуры, необходимые для текущего тестового случая. yii\test\FixtureTrait
getActionArgsHelp() Возвращает справочную информацию по анонимным аргументам для действия. yii\console\Controller
getActionHelp() Возвращает подробную справочную информацию по указанному действию. yii\console\Controller
getActionHelpSummary() Возвращает краткое описание указанного действия в одной строке. yii\console\Controller
getActionOptionsHelp() Возвращает справочную информацию по параметрам действия. yii\console\Controller
getBehavior() Возвращает объект поведения с заданным именем. yii\base\Component
getBehaviors() Возвращает все поведения, присоединенные к этому компоненту. yii\base\Component
getFixture() Возвращает указанную фикстуру. yii\test\FixtureTrait
getFixtures() Возвращает объекты фикстур, как указано в globalFixtures() и fixtures(). yii\test\FixtureTrait
getHelp() Возвращает справочную информацию для этого контроллера. yii\console\Controller
getHelpSummary() Возвращает краткое описание этого контроллера в одной строке. yii\console\Controller
getModules() Возвращает всех родительских модулей этого контроллера. yii\base\Controller
getOptionValues() Возвращает свойства, соответствующие параметрам для идентификатора действия. Подклассы могут переопределить этот метод для указания возможных свойств. yii\console\Controller
getPassedOptionValues() Возвращает свойства, соответствующие переданным параметрам. yii\console\Controller
getPassedOptions() Возвращает имена допустимых параметров, переданных во время выполнения. yii\console\Controller
getRoute() Возвращает маршрут текущего запроса. yii\base\Controller
getUniqueId() Возвращает уникальный идентификатор контроллера. yii\base\Controller
getView() Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. yii\base\Controller
getViewPath() Возвращает директорию, содержащую файлы представлений для этого контроллера. yii\base\Controller
globalFixtures() Объявляет фикстуры, используемые разными тестовыми случаями. yii\test\FixtureTrait
hasEventHandlers() Возвращает значение, указывающее, есть ли какой-либо обработчик, прикрепленный к указанному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определен ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует объект. yii\base\Object
initFixtures() Инициализирует фикстуры yii\test\FixtureTrait
isColorEnabled() Возвращает значение, указывающее, включен ли ANSI цвет. yii\console\Controller
loadFixtures() Загружает указанные фикстуры. yii\test\FixtureTrait
needToApplyAll() Проверяет, нужно ли применить все фикстуры. yii\console\controllers\FixtureController
notifyNothingToLoad() Уведомляет пользователя, что нет фикстур для загрузки в соответствии с условиями ввода. yii\console\controllers\FixtureController
notifyNothingToUnload() Уведомляет пользователя, что нет фикстур для разгрузки в соответствии с условиями ввода. yii\console\controllers\FixtureController
off() Отсоединяет существующий обработчик событий от этого компонента. yii\base\Component
on() Присоединяет обработчик событий к событию. yii\base\Component
optionAliases() Возвращает псевдонимы параметров. yii\console\controllers\FixtureController
options() Возвращает имена допустимых параметров для действия (id). Параметр требует существования публичной переменной-члена, имя которой — имя параметра. yii\console\controllers\FixtureController
prompt() Запрашивает ввод у пользователя и проверяет его. yii\console\Controller
render() Отображает представление и применяет макет, если он доступен. yii\base\Controller
renderContent() Отображает статическую строку, применяя макет. yii\base\Controller
renderFile() Отображает файл представления. yii\base\Controller
renderPartial() Отображает представление без применения макета. yii\base\Controller
run() Выполняет запрос, указанный в виде маршрута. yii\base\Controller
runAction() Выполняет действие с указанным идентификатором действия и параметрами. yii\console\Controller
select() Предоставляет пользователю возможность выбора из вариантов. Ввод '?' отобразит список вариантов и их описания. yii\console\Controller
setView() Устанавливает объект представления, который будет использоваться этим контроллером. yii\base\Controller
setViewPath() Устанавливает каталог, содержащий файлы представления. yii\base\Controller
stderr() Выводит строку в STDERR yii\console\Controller
stdout() Выводит строку в STDOUT yii\console\Controller
trigger() Вызывает событие. yii\base\Component
unloadFixtures() Разгружает указанные фикстуры. yii\test\FixtureTrait

Protected Methods

Method Description Defined By
createFixtures() Создает указанные экземпляры фикстур. yii\test\FixtureTrait
getActionMethodReflection() yii\console\Controller
parseDocCommentDetail() Возвращает полное описание из блоков документации. yii\console\Controller
parseDocCommentSummary() Возвращает первую строку блока документации. yii\console\Controller
parseDocCommentTags() Парсит блок комментариев на теги. yii\console\Controller

События

Event Type Description Defined By
EVENT_AFTER_ACTION yii\base\ActionEvent Событие, которое срабатывает сразу после выполнения действия контроллера. yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent Событие, которое срабатывает непосредственно перед выполнением действия контроллера. yii\base\Controller

Константы

Константа Значение Описание Определено в
EXIT_CODE_ERROR 1 yii\console\Controller
EXIT_CODE_NORMAL 0 yii\console\Controller

Подробности свойств

$defaultAction общедоступное свойство

Идентификатор действия по умолчанию контроллера.

public string $defaultAction = 'load'

$globalFixtures общедоступное свойство

Глобальные фикстуры, которые должны применяться при загрузке и разгрузке. По умолчанию установлено в InitDbFixture , что отключает и включает проверку целостности, чтобы ваши данные можно было безопасно загрузить.

public array $globalFixtures = ['yii\test\InitDbFixture']

$namespace общедоступное свойство

По умолчанию пространство имен для поиска фикстур

public string $namespace = 'tests\unit\fixtures'

Подробности методов

actionLoad() public method

Загружает указанные данные фикстур.

Например,

# load the fixture data specified by User and UserProfile.
# any existing fixture data will be removed first
yii fixture/load "User, UserProfile"

# load all available fixtures found under 'tests\unit\fixtures'
yii fixture/load "*"

# load all fixtures except User and UserProfile
yii fixture/load "*, -User, -UserProfile"
public integer actionLoad ( array $fixturesInput = [] )
$fixturesInput array
return integer

Код возврата

throws yii\console\Exception

если указанная фикстура не существует.

actionUnload() public method

Выгружает указанные фикстуры.

Например,

# unload the fixture data specified by User and UserProfile.
yii fixture/unload "User, UserProfile"

# unload all fixtures found under 'tests\unit\fixtures'
yii fixture/unload "*"

# unload all fixtures except User and UserProfile
yii fixture/unload "*, -User, -UserProfile"
public integer actionUnload ( array $fixturesInput = [] )
$fixturesInput array
return integer

Код возврата

throws yii\console\Exception

если указанная фикстура не существует.

needToApplyAll() public method

Проверяет необходимость применения всех фикстур.

public boolean needToApplyAll ( $fixture )
$fixture string

notifyNothingToLoad() public method

Сообщает пользователю, что нет фикстур для загрузки в соответствии с условиями ввода.

public void notifyNothingToLoad ( $foundFixtures, $except )
$foundFixtures array

Массив найденных фикстур

$except array

Массив имён фикстур, которые не должны загружаться

notifyNothingToUnload() public method

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

public void notifyNothingToUnload ( $foundFixtures, $except )
$foundFixtures array

Массив найденных фикстур

$except array

Массив имён фикстур, которые не должны загружаться

optionAliases() public method (available since version 2.0.8)

Возвращает псевдонимы опций.

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

public array optionAliases ( )
return array

Псевдонимы опций, допустимые для действия, где ключом является псевдоним опции, а значением — имя опции.

options() public method

Возвращает имена допустимых опций для действия (id). Опция требует существования публичной переменной-члена, имя которой совпадает с именем опции.

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

Обратите внимание, что значения, заданные с помощью опций, недоступны до вызова beforeAction().

public string[] options ( $actionID )
$actionID string

Идентификатор действия текущего запроса

return string[]

Имена опций, допустимых для действия

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-console-controllers-fixturecontroller.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API