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, craft\base\Chippable, craft\base\CpEditable, craft\base\Iconic, craft\base\ModelInterface, 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

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
config	array
cpEditUrl	string, null
defaultPlacement	string – Default placement
enableVersioning	boolean – Enable versioning
entryTypes	craft\models\EntryType[] – Entry types
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
handle	string, null – Handle
hasMultiSiteEntries	boolean – Whether entries in this section support multiple sites
icon	string, null
id	integer, null – ID
iterator	ArrayIterator – An iterator for traversing the items in the list.
maxAuthors	integer – Max authors
maxLevels	integer, null – Max levels
name	string, null – Name
previewTargets	array, null – Preview targets
propagationMethod	\craft\enums\PropagationMethod – Propagation method This will be set to one of the following: - PropagationMethod::None – Only save entries in the site they were created in - PropagationMethod::SiteGroup – Save entries to other sites in the same site group - PropagationMethod::Language – Save entries to other sites with the same language - PropagationMethod::Custom – Let each entry choose which sites it should be saved to - PropagationMethod::All – Save entries to all sites supported by the owner element
scenario	string – The scenario that this model is in.
siteIds	integer[]
siteSettings	craft\models\Section_SiteSettings[] – Site-specific settings
structureId	integer, null – Structure ID
type	self::TYPE_*, null – Type
uiLabel	string
uid	string, null – Section's UID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

config

Type

array

Default value

null

Access

Read-only

Since

3.5.0

View source

cpEditUrl

Type

string, null

Default value

null

Access

Read-only

View source

defaultPlacement

Type

string

Default value

self::DEFAULT_PLACEMENT_END

Since

3.7.0

Default placement

View source

enableVersioning

Type

boolean

Default value

true

Enable versioning

View source

entryTypes

Type

craft\models\EntryType[]

Default value

null

Entry types

View source

handle

Type

string, null

Default value

null

Handle

View source

hasMultiSiteEntries

Type

boolean

Default value

null

Whether entries in this section support multiple sites

View source

icon

Type

string, null

Default value

null

Access

Read-only

View source

id

Type

integer, null

Default value

null

ID

View source

maxAuthors

Type

integer

Default value

1

Since

5.0.0

Max authors

View source

maxLevels

Type

integer, null

Default value

null

Max levels

View source

name

Type

string, null

Default value

null

Name

View source

previewTargets

Type

array, null

Default value

null

Preview targets

View source

propagationMethod

Type

\craft\enums\PropagationMethod

Default value

\craft\enums\PropagationMethod::All

Since

3.2.0

Propagation method

This will be set to one of the following:

• PropagationMethod::None – Only save entries in the site they were created in
• PropagationMethod::SiteGroup – Save entries to other sites in the same site group
• PropagationMethod::Language – Save entries to other sites with the same language
• PropagationMethod::Custom – Let each entry choose which sites it should be saved to
• PropagationMethod::All – Save entries to all sites supported by the owner element

View source

siteIds

Type

integer[]

Default value

null

Access

Read-only

View source

siteSettings

Type

craft\models\Section_SiteSettings[]

Default value

null

Site-specific settings

View source

structureId

Type

integer, null

Default value

null

Structure ID

View source

type

Type

self::TYPE_*, null

Default value

null

Type

View source

uiLabel

Type

string

Default value

null

Access

Read-only

View source

uid

Type

string, null

Default value

null

Section's UID

View source

Public Methods

Method	Description
__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.
__toString()	Use the translated section name as the string representation.
__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.
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.
get()	Returns a component by its ID.
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.
getConfig()	Returns the section’s config.
getCpEditUrl()	Returns the URL to the component’s edit page in the control panel.
getEntryTypes()	Returns the section's entry types.
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.
getIcon()	Returns the component’s icon, if it has one.
getId()
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.
getUiLabel()	Returns what the component should be called within the control panel.
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.
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

• $errors (array)
• $siteId (integer)

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)

get()

Returns a component by its ID.

View source

Arguments

• $id (string, integer)

Returns

static, null

getConfig()

Since

3.5.0

Returns the section’s config.

View source

Returns

array

getCpEditUrl()

Returns the URL to the component’s edit page in the control panel.

View source

Returns

string, null

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

getIcon()

Returns the component’s icon, if it has one.

The returned icon can be a system icon’s name (e.g. 'whiskey-glass-ice'), the path to an SVG file, or raw SVG markup.

System icons can be found in src/icons/solid/.

View source

Returns

string, null

getId()

View source

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[]

getUiLabel()

Returns what the component should be called within the control panel.

View source

Returns

string

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

setEntryTypes()

Since

3.1.0

Sets the section's entry types.

View source

Arguments

• $entryTypes (craft\models\EntryType[])

setSiteSettings()

Sets the section's site-specific settings.

View source

Arguments

• $siteSettings (craft\models\Section_SiteSettings[]) – Array of Section_SiteSettings objects.

validatePreviewTargets()

Validates the preview targets.

View source

validateSiteSettings()

Validates the site settings.

View source

Protected Methods

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

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

Returns

array

Constants

Constant	Description
DEFAULT_PLACEMENT_BEGINNING
DEFAULT_PLACEMENT_END
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