Skip to content

AssetIndexingSession

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

AssetIndexingSession model class.

View source

Public Properties

PropertyDescription
actionRequiredboolean – Whether actions is required.
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
attributesarray – Attribute values (name => value).
behaviorsyii\base\Behavior – List of behaviors attached to this component.
cacheRemoteImagesboolean – Whether remote images should be cached locally.
dateCreatedDateTime, null – Time when indexing session was created.
dateUpdatedDateTime, null – Time when indexing session was last updated.
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
idinteger, null – ID
indexedVolumesstring – Textual list of volumes being indexed
isCliboolean
iteratorArrayIterator – An iterator for traversing the items in the list.
listEmptyFoldersboolean – Whether empty folders should be listed for deletion.
missingEntriesarray – The missing entries.
processIfRootEmptyboolean – Whether to continue processing if the FS root folder is empty.
processedEntriesinteger – The number of processed entries.
scenariostring – The scenario that this model is in.
skippedEntriesarray – The skipped entries.
totalEntriesinteger, null – The total amount of entries.
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

actionRequired

Type
boolean
Default value
null

Whether actions is required.

View source

cacheRemoteImages

Type
boolean
Default value
null

Whether remote images should be cached locally.

View source

dateCreated

Type
DateTime, null
Default value
null

Time when indexing session was created.

View source

dateUpdated

Type
DateTime, null
Default value
null

Time when indexing session was last updated.

View source

id

Type
integer, null
Default value
null

ID

View source

indexedVolumes

Type
string
Default value
null

Textual list of volumes being indexed

View source

isCli

Type
boolean
Default value
false

View source

listEmptyFolders

Type
boolean
Default value
null
Since
4.4.0

Whether empty folders should be listed for deletion.

View source

missingEntries

Type
array
Default value
[]

The missing entries.

View source

processIfRootEmpty

Type
boolean
Default value
false
Since
4.4.0

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

View source

processedEntries

Type
integer
Default value
null

The number of processed entries.

View source

skippedEntries

Type
array
Default value
[]

The skipped entries.

View source

totalEntries

Type
integer, null
Default value
null

The total amount of entries.

View source

Public Methods

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

Protected Methods

MethodDescription
defineBehaviors()Returns the behaviors to attach to this class.
defineRules()Returns the validation rules for attributes.
extractFieldsFor()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()Extracts the root field names from nested fields.
resolveFields()Determines which fields can be returned by toArray().

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.