Entry

Type
Class
Namespace
craft\elements
Inherits
craft\elements\Entry » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ElementInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\ElementTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Extended by
craft\models\BaseEntryRevisionModel, craft\models\EntryDraft, craft\models\EntryVersion
Since
3.0

Entry represents an entry element.

View source

Public Properties

PropertyDescription
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
ancestorscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
archivedboolean – Whether the element is archived
attributesarray – Attribute values (name => value).
authorcraft\elements\User, null
authorIdinteger, null – Author ID
awaitingFieldValuesboolean – Whether the element is still awaiting its custom field values
behaviorsyii\base\Behavior – List of behaviors attached to this component
childrencraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
contentIdinteger, null – The element’s content row ID
contentTablestring
cpEditUrlstring, null
currentRevisioncraft\base\ElementInterface, null
dateCreatedDateTime, null – The date that the element was created
dateDeletedDateTime, null – The date that the element was trashed
dateUpdatedDateTime, null – The date that the element was last updated
descendantscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
draftIdinteger, null – The ID of the draft’s row in the drafts table
duplicateOfcraft\base\ElementInterface, null – The element that this element is being duplicated by.
editorHtmlstring – The HTML for the editor HUD
enabledboolean – Whether the element is enabled
enabledForSiteboolean – Whether the element is enabled for this site.
errorsarray – Errors for all attributes or the specified attribute.
expiryDateDateTime, null – Expiry date
fieldColumnPrefixstring
fieldContextstring
fieldLayoutcraft\models\FieldLayout, null
fieldLayoutIdinteger, null – The element’s field layout ID
fieldParamNamespacestring, null – The field param namespace
fieldValuesarray – The field values (handle => value)
firstErrorsarray – The first errors.
hardDeleteboolean – Whether the element is being hard-deleted.
hasDescendantsboolean
hasFreshContentboolean – Whether the element’s content is fresh
idinteger, null – The element’s ID
isDraftboolean
isEditableboolean
isRevisionboolean
isUnsavedDraftboolean
iteratorArrayIterator – An iterator for traversing the items in the list.
levelinteger, null – The element’s level within its structure
lftinteger, null – The element’s left position within its structure
link\Twig\Markup, null
newSiteIdsinteger[] – The site IDs that the element was just propagated to for the first time.
nextcraft\base\ElementInterface, null
nextSiblingcraft\base\ElementInterface, null
parentcraft\base\ElementInterface, null
postDateDateTime, null – Post date
prevcraft\base\ElementInterface, null
prevSiblingcraft\base\ElementInterface, null
previewTargetsarray
previewingboolean – Whether the element is currently being previewed.
propagateAllboolean – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagatingboolean – Whether the element is being saved in the context of propagating another site's version of the element.
refstring, null
resavingboolean – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionIdinteger – The ID of the revision’s row in the revisions table
rgtinteger, null – The element’s right position within its structure
rootinteger, null – The element’s structure’s root ID
routemixed – The route that the request should use, or null if no special action should be taken
scenariostring – The scenario that this model is in.
searchScoreinteger, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
sectioncraft\models\Section
sectionIdinteger, null – Section ID
serializedFieldValuesarray
siblingscraft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
sitecraft\models\Site
siteIdinteger, null – The site ID the element is associated with
slugstring, null – The element’s slug
sourcecraft\base\ElementInterface
sourceIdinteger, null
sourceUidstring
statusstring, null
structureIdinteger, null – The element’s structure ID
supportedSitesinteger[], array
tempIdstring, null – The element’s temporary ID (only used if the element's URI format contains {id})
titlestring, null – The element’s title
totalDescendantsinteger
trashedboolean – Whether the element has been soft-deleted.
typecraft\models\EntryType
typeIdinteger, null – Type ID
uiLabelstring
uidstring, null – The element’s UID
uristring, null – The element’s URI
uriFormatstring, null
urlstring, null
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

author

Type
craft\elements\User, null
Access
Read-only

View source

authorId

Type
integer, null

Author ID

View source

Example

cpEditUrl

Type
string, null
Access
Read-only

View source

editorHtml

Type
string
Access
Read-only

The HTML for the editor HUD

View source

expiryDate

Type
DateTime, null

Expiry date

View source

Example

fieldLayout

Type
craft\models\FieldLayout, null
Access
Read-only

View source

isEditable

Type
boolean
Access
Read-only

View source

postDate

Example

ref

Type
string, null
Access
Read-only

View source

section

Type
craft\models\Section
Access
Read-only

View source

sectionId

Type
integer, null

Section ID

View source

Example

status

Type
string, null
Access
Read-only

View source

supportedSites

Type
integer[], array
Access
Read-only

View source

type

Type
craft\models\EntryType
Access
Read-only

View source

typeId

Example

uriFormat

Type
string, null
Access
Read-only

View source

Protected Properties

PropertyDescription
revisionCreatorIdstring, null – Revision creator ID to be saved
revisionNotesstring, null – Revision notes to be saved

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()Constructor.
__get()Returns the value of a component property.
__isset()Checks if a property is set.
__set()Sets the value of a component property.
__toString()Returns the string representation of the element.
__unset()Sets an object property to null.
actions()Returns the available element actions for a given source (if one is provided).
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.
afterDelete()Performs actions after an element is deleted.
afterMoveInStructure()Performs actions after an element is moved within a structure.
afterPropagate()Performs actions after an element is fully saved and propagated to other sites.
afterRestore()Performs actions after an element is restored.
afterSave()Performs actions after an element is saved.
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.
beforeDelete()Performs actions before an element is deleted.
beforeMoveInStructure()Performs actions before an element is moved within a structure.
beforeRestore()Performs actions before an element is restored.
beforeSave()Performs actions before an element is saved.
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.
defaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
displayName()Returns the display name of this class.
eagerLoadingMap()Returns an array that maps source-to-target element IDs based on the given sub-property handle.
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.
find()Creates an craft\elements\db\ElementQueryInterface instance for query purpose.
findAll()Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findOne()Returns a single element instance by a primary key or a set of element criteria parameters.
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.
getAncestors()Returns the element’s ancestors.
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributes()Returns attribute values.
getAuthor()Returns the entry's author.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getChildren()Returns the element’s children.
getContentTable()Returns the name of the table this element’s content is stored in.
getCpEditUrl()Returns the element’s CP edit URL.
getCurrentRevision()Returns the element’s current revision, if one exists.
getDescendants()Returns the element’s descendants.
getEagerLoadedElements()Returns the eager-loaded elements for a given handle.
getEditorHtml()Returns the HTML for the element’s editor HUD.
getError()Returns the first error of the specified attribute.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getFieldColumnPrefix()Returns the field column prefix this element’s content uses.
getFieldContext()Returns the field context this element’s content uses.
getFieldLayout()Returns the field layout used by this element.
getFieldParamNamespace()Returns the namespace used by custom field params on the request.
getFieldValue()Returns the value for a given field.
getFieldValues()Returns the element’s normalized custom field values, indexed by their handles.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getHasDescendants()Returns whether the element has descendants.
getHasFreshContent()Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getHtmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the Control Panel.
getId()Returns the element’s ID.
getIsDraft()Returns whether this is a draft.
getIsEditable()Returns whether the current user can edit the element.
getIsRevision()Returns whether this is a revision.
getIsUnsavedDraft()Returns whether the element is an unsaved draft.
getIterator()Returns an iterator for traversing the attributes in the model.
getLink()Returns an anchor pre-filled with this element’s URL and title.
getNext()Returns the next element relative to this one, from a given set of criteria.
getNextSibling()Returns the element’s next sibling.
getParent()Returns the element’s parent.
getPrev()Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling()Returns the element’s previous sibling.
getPreviewTargets()Returns the additional locations that should be available for previewing the element, besides its primary URL.
getRef()Returns the reference string to this element.
getRoute()Returns the route that should be used when the element’s URI is requested.
getScenario()Returns the scenario that this model is used in.
getSearchKeywords()Returns the search keywords for a given search attribute.
getSection()Returns the entry's section.
getSerializedFieldValues()Returns an array of the element’s serialized custom field values, indexed by their handles.
getSiblings()Returns all of the element’s siblings.
getSite()Returns the site the element is associated with.
getSource()Returns the element, or if it’s a draft/revision, the source element.
getSourceId()Returns the element’s ID, or if it’s a draft/revision, its source element’s ID.
getSourceUid()Returns the element’s UUID, or if it’s a draft/revision, its source element’s UUID.
getStatus()Returns the element’s status.
getSupportedSites()Returns the sites this element is associated with.
getTableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.
getThumbUrl()Returns the URL to the element’s thumbnail, if there is one.
getTotalDescendants()Returns the total number of descendants that the element has.
getType()Returns the entry type.
getUiLabel()Returns what the element should be called within the Control Panel.
getUriFormat()Returns the URI format used to generate this element’s URI.
getUrl()Returns the element’s full URL.
getValidators()Returns all the validators declared in rules().
hasContent()Returns whether elements of this type will be storing any data in the content table (tiles or custom fields).
hasEagerLoadedElements()Returns whether elements have been eager-loaded with a given handle.
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.
hasStatuses()Returns whether elements of this type have statuses.
hasTitles()Returns whether elements of this type have traditional titles.
hasUris()Returns whether elements of this type can have their own slugs and URIs.
indexHtml()Returns the element index HTML.
init()Initializes the object.
instance()Returns static class instance, which can be used to obtain meta information.
isAncestorOf()Returns whether this element is an ancestor of another one.
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.
isChildOf()Returns whether this element is a direct child of another one.
isDescendantOf()Returns whether this element is a descendant of another one.
isFieldEmpty()Returns whether a field is empty.
isLocalized()Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf()Returns whether this element is the direct next sibling of another one.
isParentOf()Returns whether this element is a direct parent of another one.
isPrevSiblingOf()Returns whether this element is the direct previous sibling of another one.
isSiblingOf()Returns whether this element is a sibling of another one.
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.
pluralDisplayName()Returns the plural version of displayName().
refHandle()Returns the handle that should be used to refer to this element type from reference tags.
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.
searchableAttributes()Defines which element attributes should be searchable.
setAttributes()Sets the attribute values in a massive way.
setAuthor()Sets the entry's author.
setEagerLoadedElements()Sets some eager-loaded elements on a given handle.
setFieldParamNamespace()Sets the namespace used by custom field params on the request.
setFieldValue()Sets the value for a given field.
setFieldValues()Sets the element’s custom field values.
setFieldValuesFromRequest()Sets the element’s custom field values, when the values have come from post data.
setNext()Sets the default next element.
setParent()Sets the element’s parent.
setPrev()Sets the default previous element.
setRevisionCreatorId()Sets the revision creator ID to be saved.
setRevisionNotes()Sets the revision notes to be saved.
setScenario()Sets the scenario for the model.
sortOptions()Returns the sort options for the element type.
sources()Returns the source definitions that elements of this type may belong to.
statuses()Returns all of the possible statuses that elements of this type may have.
tableAttributes()Defines all of the available columns that can be shown in table views.
toArray()Converts the model into an array.
trigger()Triggers an event.
updateTitle()Updates the entry's title, if its entry type has a dynamic title format.
validate()Performs the data validation.
validateCustomFieldAttribute()Calls a custom validation function on a custom field.
validateCustomFieldContentSize()Validates that the content size is going to fit within the field’s database column.
validateMultiple()Validates multiple models.

__clone()

View source

afterMoveInStructure()

Performs actions after an element is moved within a structure.

View source

Arguments

  • $structureId (integer) – The structure ID

afterPropagate()

Performs actions after an element is fully saved and propagated to other sites.

TIP

This will get called regardless of whether $propagate is true or false for craft\services\Elements::saveElement().

View source

Arguments

  • $isNew (boolean) – Whether the element is brand new

afterRestore()

Performs actions after an element is restored.

View source

afterSave()

Performs actions after an element is saved.

View source

Arguments

  • $isNew (boolean) – Whether the element is brand new

Throws

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)

beforeDelete()

Performs actions before an element is deleted.

View source

Returns

boolean – Whether the element should be deleted

beforeSave()

Performs actions before an element is saved.

View source

Arguments

  • $isNew (boolean) – Whether the element is brand new

Returns

boolean – Whether the element should be saved

Throws

beforeValidate()

This method is invoked before validation starts.

The default implementation raises a beforeValidate event. You may override this method to do preliminary checks before validation. Make sure the parent implementation is invoked so that the event can be raised.

View source

Returns

boolean – Whether the validation should be executed. Defaults to true. If false is returned, the validation will stop and the model is considered invalid.

datetimeAttributes()

Returns the names of any attributes that should hold DateTime values.

View source

Returns

string[]

displayName()

Returns the display name of this class.

View source

Returns

string – The display name of this class.

eagerLoadingMap()

Returns an array that maps source-to-target element IDs based on the given sub-property handle.

This method aids in the eager-loading of elements when performing an element query. The returned array should contain the following keys:

  • elementType – the fully qualified class name of the element type that should be eager-loaded
  • map – an array of element ID mappings, where each element is a sub-array with source and target keys.
  • criteria(optional) – Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements.

View source

Arguments

  • $sourceElements (craft\base\ElementInterface[]) – An array of the source elements
  • $handle (string) – The property handle used to identify which target elements should be included in the map

Returns

array, false, null – The eager-loading element ID mappings, false if no mappings exist, or null if the result should be ignored

extraFields()

Returns the list of fields that can be expanded further and returned by toArray().

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source

Returns

array – The list of expandable field names or field definitions. Please refer to fields() on the format of the return value.

find()

Creates an craft\elements\db\ElementQueryInterface instance for query purpose.

The returned craft\elements\db\ElementQueryInterface instance can be further customized by calling methods defined in craft\elements\db\ElementQueryInterface before one() or all() is called to return populated \craft\elements\ElementInterface instances. For example,

// Find the entry whose ID is 5
$entry = Entry::find()->id(5)->one();
// Find all assets and order them by their filename:
$assets = Asset::find()
    ->orderBy('filename')
    ->all();

If you want to define custom criteria parameters for your elements, you can do so by overriding this method and returning a custom query class. For example,

class Product extends Element
{
    public static function find()
    {
        // use ProductQuery instead of the default ElementQuery
        return new ProductQuery(get_called_class());
    }
}

You can also set default criteria parameters on the ElementQuery if you don’t have a need for a custom query class. For example,

class Customer extends ActiveRecord
{
    public static function find()
    {
        return parent::find()->limit(50);
    }
}

View source

Returns

craft\elements\db\EntryQuery – The newly created craft\elements\db\EntryQuery instance.

getAuthor()

Returns the entry's author.

View source

Returns

craft\elements\User, null

Throws

Example

getCpEditUrl()

Returns the element’s CP edit URL.

View source

Returns

string, null

Example

getEditorHtml()

Returns the HTML for the element’s editor HUD.

View source

Returns

string – The HTML for the editor HUD

getFieldLayout()

Returns the field layout used by this element.

View source

Returns

craft\models\FieldLayout, null

getIsEditable()

Returns whether the current user can edit the element.

View source

Returns

boolean

Example

getRef()

Returns the reference string to this element.

View source

Returns

string, null

getSection()

Returns the entry's section.

View source

Returns

craft\models\Section

Throws

Example

getStatus()

Returns the element’s status.

View source

Returns

string, null

getSupportedSites()

Returns the sites this element is associated with.

The function can either return an array of site IDs, or an array of sub-arrays, each with the keys siteId (int) and enabledByDefault (boolean).

View source

Returns

integer[], array

getType()

Returns the entry type.

View source

Returns

craft\models\EntryType

Throws

Example

getUriFormat()

Returns the URI format used to generate this element’s URI.

Note that element types that can have URIs must return true from hasUris().

View source

Returns

string, null

Throws

hasContent()

Returns whether elements of this type will be storing any data in the content table (tiles or custom fields).

View source

Returns

boolean – Whether elements of this type will be storing any data in the content table.

hasStatuses()

Returns whether elements of this type have statuses.

If this returns true, the element index template will show a Status menu by default, and your elements will get status indicator icons next to them. Use statuses() to customize which statuses the elements might have.

View source

Returns

boolean – Whether elements of this type have statuses.

hasTitles()

Returns whether elements of this type have traditional titles.

View source

Returns

boolean – Whether elements of this type have traditional titles.

hasUris()

Returns whether elements of this type can have their own slugs and URIs.

Note that individual elements must also return a URI format from getUriFormat() if they are to actually get a URI.

View source

Returns

boolean – Whether elements of this type can have their own slugs and URIs.

isLocalized()

Returns whether elements of this type store content on a per-site basis.

If this returns true, the element’s getSupportedSites() method will be responsible for defining which sites its content should be stored in.

View source

Returns

boolean – Whether elements of this type store data on a per-site basis.

pluralDisplayName()

Returns the plural version of displayName().

View source

Returns

string

refHandle()

Returns the handle that should be used to refer to this element type from reference tags.

View source

Returns

string, null – The reference handle, or null if the element type doesn’t support reference tags

rules()

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 scenarios 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\elements\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\elements\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().

View source

Returns

array – Validation rules

setAuthor()

Sets the entry's author.

View source

Arguments

setEagerLoadedElements()

Sets some eager-loaded elements on a given handle.

View source

Arguments

statuses()

Returns all of the possible statuses that elements of this type may have.

This method will be called when populating the Status menu on element indexes, for element types whose hasStatuses() method returns true. It will also be called when craft\elements\db\ElementQuery is querying for elements, to ensure that its “status” parameter is set to a valid status. It should return an array whose keys are the status values, and values are the human-facing status labels, or an array with the following keys:

  • label – The human-facing status label.
  • color – The status color (green, orange, red, yellow, pink, purple, blue, turquoise, light, grey, black, or white) You can customize the database query condition that should be applied for your custom statuses from craft\elements\db\ElementQuery::statusCondition().

View source

Returns

array

updateTitle()

Updates the entry's title, if its entry type has a dynamic title format.

View source

Protected Methods

MethodDescription
defineActions()Defines the available element actions for a given source (if one is provided).
defineDefaultTableAttributes()Returns the list of table attribute keys that should be shown by default.
defineSearchableAttributes()Defines which element attributes should be searchable.
defineSortOptions()Returns the sort options for the element type.
defineSources()Defines the sources that elements of this type may belong to.
defineTableAttributes()Defines all of the available columns that can be shown in table views.
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.
fieldByHandle()Returns the field with a given handle.
fieldLayoutFields()Returns each of this element’s fields.
findByCondition()Finds Element instance(s) by the given condition.
htmlAttributes()Returns any attributes that should be included in the element’s DOM representation in the Control Panel.
normalizeFieldValue()Normalizes a field’s value.
prepElementQueryForTableAttribute()Preps the element criteria for a given table attribute
previewTargets()Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields()Determines which fields can be returned by toArray().
route()Returns the route that should be used when the element’s URI is requested.
tableAttributeHtml()Returns the HTML that should be shown for a given attribute in Table View.

defineActions()

Defines the available element actions for a given source (if one is provided).

View source

Arguments

  • $source (string, null) – The selected source’s key, if any.

Returns

array – The available element actions.

defineDefaultTableAttributes()

Returns the list of table attribute keys that should be shown by default.

View source

Arguments

  • $source (string) – The selected source’s key

Returns

string[] – The table attributes.

defineSortOptions()

Returns the sort options for the element type.

View source

Returns

array – The attributes that elements can be sorted by

defineSources()

Defines the sources that elements of this type may belong to.

View source

Arguments

  • $context (string, null) – The context ('index' or 'modal').

Returns

array – The sources.

defineTableAttributes()

Defines all of the available columns that can be shown in table views.

View source

Returns

array – The table attributes.

prepElementQueryForTableAttribute()

Preps the element criteria for a given table attribute

View source

Arguments

previewTargets()

Returns the additional locations that should be available for previewing the element, besides its primary URL.

Each target should be represented by a sub-array with 'label' and 'url' keys.

View source

Returns

array

route()

Returns the route that should be used when the element’s URI is requested.

View source

Returns

mixed – The route that the request should use, or null if no special action should be taken

tableAttributeHtml()

Returns the HTML that should be shown for a given attribute in Table View.

View source

Arguments

  • $attribute (string) – The attribute name.

Returns

string – The HTML that should be shown for a given attribute in Table View.

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.
SCENARIO_ESSENTIALS
SCENARIO_LIVE
STATUS_ARCHIVED
STATUS_DISABLED
STATUS_ENABLED
STATUS_EXPIRED
STATUS_LIVE
STATUS_PENDING