Class craft\models\Section

Inheritance: 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: yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/models/Section.php

Section model class.

Public Properties
Property	Type	Description	Defined By
`$enableVersioning`	boolean	Enable versioning	craft\models\Section
`$handle`	string, null	Handle	craft\models\Section
`$id`	integer, null	ID	craft\models\Section
`$maxLevels`	integer, null	Max levels	craft\models\Section
`$name`	string, null	Name	craft\models\Section
`$propagateEntries`	boolean	Propagate entries	craft\models\Section
`$structureId`	integer, null	Structure ID	craft\models\Section
`$type`	string, null	Type	craft\models\Section

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__toString()`	Use the translated section name as the string representation.	craft\models\Section
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`activeAttributes()`	Returns the attribute names that are subject to validation in the current scenario.	yii\base\Model
`addError()`	Adds a new error to the specified attribute.	yii\base\Model
`addErrors()`	Adds a list of errors.	yii\base\Model
`addModelErrors()`	Adds errors from another model, with a given attribute name prefix.	craft\base\Model
`addSiteSettingsErrors()`	Adds site-specific errors to the model.	craft\models\Section
`afterValidate()`	This method is invoked after validation ends.	yii\base\Model
`attachBehavior()`	Attaches a behavior to this component.	yii\base\Component
`attachBehaviors()`	Attaches a list of behaviors to the component.	yii\base\Component
`attributeHints()`	Returns the attribute hints.	yii\base\Model
`attributeLabels()`	Returns the attribute labels.	yii\base\Model
`attributes()`	Returns the list of attribute names.	yii\base\Model
`beforeValidate()`	This method is invoked before validation starts.	yii\base\Model
`behaviors()`	Returns a list of behaviors that this component should behave as.	yii\base\Component
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`clearErrors()`	Removes errors for all attributes or a single attribute.	yii\base\Model
`createValidators()`	Creates validator objects based on the validation rules specified in rules().	yii\base\Model
`datetimeAttributes()`	Returns the names of any attributes that should hold DateTime values.	craft\base\Model
`detachBehavior()`	Detaches a behavior from the component.	yii\base\Component
`detachBehaviors()`	Detaches all behaviors from the component.	yii\base\Component
`ensureBehaviors()`	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
`extraFields()`	Returns the list of fields that can be expanded further and returned by toArray().	yii\base\ArrayableTrait
`fields()`	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.	yii\base\ArrayableTrait
`formName()`	Returns the form name that this model class should use.	yii\base\Model
`generateAttributeLabel()`	Generates a user friendly attribute label based on the give attribute name.	yii\base\Model
`getActiveValidators()`	Returns the validators applicable to the current \yii\base\scenario.	yii\base\Model
`getAttributeHint()`	Returns the text hint for the specified attribute.	yii\base\Model
`getAttributeLabel()`	Returns the text label for the specified attribute.	yii\base\Model
`getAttributes()`	Returns attribute values.	yii\base\Model
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getEntryTypes()`	Returns the section's entry types.	craft\models\Section
`getError()`	Returns the first error of the specified attribute.	craft\base\Model
`getErrorSummary()`	Returns the errors for all attributes as a one-dimensional array.	yii\base\Model
`getErrors()`	Returns the errors for all attributes or a single attribute.	yii\base\Model
`getFirstError()`	Returns the first error of the specified attribute.	yii\base\Model
`getFirstErrors()`	Returns the first error of every attribute in the model.	yii\base\Model
`getIterator()`	Returns an iterator for traversing the attributes in the model.	yii\base\Model
`getScenario()`	Returns the scenario that this model is used in.	yii\base\Model
`getSiteIds()`	Returns the site IDs that are enabled for the section.	craft\models\Section
`getSiteSettings()`	Returns the section's site-specific settings, indexed by site ID.	craft\models\Section
`getValidators()`	Returns all the validators declared in rules().	yii\base\Model
`hasErrors()`	Returns a value indicating whether there is any validation error.	yii\base\Model
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	craft\base\Model
`instance()`	Returns static class instance, which can be used to obtain meta information.	yii\base\StaticInstanceTrait
`isAttributeActive()`	Returns a value indicating whether the attribute is active in the current scenario.	yii\base\Model
`isAttributeRequired()`	Returns a value indicating whether the attribute is required.	yii\base\Model
`isAttributeSafe()`	Returns a value indicating whether the attribute is safe for massive assignments.	yii\base\Model
`load()`	Populates the model with input data.	yii\base\Model
`loadMultiple()`	Populates a set of models with the data from end user.	yii\base\Model
`off()`	Detaches an existing event handler from this component.	yii\base\Component
`offsetExists()`	Returns whether there is an element at the specified offset.	yii\base\Model
`offsetGet()`	Returns the element at the specified offset.	yii\base\Model
`offsetSet()`	Sets the element at the specified offset.	yii\base\Model
`offsetUnset()`	Sets the element value at the specified offset to null.	yii\base\Model
`on()`	Attaches an event handler to an event.	yii\base\Component
`onUnsafeAttribute()`	This method is invoked when an unsafe attribute is being massively assigned.	yii\base\Model
`rules()`	Returns the validation rules for attributes.	craft\models\Section
`safeAttributes()`	Returns the attribute names that are safe to be massively assigned in the current scenario.	yii\base\Model
`scenarios()`	Returns a list of scenarios and the corresponding active attributes.	yii\base\Model
`setAttributes()`	Sets the attribute values in a massive way.	yii\base\Model
`setScenario()`	Sets the scenario for the model.	yii\base\Model
`setSiteSettings()`	Sets the section's site-specific settings.	craft\models\Section
`toArray()`	Converts the model into an array.	yii\base\ArrayableTrait
`trigger()`	Triggers an event.	yii\base\Component
`validate()`	Performs the data validation.	yii\base\Model
`validateMultiple()`	Validates multiple models.	yii\base\Model
`validateSiteSettings()`	Validates the site settings.	craft\models\Section

Protected Methods
Method	Description	Defined By
`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".	yii\base\ArrayableTrait
`extractRootFields()`	Extracts the root field names from nested fields.	yii\base\ArrayableTrait
`resolveFields()`	Determines which fields can be returned by toArray().	yii\base\ArrayableTrait

Events
Event	Type	Description	Defined By
`EVENT_AFTER_VALIDATE`	yii\base\Event	An event raised at the end of validate()	yii\base\Model
`EVENT_BEFORE_VALIDATE`	yii\base\ModelEvent	An event raised at the beginning of validate().	yii\base\Model

Constants
Constant	Value	Description	Defined By
`SCENARIO_DEFAULT`	'default'	The name of the default scenario.	yii\base\Model
`TYPE_CHANNEL`	'channel'		craft\models\Section
`TYPE_SINGLE`	'single'		craft\models\Section
`TYPE_STRUCTURE`	'structure'		craft\models\Section

Property Details

`$enableVersioning` public property #

Enable versioning

public boolean $enableVersioning = true

`$handle` public property #

Handle

public string, null $handle = null

`$id` public property #

public integer, null $id = null

`$maxLevels` public property #

Max levels

public integer, null $maxLevels = null

`$name` public property #

Name

public string, null $name = null

`$propagateEntries` public property #

Propagate entries

public boolean $propagateEntries = true

`$structureId` public property #

Structure ID

public integer, null $structureId = null

`$type` public property #

Type

public string, null $type = null

Method Details

`__toString()` public method #

Use the translated section name as the string representation.

public string __toString ( )

`addSiteSettingsErrors()` public method #

Adds site-specific errors to the model.

public void addSiteSettingsErrors ( array $errors, \craft\models\int $siteId )

`$errors`	array
`$siteId`	integer

`getEntryTypes()` public method #

Returns the section's entry types.

public craft\models\EntryType[] getEntryTypes ( )

`getSiteIds()` public method #

Returns the site IDs that are enabled for the section.

public integer[] getSiteIds ( )

`getSiteSettings()` public method #

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

public craft\models\Section_SiteSettings[] getSiteSettings ( )

`rules()` public method #

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 \craft\models\scenario 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().

public array rules ( )

return	array	Validation rules

`setSiteSettings()` public method #

Sets the section's site-specific settings.

public void setSiteSettings ( array $siteSettings )

$siteSettings craft\models\Section_SiteSettings[] Array of Section_SiteSettings objects.

`validateSiteSettings()` public method #

Validates the site settings.

public void validateSiteSettings ( )

Property Details

$enableVersioning public property #

$handle public property #

$id public property #

$maxLevels public property #

$name public property #

$propagateEntries public property #

$structureId public property #

$type public property #

Method Details

__toString() public method #

addSiteSettingsErrors() public method #

getEntryTypes() public method #

getSiteIds() public method #

getSiteSettings() public method #

rules() public method #

setSiteSettings() public method #

validateSiteSettings() public method #