AssetIndexingSession

Type
Class
Namespace
craft\models
Inherits
craft\models\AssetIndexingSession » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ModelInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since
4.0.0

AssetIndexingSession model class.

View source (opens new window)

# Public Properties

Property Description
actionRequired boolean (opens new window) – Whether actions is required.
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
attributes (opens new window) array (opens new window) – Attribute values (name => value).
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
cacheRemoteImages boolean (opens new window) – Whether remote images should be cached locally.
dateCreated DateTime (opens new window), null (opens new window) – Time when indexing session was created.
dateUpdated DateTime (opens new window), null (opens new window) – Time when indexing session was last updated.
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window) array (opens new window) – The first errors.
id integer (opens new window), null (opens new window) – ID
indexedVolumes string (opens new window) – Textual list of volumes being indexed
isCli boolean (opens new window)
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
listEmptyFolders boolean (opens new window) – Whether empty folders should be listed for deletion.
missingEntries array (opens new window) – The missing entries.
processIfRootEmpty boolean (opens new window) – Whether to continue processing if the FS root folder is empty.
processedEntries integer (opens new window) – The number of processed entries.
scenario (opens new window) string (opens new window) – The scenario that this model is in.
skippedEntries array (opens new window) – The skipped entries.
totalEntries integer (opens new window), null (opens new window) – The total amount of entries.
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# actionRequired

Type
boolean (opens new window)
Default value
null

Whether actions is required.

View source (opens new window)

# cacheRemoteImages

Type
boolean (opens new window)
Default value
null

Whether remote images should be cached locally.

View source (opens new window)

# dateCreated

Type
DateTime (opens new window), null (opens new window)
Default value
null

Time when indexing session was created.

View source (opens new window)

# dateUpdated

Type
DateTime (opens new window), null (opens new window)
Default value
null

Time when indexing session was last updated.

View source (opens new window)

# id

Type
integer (opens new window), null (opens new window)
Default value
null

ID

View source (opens new window)

# indexedVolumes

Type
string (opens new window)
Default value
null

Textual list of volumes being indexed

View source (opens new window)

# isCli

Type
boolean (opens new window)
Default value
false

View source (opens new window)

# listEmptyFolders

Type
boolean (opens new window)
Default value
null
Since
4.4.0

Whether empty folders should be listed for deletion.

View source (opens new window)

# missingEntries

Type
array (opens new window)
Default value
[]

The missing entries.

View source (opens new window)

# processIfRootEmpty

Type
boolean (opens new window)
Default value
false
Since
4.4.0

Whether to continue processing if the FS root folder is empty.

View source (opens new window)

# processedEntries

Type
integer (opens new window)
Default value
null

The number of processed entries.

View source (opens new window)

# skippedEntries

Type
array (opens new window)
Default value
[]

The skipped entries.

View source (opens new window)

# totalEntries

Type
integer (opens new window), null (opens new window)
Default value
null

The total amount of entries.

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone()
__construct()
__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.
activeAttributes() (opens new window) Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window) Adds a new error to the specified attribute.
addErrors() (opens new window) Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
afterValidate() (opens new window) This method is invoked after validation ends.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attributeHints() (opens new window) Returns the attribute hints.
attributeLabels() (opens new window) Returns the attribute labels.
attributes() (opens new window) Returns the list of attribute names.
beforeValidate() (opens new window) This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
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.
clearErrors() (opens new window) Removes errors for all attributes or a single attribute.
createValidators() (opens new window) Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() Returns the names of any attributes that should hold DateTime (opens new window) values.
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.
extraFields() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() (opens new window) Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formName() (opens new window) Returns the form name that this model class should use.
generateAttributeLabel() (opens new window) Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
getAttributeHint() (opens new window) Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window) Returns the text label for the specified attribute.
getAttributes() (opens new window) Returns attribute values.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getErrorSummary() (opens new window) Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window) Returns the errors for all attributes or a single attribute.
getFirstError() (opens new window) Returns the first error of the specified attribute.
getFirstErrors() (opens new window) Returns the first error of every attribute in the model.
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getScenario() (opens new window) Returns the scenario that this model is used in.
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
hasErrors() Returns a value indicating whether there is any validation error.
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.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window) Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window) Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window) Returns a value indicating whether the attribute is safe for massive assignments.
load() (opens new window) Populates the model with input data.
loadMultiple() (opens new window) Populates a set of models with the data from end user.
off() (opens new window) Detaches an existing event handler from this component.
offsetExists() (opens new window) Returns whether there is an element at the specified offset.
offsetGet() (opens new window) Returns the element at the specified offset.
offsetSet() (opens new window) Sets the element at the specified offset.
offsetUnset() (opens new window) Sets the element value at the specified offset to null.
on() (opens new window) Attaches an event handler to an event.
onUnsafeAttribute() (opens new window) This method is invoked when an unsafe attribute is being massively assigned.
rules() Returns the validation rules for attributes.
safeAttributes() (opens new window) Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window) Returns a list of scenarios and the corresponding active attributes.
setAttributes() Sets the attribute values in a massive way.
setScenario() (opens new window) Sets the scenario for the model.
toArray() (opens new window) Converts the model into an array.
trigger() (opens new window) Triggers an event.
validate() (opens new window) Performs the data validation.
validateMultiple() (opens new window) Validates multiple models.

# Protected Methods

Method Description
defineBehaviors() Returns the behaviors to attach to this class.
defineRules() Returns the validation rules for attributes.
extractFieldsFor() (opens new window) Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() (opens new window) Extracts the root field names from nested fields.
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.