Skip to content

ProjectConfigData

Type
Class
Namespace
craft\models
Inherits
craft\models\ProjectConfigData » craft\models\ReadOnlyProjectConfigData » 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

ProjectConfigData model class represents a modifiable instance of a project config data structure that can be modified

View source

Public Properties

PropertyDescription
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.
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
iteratorArrayIterator – An iterator for traversing the items in the list.
scenariostring – The scenario that this model is in.
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

Protected Properties

PropertyDescription
data
parsedChangesarray – Holds the already parsed paths as keys.
projectConfig
projectConfigNameChangesarray – Keeps track of all the project config name changes.

parsedChanges

Type
array
Default value
[]

Holds the already parsed paths as keys.

View source

projectConfigNameChanges

DEPRECATED

Deprecated in 4.4.17

Type
array
Default value
[]

Keeps track of all the project config name changes.

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()
__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.
commitChanges()Commit changes by firing the appropriate events and updating the appropriate storages.
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.
export()Export the data to an array.
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.
get()Get a stored data value for a path.
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.
getHasPathBeenModified()Return true if a path has been modified over the lifetime of this project config set.
getIterator()Returns an iterator for traversing the attributes in the model.
getProjectConfigNameChanges()Get a list of all the project name changes.
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.

commitChanges()

Commit changes by firing the appropriate events and updating the appropriate storages.

View source

Arguments

getHasPathBeenModified()

Return true if a path has been modified over the lifetime of this project config set.

View source

Arguments

Returns

boolean

getProjectConfigNameChanges()

DEPRECATED

Deprecated in 4.4.17

Get a list of all the project name changes.

View source

Returns

array

Protected Methods

MethodDescription
defineBehaviors()Returns the behaviors to attach to this class.
defineRules()Returns the validation rules for attributes.
delete()Delete a path from the internal data storage.
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.
removeContainedProjectConfigNames()Mark any contained project config names for removal.
resolveFields()Determines which fields can be returned by toArray().
setContainedProjectConfigNames()Set all the contained project config names to the buffer.
setInternal()Update the internal data storage.

delete()

Delete a path from the internal data storage.

View source

Arguments

Returns

mixed

removeContainedProjectConfigNames()

DEPRECATED

Deprecated in 4.4.17

Mark any contained project config names for removal.

View source

Arguments

setContainedProjectConfigNames()

DEPRECATED

Deprecated in 4.4.17

Set all the contained project config names to the buffer.

View source

Arguments

setInternal()

Update the internal data storage.

View source

Arguments

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.