ResaveController

Type
Class
Namespace
craft\console\controllers
Inherits
craft\console\controllers\ResaveController » craft\console\Controller » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable, yii\base\ViewContextInterface
Uses traits
craft\console\ControllerTrait
Since
3.1.15

Allows you to bulk-saves elements.

View source

Public Properties

PropertyDescription
actionyii\base\Action – The action that is currently being executed.
behaviorsyii\base\Behavior – List of behaviors attached to this component
colorboolean – Whether to enable ANSI color in the output.
defaultActionstring – The ID of the action that is used when the action ID is not specified in the request.
elementIdinteger, string – The ID(s) of the elements to resave.
fieldstring, null – The field handle to save Matrix blocks for.
groupstring, null – The group handle(s) to save categories/tags/users from.
helpboolean – Whether to display help information about current command.
helpSummarystring
idstring – The ID of this controller.
interactiveboolean – Whether to run the command interactively.
layoutnull, string, false – The name of the layout to be applied to this controller's views.
limitinteger, null – The number of elements to resave.
moduleyii\base\Module – The module that this controller belongs to.
modulesyii\base\Module – All ancestor modules that this controller is located within.
offsetinteger, null – The number of elements to skip.
passedOptionValuesarray – The properties corresponding to the passed options
passedOptionsarray – The names of the options passed during execution
propagateboolean – Whether to save the elements across all their enabled sites.
routestring – The route (module ID, controller ID and action ID) of the current request.
sectionstring, null – The section handle(s) to save entries from.
sitestring, null – The site handle to save elements from.
statusstring – The status(es) of elements to resave.
typestring, null – The type handle(s) of the elements to resave.
uidstring – The UUID(s) of the elements to resave.
uniqueIdstring – The controller ID that is prefixed with the module ID (if any).
viewyii\base\View, yii\web\View – The view object that can be used to render views or view files.
viewPathstring – The directory containing the view files for this controller.
volumestring, null – The volume handle(s) to save assets from.

elementId

Type
integer, string

The ID(s) of the elements to resave.

View source

field

Type
string, null

The field handle to save Matrix blocks for.

View source

group

Type
string, null

The group handle(s) to save categories/tags/users from. Can be set to multiple comma-separated groups.

View source

limit

Type
integer, null

The number of elements to resave.

View source

offset

Type
integer, null

The number of elements to skip.

View source

propagate

Type
boolean

Whether to save the elements across all their enabled sites.

View source

section

Type
string, null

The section handle(s) to save entries from. Can be set to multiple comma-separated sections.

View source

site

Type
string, null

The site handle to save elements from.

View source

status

Type
string

The status(es) of elements to resave. Can be set to multiple comma-separated statuses.

View source

type

Type
string, null

The type handle(s) of the elements to resave.

View source

uid

Type
string

The UUID(s) of the elements to resave.

View source

volume

Type
string, null

The volume handle(s) to save assets from. Can be set to multiple comma-separated volumes.

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
actionAssets()Re-saves assets.
actionCategories()Re-saves categories.
actionEntries()Re-saves entries.
actionMatrixBlocks()Re-saves Matrix blocks.
actionTags()Re-saves tags.
actionUsers()Re-saves users.
actions()Declares external actions for the controller.
afterAction()This method is invoked right after an action is executed.
ansiFormat()Formats a string with ANSI codes.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
beforeAction()This method is invoked right before an action is executed.
behaviors()Returns a list of behaviors that this component should behave as.
bindActionParams()Binds the parameters to the action.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
confirm()Asks user to confirm by typing y or n.
createAction()Creates an action based on the given action ID.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
findLayoutFile()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()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getHelp()Returns help information for this controller.
getHelpSummary()Returns one-line short summary describing this controller.
getModules()Returns all ancestor modules of this controller.
getOptionValues()Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.
getPassedOptionValues()Returns the properties corresponding to the passed options.
getPassedOptions()Returns the names of valid options passed during execution.
getRoute()Returns the route of the current request.
getUniqueId()Returns the unique ID of the controller.
getView()Returns the view object that can be used to render views or view files.
getViewPath()Returns the directory containing view files for this controller.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
isColorEnabled()Returns a value indicating whether ANSI color is enabled.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
optionAliases()Returns option alias names.
options()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()Prompts the user for input and validates it.
render()Renders a view and applies layout if available.
renderContent()Renders a static string by applying a layout.
renderFile()Renders a view file.
renderPartial()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.
saveElements()
select()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()Sets the view object to be used by this controller.
setViewPath()Sets the directory that contains the view files.
stderr()Prints a string to STDERR.
stdout()Prints a string to STDOUT.
trigger()Triggers an event.

actionAssets()

Re-saves assets.

View source

Returns

integer

actionCategories()

Re-saves categories.

View source

Returns

integer

actionEntries()

Re-saves entries.

View source

Returns

integer

actionMatrixBlocks()

Since
3.2

Re-saves Matrix blocks.

View source

Returns

integer

actionTags()

Re-saves tags.

View source

Returns

integer

actionUsers()

Re-saves users.

View source

Returns

integer

options()

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.

Child classes may override this method to specify possible options.

Note that the values setting via options are not available until beforeAction() is being called.

View source

Arguments

  • $actionID (string) – The action id of the current request

Returns

string[] – The names of the options valid for the action

saveElements()

View source

Arguments

Returns

integer

Protected Methods

MethodDescription
defineActions()Returns an array of custom actions that should be available on the controller.
getActionMethodReflection()
outputCommand()
parseDocCommentDetail()Returns full description from the docblock.
parseDocCommentSummary()Returns the first line of docblock.
parseDocCommentTags()Parses the comment block into tags.

Constants

ConstantDescription
EXIT_CODE_ERROR
EXIT_CODE_NORMAL