InvalidateTagsController
- Type
- Class
- Namespace
- craft\console\controllers
- Inherits
- craft\console\controllers\InvalidateTagsController » craft\console\Controller » 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
- Since
- 3.5.0
Allows you to invalidate cache tags.
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() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| actionAll() | Clear all caches. |
| actionIndex() | Lists the caches that can be cleared. |
| actions() | 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. |
| createDirectory() | Creates a directory, and outputs to the console. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| do() | Performs an action with descriptive output. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| failure() | Outputs a failure message to the console. |
| findLayoutFile() (opens new window) | Finds the applicable layout file. |
| getActionArgsHelp() | Returns the help information for the anonymous arguments for the action. |
| getActionHelp() | Returns the detailed help information for the specified action. |
| getActionHelpSummary() | Returns a one-line short summary describing the specified action. |
| getActionOptionsHelp() | 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. |
| 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. |
| 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. |
| isColorEnabled() (opens new window) | Returns a value indicating whether ANSI color is enabled. |
| markdownToAnsi() | Converts Markdown to be better readable in console environments by applying some ANSI format. |
| note() | Outputs a note to the console. |
| 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() | Returns the names of valid options for the action (id). |
| passwordPrompt() | Prompts the user for a password and validates it. |
| 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() | Runs a request specified in terms of a route. |
| runAction() | Runs an action within this controller 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. |
| success() | Outputs a success message to the console. |
| table() | Outputs a table via craft\helpers\Console::table(). |
| tip() | Outputs a tip to the console. |
| trigger() (opens new window) | Triggers an event. |
| warning() | Outputs a warning to the console. |
| writeJson() | JSON-encodes a value and writes it to a file. |
| writeToFile() | Writes contents to a file, and outputs to the console. |
# actionAll()
Clear all caches.
View source (opens new window)
Returns
Throws
# actionIndex()
Lists the caches that can be cleared.
View source (opens new window)
Returns
# 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. |
| defineActions() | Returns an array of custom actions that should be available on the controller. |
| getActionMethodReflection() | |
| 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. |
# defineActions()
Returns an array of custom actions that should be available on the controller.
The keys of this array should be the action IDs, and the values can be callables or sub-arrays with the following keys:
action– A callable that is responsible for running the actionoptions– An array of options that should be available to the command. Options can either be defined as strings (['option1', 'option2']) or key/value pairs (['option1' => 'defaultValue']).helpSummary– Help summary text for the action (shown when runningcraft help controller-id)help– Help text for the action (shown when runningcraft help controller-id/action-id)argsHelp– Sub-array that defines help text for the arguments, indexed by argument names (shown when runningcraft help controller-id/action-id)optionsHelp– Sub-array that defines help text for the options, indexed by option names (shown when runningcraft help controller-id/action-id)
View source (opens new window)
Returns
# Constants
| Constant | Description |
|---|---|
EXIT_CODE_ERROR | |
EXIT_CODE_NORMAL |