FixtureController
- Type
- Class
- Namespace
- craft\console\controllers
- Inherits
- craft\console\controllers\FixtureController » yii\console\controllers\FixtureController (opens new window) » yii\console\Controller (opens new window) » yii\base\Controller (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window), yii\base\ViewContextInterface (opens new window)
- Uses traits
- craft\console\ControllerTrait, yii\test\FixtureTrait (opens new window)
- Since
- 3.2.0
Allows you to manage test fixtures.
View source (opens new window)
# Public Properties
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | |
| __get() (opens new window) | Returns the value of a component property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| actionLoad() (opens new window) | Loads the specified fixture data. |
| actionUnload() (opens new window) | Unloads the specified fixtures. |
| actions() (opens new window) | Declares external actions for the controller. |
| afterAction() (opens new window) | This method is invoked right after an action is executed. |
| ansiFormat() (opens new window) | Formats a string with ANSI codes. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| beforeAction() | This method is invoked right before an action is executed. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| bindActionParams() (opens new window) | Binds the parameters to the action. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| confirm() (opens new window) | Asks user to confirm by typing y or n. |
| createAction() (opens new window) | Creates an action based on the given action ID. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| findLayoutFile() (opens new window) | Finds the applicable layout file. |
| fixtures() (opens new window) | Declares the fixtures that are needed by the current test case. |
| getActionArgsHelp() (opens new window) | Returns the help information for the anonymous arguments for the action. |
| getActionHelp() (opens new window) | Returns the detailed help information for the specified action. |
| getActionHelpSummary() (opens new window) | Returns a one-line short summary describing the specified action. |
| getActionOptionsHelp() (opens new window) | Returns the help information for the options for the action. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getFixture() (opens new window) | Returns the named fixture. |
| getFixtures() (opens new window) | Returns the fixture objects as specified in globalFixtures() (opens new window) and fixtures() (opens new window). |
| getHelp() (opens new window) | Returns help information for this controller. |
| getHelpSummary() (opens new window) | Returns one-line short summary describing this controller. |
| getModules() (opens new window) | Returns all ancestor modules of this controller. |
| getOptionValues() (opens new window) | Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. |
| getPassedOptionValues() (opens new window) | Returns the properties corresponding to the passed options. |
| getPassedOptions() (opens new window) | Returns the names of valid options passed during execution. |
| getRoute() (opens new window) | Returns the route of the current request. |
| getUniqueId() (opens new window) | Returns the unique ID of the controller. |
| getView() (opens new window) | Returns the view object that can be used to render views or view files. |
| getViewPath() (opens new window) | Returns the directory containing view files for this controller. |
| globalFixtures() (opens new window) | Declares the fixtures shared required by different test cases. |
| hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| initFixtures() (opens new window) | Initialize the fixtures. |
| isColorEnabled() (opens new window) | Returns a value indicating whether ANSI color is enabled. |
| loadFixtures() (opens new window) | Loads the specified fixtures. |
| needToApplyAll() (opens new window) | Checks if needed to apply all fixtures. |
| notifyNothingToLoad() (opens new window) | Notifies user that there are no fixtures to load according input conditions. |
| notifyNothingToUnload() (opens new window) | Notifies user that there are no fixtures to unload according input conditions. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| optionAliases() (opens new window) | Returns option alias names. |
| options() (opens new window) | Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name. |
| prompt() (opens new window) | Prompts the user for input and validates it. |
| render() (opens new window) | Renders a view and applies layout if available. |
| renderContent() (opens new window) | Renders a static string by applying a layout. |
| renderFile() (opens new window) | Renders a view file. |
| renderPartial() (opens new window) | Renders a view without applying layout. |
| run() (opens new window) | Runs a request specified in terms of a route. |
| runAction() (opens new window) | Runs an action with the specified action ID and parameters. |
| select() (opens new window) | Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations. |
| setView() (opens new window) | Sets the view object to be used by this controller. |
| setViewPath() (opens new window) | Sets the directory that contains the view files. |
| stderr() (opens new window) | Prints a string to STDERR. |
| stdout() (opens new window) | Prints a string to STDOUT. |
| trigger() (opens new window) | Triggers an event. |
| unloadFixtures() (opens new window) | Unloads the specified fixtures. |
# beforeAction()
This method is invoked right before an action is executed.
The method will trigger the EVENT_BEFORE_ACTION (opens new window) event. The return value of the method will determine whether the action should continue to run.
In case the action should not run, the request should be handled inside of the beforeAction code
by either providing the necessary output or redirecting the request. Otherwise the response will be empty.
If you override this method, your code should look like the following:
public function beforeAction($action)
{
// your custom code here, if you want the code to run before action filters,
// which are triggered on the [EVENT_BEFORE_ACTION](https://www.yiiframework.com/doc/api/2.0/yii-base-controller#EVENT_BEFORE_ACTION-detail) event, e.g. PageCache or AccessControl
if (!parent::beforeAction($action)) {
return false;
}
// other custom code here
return true; // or false to not run the action
}
View source (opens new window)
Arguments
$action(yii\base\Action (opens new window)) – The action to be executed.
Returns
boolean (opens new window) – Whether the action should continue to run.
# init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
View source (opens new window)
# Protected Methods
| Method | Description |
|---|---|
| bindInjectedParams() (opens new window) | Fills parameters based on types and names in action method signature. |
| checkRootUser() | Returns whether a command should be executed depending on whether it's being run as a root user, and whether they're OK with that. |
| checkTty() | Sets yii\console\Controller::$interactive (opens new window) to false if this isn’t a TTY shell. |
| createAttributeValidator() | Creates a function for the validator option of Controller::prompt. |
| createFixtures() (opens new window) | Creates the specified fixture instances. |
| getActionMethodReflection() (opens new window) | |
| outputCommand() | |
| parseDocCommentDetail() (opens new window) | Returns full description from the docblock. |
| parseDocCommentSummary() (opens new window) | Returns the first line of docblock. |
| parseDocCommentTags() (opens new window) | Parses the comment block into tags. |
# Constants
| Constant | Description |
|---|---|
EXIT_CODE_ERROR | |
EXIT_CODE_NORMAL |