Section

Type
Class
Namespace
craft\models
Inherits
craft\models\Section » 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), 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
3.0.0

Section model class.

View source (opens new window)

# Public Properties

Property Description
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
config array (opens new window)
enableVersioning boolean (opens new window) – Enable versioning
entryTypes craft\models\EntryType[]
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.
handle string (opens new window), null (opens new window) – Handle
hasMultiSiteEntries boolean (opens new window)
id integer (opens new window), null (opens new window) – ID
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
maxLevels integer (opens new window), null (opens new window) – Max levels
name string (opens new window), null (opens new window) – Name
previewTargets array (opens new window) – Preview targets
propagateEntries boolean (opens new window) – Propagate entries
propagationMethod string (opens new window) – 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
scenario (opens new window) string (opens new window) – The scenario that this model is in.
siteIds integer (opens new window)[]
siteSettings craft\models\Section_SiteSettings[]
structureId integer (opens new window), null (opens new window) – Structure ID
type string (opens new window), null (opens new window) – Type
uid string (opens new window), null (opens new window) – Section's UID
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# config

Type
array (opens new window)
Default value
null
Access
Read-only
Since
3.5.0

View source (opens new window)

# enableVersioning

Type
boolean (opens new window)
Default value
true

Enable versioning

View source (opens new window)

# entryTypes

Type
craft\models\EntryType[]
Default value
null

View source (opens new window)

# handle

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

Handle

View source (opens new window)

# hasMultiSiteEntries

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.0.35

View source (opens new window)

# id

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

ID

View source (opens new window)

# maxLevels

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

Max levels

View source (opens new window)

# name

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

Name

View source (opens new window)

# previewTargets

Type
array (opens new window)
Default value
null

Preview targets

View source (opens new window)

# propagateEntries

DEPRECATED

Deprecated in 3.2.0. Use propagationMethod instead

Type
boolean (opens new window)
Default value
true

Propagate entries

View source (opens new window)

# propagationMethod

Type
string (opens new window)
Default value
self::PROPAGATION_METHOD_ALL
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 (opens new window)

# siteIds

Type
integer (opens new window)[]
Default value
null
Access
Read-only

View source (opens new window)

# siteSettings

Type
craft\models\Section_SiteSettings[]
Default value
null

View source (opens new window)

# structureId

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

Structure ID

View source (opens new window)

# type

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

Type

View source (opens new window)

# uid

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

Section's UID

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() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__toString() Use the translated section name as the string representation.
__unset() (opens new window) Sets an object property to 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.
addSiteSettingsErrors() Adds site-specific errors to the model.
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() 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.
getConfig() Returns the field layout config for this section.
getEntryTypes() Returns the section's entry types.
getError() Returns the first error of the specified attribute.
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.
getHasMultiSiteEntries() Returns whether entries in this section support multiple sites.
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.
getSiteIds() Returns the site IDs that are enabled for the section.
getSiteSettings() Returns the section's site-specific settings, indexed by site ID.
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.
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() (opens new window) Sets the attribute values in a massive way.
setEntryTypes() Sets the section's entry types.
setScenario() (opens new window) Sets the scenario for the model.
setSiteSettings() Sets the section's site-specific settings.
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.
validatePreviewTargets() Validates the preview targets.
validateSiteSettings() Validates the site settings.

# __toString()

Use the translated section name as the string representation.

View source (opens new window)

Returns

string (opens new window)

# addSiteSettingsErrors()

Adds site-specific errors to the model.

View source (opens new window)

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() (opens new window). 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 (opens new window)

Returns

array (opens new window) – Attribute labels (name => label)

# getConfig()

Since
3.5.0

Returns the field layout config for this section.

View source (opens new window)

Returns

array (opens new window)

# getEntryTypes()

Returns the section's entry types.

View source (opens new window)

Returns

craft\models\EntryType[]

# getHasMultiSiteEntries()

Since
3.0.35

Returns whether entries in this section support multiple sites.

View source (opens new window)

Returns

boolean (opens new window)

# getSiteIds()

Returns the site IDs that are enabled for the section.

View source (opens new window)

Returns

integer (opens new window)[]

# getSiteSettings()

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

View source (opens new window)

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 (opens new window)

# setEntryTypes()

Since
3.1.0

Sets the section's entry types.

View source (opens new window)

Arguments

# setSiteSettings()

Sets the section's site-specific settings.

View source (opens new window)

Arguments

# validatePreviewTargets()

Validates the preview targets.

View source (opens new window)

# validateSiteSettings()

Validates the site settings.

View source (opens new window)

# Protected Methods

Method Description
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).

# defineRules()

Since
3.4.0

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source (opens new window)

Returns

array (opens new window)

# Constants

Constant Description
PROPAGATION_METHOD_ALL
PROPAGATION_METHOD_CUSTOM
PROPAGATION_METHOD_LANGUAGE
PROPAGATION_METHOD_NONE
PROPAGATION_METHOD_SITE_GROUP
SCENARIO_DEFAULT The name of the default scenario.
TYPE_CHANNEL
TYPE_SINGLE
TYPE_STRUCTURE