Section

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

Section model class.

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
enableVersioningboolean – Enable versioning
entryTypescraft\models\EntryType[]
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
handlestring, null – Handle
hasMultiSiteEntriesboolean
idinteger, null – ID
iteratorArrayIterator – An iterator for traversing the items in the list.
maxLevelsinteger, null – Max levels
namestring, null – Name
previewTargetsarray – Preview targets
propagateEntriesboolean – Propagate entries
propagationMethodstring – Propagation method This will be set to one of the following: - none – Only save entries in the site they were created in - siteGroup – Save entries to other sites in the same site group - language – Save entries to other sites with the same language - all – Save entries to all sites enabled for this section
scenariostring – The scenario that this model is in.
siteIdsinteger[]
siteSettingscraft\models\Section_SiteSettings[]
structureIdinteger, null – Structure ID
typestring, null – Type
uidstring, null – Section's UID
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

enableVersioning

Type
boolean

Enable versioning

View source

entryTypes

Type
craft\models\EntryType[]

View source

handle

Type
string, null

Handle

View source

hasMultiSiteEntries

Type
boolean
Access
Read-only

View source

id

Type
integer, null

ID

View source

maxLevels

Type
integer, null

Max levels

View source

name

Type
string, null

Name

View source

previewTargets

Type
array

Preview targets

View source

propagateEntries

DEPRECATED

Deprecated in 3.2. Use propagationMethod instead

Type
boolean

Propagate entries

View source

propagationMethod

Type
string
Since
3.2.0

Propagation method

This will be set to one of the following:

  • none – Only save entries in the site they were created in
  • siteGroup – Save entries to other sites in the same site group
  • language – Save entries to other sites with the same language
  • all – Save entries to all sites enabled for this section

View source

siteIds

Type
integer[]
Access
Read-only

View source

siteSettings

Type
craft\models\Section_SiteSettings[]

View source

structureId

Type
integer, null

Structure ID

View source

type

Type
string, null

Type

View source

uid

Type
string, null

Section's UID

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__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.
__toString()Use the translated section name as the string representation.
__unset()Sets an object property to 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.
addSiteSettingsErrors()Adds site-specific errors to the model.
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.
getEntryTypes()Returns the section's entry types.
getError()Returns the first error of the specified attribute.
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.
getHasMultiSiteEntries()Returns whether entries in this section support multiple sites.
getIterator()Returns an iterator for traversing the attributes in the model.
getScenario()Returns the scenario that this model is used in.
getSiteIds()Returns the site IDs that are enabled for the section.
getSiteSettings()Returns the section's site-specific settings, indexed by site ID.
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.
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.
setEntryTypes()Sets the section's entry types.
setScenario()Sets the scenario for the model.
setSiteSettings()Sets the section's site-specific settings.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateMultiple()Validates multiple models.
validatePreviewTargets()Validates the preview targets.
validateSiteSettings()Validates the site settings.

__toString()

Use the translated section name as the string representation.

View source

Returns

string

addSiteSettingsErrors()

Adds site-specific errors to the model.

View source

Arguments

attributeLabels()

Returns the attribute labels.

Attribute labels are mainly used for display purpose. For example, given an attribute firstName, we can declare a label First Name which is more user-friendly and can be displayed to end users.

By default an attribute label is generated using generateAttributeLabel(). This method allows you to explicitly specify attribute labels.

Note, in order to inherit labels defined in the parent class, a child class needs to merge the parent labels with child labels using functions such as array_merge().

View source

Returns

array – Attribute labels (name => label)

getEntryTypes()

Returns the section's entry types.

View source

Returns

craft\models\EntryType[]

getHasMultiSiteEntries()

Since
3.0.35

Returns whether entries in this section support multiple sites.

View source

Returns

boolean

getSiteIds()

Returns the site IDs that are enabled for the section.

View source

Returns

integer[]

getSiteSettings()

Returns the section's site-specific settings, indexed by site ID.

View source

Returns

craft\models\Section_SiteSettings[]

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

rules()

Returns the validation rules for attributes.

Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

  • attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
  • validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
  • on: optional, specifies the scenarios array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
  • additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \craft\models\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of \craft\models\Validator::builtInValidators. Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge().

View source

Returns

array – Validation rules

setEntryTypes()

Since
3.1.0

Sets the section's entry types.

View source

Arguments

setSiteSettings()

Sets the section's site-specific settings.

View source

Arguments

validatePreviewTargets()

Validates the preview targets.

View source

validateSiteSettings()

Validates the site settings.

View source

Protected Methods

MethodDescription
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
PROPAGATION_METHOD_ALL
PROPAGATION_METHOD_LANGUAGE
PROPAGATION_METHOD_NONE
PROPAGATION_METHOD_SITE_GROUP
SCENARIO_DEFAULTThe name of the default scenario.
TYPE_CHANNEL
TYPE_SINGLE
TYPE_STRUCTURE