Skip to content

MatrixBlockType

Type
Class
Namespace
craft\models
Inherits
craft\models\MatrixBlockType » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\FieldLayoutProviderInterface, craft\base\GqlInlineFragmentInterface, 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

MatrixBlockType 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.
configarray
eagerLoadingPrefixstring
errorsarray – Errors for all attributes or the specified attribute.
fieldcraft\fields\Matrix
fieldContextstring
fieldIdinteger, null – Field ID
fieldLayoutcraft\models\FieldLayout
fieldLayoutIdinteger, null – Field layout ID
firstErrorsarray – The first errors.
handlestring, null – Handle
hasFieldErrorsboolean
idinteger, string, null – ID The block ID.
isNewboolean – Whether this is a new block type
iteratorArrayIterator – An iterator for traversing the items in the list.
namestring, null – Name
scenariostring – The scenario that this model is in.
sortOrderinteger, null – Sort order
uidstring, null
validatorsArrayObject, 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

eagerLoadingPrefix

Type
string
Default value
null
Access
Read-only
Since
3.3.0

View source

field

Type
craft\fields\Matrix
Default value
null
Access
Read-only
Since
3.3.0

View source

fieldContext

Type
string
Default value
null
Access
Read-only
Since
3.3.0

View source

fieldId

Type
integer, null
Default value
null

Field ID

View source

fieldLayout

Type
craft\models\FieldLayout
Default value
null
Access
Read-only

View source

fieldLayoutId

Type
integer, null
Default value
null

Field layout ID

View source

handle

Type
string, null
Default value
null

Handle

View source

hasFieldErrors

Type
boolean
Default value
false

View source

id

Type
integer, string, null
Default value
null

ID The block ID. If unsaved, it will be in the format "newX".

View source

isNew

Type
boolean
Default value
null

Whether this is a new block type

View source

name

Type
string, null
Default value
null

Name

View source

sortOrder

Type
integer, null
Default value
null

Sort order

View source

uid

Type
string, null
Default value
null

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__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 block type handle 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.
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.
getConfig()Returns the block type’s config.
getEagerLoadingPrefix()Get the eager loading prefix for all subfields in this fragment.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getField()Returns the block type's field.
getFieldContext()Get the field context for all subfields in this fragment.
getFieldLayout()Returns the field layout defined by this component.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getIsNew()Returns whether this is a new block type.
getIterator()Returns an iterator for traversing the attributes in the model.
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.

__toString()

Use the block type handle as the string representation.

View source

Returns

string

getConfig()

Since
3.5.0

Returns the block type’s config.

View source

Returns

array

getEagerLoadingPrefix()

Since
3.3.0

Get the eager loading prefix for all subfields in this fragment.

View source

Returns

string

getField()

Since
3.3.0

Returns the block type's field.

View source

Returns

craft\fields\Matrix

Throws

getFieldContext()

Since
3.3.0

Get the field context for all subfields in this fragment.

View source

Returns

string

getFieldLayout()

Returns the field layout defined by this component.

View source

Returns

craft\models\FieldLayout

getIsNew()

Returns whether this is a new block type.

View source

Returns

boolean

Protected Methods

MethodDescription
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().

defineBehaviors()

Since
4.0.0

Returns the behaviors to attach to this class.

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

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

View source

Returns

array

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

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.