Skip to content

EntryType

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

EntryType model class.

View source

Public Properties

PropertyDescription
actionMenuItemsarray
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.
color\craft\enums\Color, null – Color
configarray
cpEditUrlstring, null
eagerLoadingPrefixstring
errorsarray – Errors for all attributes or the specified attribute.
fieldContextstring
fieldLayoutcraft\models\FieldLayout
fieldLayoutIdinteger, null – Field layout ID
firstErrorsarray – The first errors.
handlestring, null – Handle
hasTitleFieldboolean – Has title field
iconstring, null – Icon
idinteger, null – ID
iteratorArrayIterator – An iterator for traversing the items in the list.
namestring, null – Name
scenariostring – The scenario that this model is in.
showSlugFieldboolean – Whether to show the Slug field
showStatusFieldboolean – Whether to show the Status field
slugTranslationKeyFormatstring, null – Slug translation key format
slugTranslationMethodstring – Slug translation method
titleFormatstring, null – Title format
titleTranslationKeyFormatstring, null – Title translation key format
titleTranslationMethodstring – Title translation method
uiLabelstring
uidstring, null – UID
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

actionMenuItems

Type
array
Default value
null
Access
Read-only

View source

color

Type
\craft\enums\Color, null
Default value
null
Since
5.0.0

Color

View source

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

eagerLoadingPrefix

Type
string
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

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

hasTitleField

Type
boolean
Default value
true

Has title field

View source

icon

Type
string, null
Default value
null
Since
5.0.0

Icon

View source

id

Type
integer, null
Default value
null

ID

View source

name

Type
string, null
Default value
null

Name

View source

showSlugField

Type
boolean
Default value
true
Since
5.0.0

Whether to show the Slug field

View source

showStatusField

Type
boolean
Default value
true
Since
4.5.0

Whether to show the Status field

View source

slugTranslationKeyFormat

Type
string, null
Default value
null
Since
4.5.0

Slug translation key format

View source

slugTranslationMethod

Type
string
Default value
\craft\base\Field::TRANSLATION_METHOD_SITE
Since
4.5.0

Slug translation method

View source

titleFormat

Type
string, null
Default value
null

Title format

View source

titleTranslationKeyFormat

Type
string, null
Default value
null
Since
3.5.0

Title translation key format

View source

titleTranslationMethod

Type
string
Default value
\craft\base\Field::TRANSLATION_METHOD_SITE
Since
3.5.0

Title translation method

View source

uiLabel

Type
string
Default value
null
Access
Read-only

View source

uid

Type
string, null
Default value
null

UID

View source

Public Methods

MethodDescription
__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 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.
findUsages()Returns an array of sections and custom fields that make use of this entry type.
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.
getActionMenuItems()Returns action menu items for the component.
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.
getColor()Returns the HTML for the component’s thumbnail, if it has one.
getConfig()Returns the entry type’s config.
getCpEditUrl()Returns the URL to the component’s edit page in the control panel.
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.
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.
getHandle()Returns the provider’s handle, which could be used to identify custom fields with ambiguous handles.
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.
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.
setScenario()Sets the scenario for the model.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateFieldLayout()Validates the field layout.
validateMultiple()Validates multiple models.

__toString()

Use the handle as the string representation.

View source

Returns

string

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)

findUsages()

Since
5.0.0

Returns an array of sections and custom fields that make use of this entry type.

View source

Returns

(\craft\models\Section|\craft\base\ElementContainerFieldInterface)[]

get()

Returns a component by its ID.

View source

Arguments

Returns

static, null

getActionMenuItems()

Returns action menu items for the component.

See craft\helpers\Cp::disclosureMenu() for documentation on supported item properties.

View source

Returns

array

getColor()

Returns the HTML for the component’s thumbnail, if it has one.

View source

Returns

\craft\enums\Color, null

getConfig()

Since
3.5.0

Returns the entry type’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

getEagerLoadingPrefix()

Since
3.3.0

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

View source

Returns

string

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

getHandle()

Since
5.0.0

Returns the provider’s handle, which could be used to identify custom fields with ambiguous handles.

View source

Returns

string, null

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

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

validateFieldLayout()

Since
3.7.0

Validates the field layout.

View source

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.