EntryDraft

Type: Class
Namespace: craft\models
Inherits: craft\models\EntryDraft » craft\models\BaseEntryRevisionModel » 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
Since: 3.0

Class EntryDraft model.

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
ancestors	craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
archived	boolean – Whether the element is archived
attributes	array – Attribute values (name => value).
author	craft\elements\User, null
authorId	integer, null – Author ID
awaitingFieldValues	boolean – Whether the element is still awaiting its custom field values
behaviors	yii\base\Behavior – List of behaviors attached to this component
children	craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
contentFromRevision	array
contentId	integer, null – The element’s content row ID
contentTable	string
cpEditUrl	string, null
creator	craft\elements\User, null
creatorId	integer, null – The revision creator’s user ID
dateCreated	DateTime, null – The date that the element was created
dateUpdated	DateTime, null – The date that the element was last updated
descendants	craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
draftId	integer, null – Draft ID
duplicateOf	craft\base\ElementInterface, null – The element that this element is being duplicated by.
editorHtml	string – The HTML for the editor HUD
enabled	boolean – Whether the element is enabled
enabledForSite	boolean – Whether the element is enabled for this site.
errors	array – Errors for all attributes or the specified attribute.
expiryDate	DateTime, null – Expiry date
fieldColumnPrefix	string
fieldContext	string
fieldLayout	craft\models\FieldLayout, null
fieldLayoutId	integer, null – The element’s field layout ID
fieldParamNamespace	string, null – The field param namespace
fieldValues	array – The field values (handle => value)
firstErrors	array – The first errors.
hasDescendants	boolean
hasFreshContent	boolean – Whether the element’s content is fresh
id	integer, null – The element’s ID
isEditable	boolean
iterator	ArrayIterator – An iterator for traversing the items in the list.
level	integer, null – The element’s level within its structure
lft	integer, null – The element’s left position within its structure
link	`\Twig\Markup`, null
name	string, null – Name
next	craft\base\ElementInterface, null
nextSibling	craft\base\ElementInterface, null
parent	craft\base\ElementInterface, null
postDate	DateTime, null – Post date
prev	craft\base\ElementInterface, null
prevSibling	craft\base\ElementInterface, null
propagating	boolean – Whether the element is being saved in the context of propagating another site's version of the element.
ref	string, null
resaving	boolean – Whether the element is being resaved by a ResaveElement job or a `resave` console command.
rgt	integer, null – The element’s right position within its structure
root	integer, null – The element’s structure’s root ID
route	`mixed` – The route that the request should use, or null if no special action should be taken
scenario	string – The scenario that this model is in.
searchScore	integer, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
section	craft\models\Section
sectionId	integer, null – Section ID
serializedFieldValues	array
siblings	craft\elements\db\ElementQueryInterface, craft\base\ElementInterface[]
site	craft\models\Site
siteId	integer, null – The site ID the element is associated with
slug	string, null – The element’s slug
status	string, null
structureId	integer, null – The element’s structure ID
supportedSites	integer[], array
tempId	string, null – The element’s temporary ID (only used if the element's URI format contains {id})
title	string, null – The element’s title
totalDescendants	integer
trashed	boolean – Whether the element has been soft-deleted.
type	craft\models\EntryType
typeId	integer, null – Type ID
uid	string, null – The element’s UID
uri	string, null – The element’s URI
uriFormat	string, null
url	string, null
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

`draftId`

Type: integer, null

Draft ID

View source

`name`

Type: string, null

Name

View source

Public Methods

Method	Description
__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.
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\models\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.
getCreator()	Returns the draft's creator.
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.
getIsEditable()	Returns whether the current user can edit the element.
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.
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.
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.
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.
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.
setContentFromRevision()	Sets the revision content.
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.
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.

`__construct()`

Constructor.

The default implementation does two things:

Initializes the object with the given configuration $config.
Call init().

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

View source

Arguments

$config (array) – Name-value pairs that will be used to initialize the object properties

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

View source

Returns

array – Validation rules

Protected Methods

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

Constants

Constant	Description
`SCENARIO_DEFAULT`	The name of the default scenario.
`SCENARIO_ESSENTIALS`
`SCENARIO_LIVE`
`STATUS_ARCHIVED`
`STATUS_DISABLED`
`STATUS_ENABLED`
`STATUS_EXPIRED`
`STATUS_LIVE`
`STATUS_PENDING`

EntryDraft

# Public Properties

#draftId

#name

# Public Methods

#__construct()

Arguments

#rules()

Returns

# Protected Methods

# Constants

Public Properties

`draftId`

`name`

Public Methods

`__construct()`

`rules()`

Protected Methods

Constants