BaseEntryRevisionModel
- Type
- Class
- Namespace
- craft\models
- Inherits
- craft\models\BaseEntryRevisionModel » craft\elements\Entry » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface, craft\base\ElementInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
- Uses traits
- craft\base\ClonefixTrait, craft\base\ElementTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
- Extended by
- craft\models\EntryDraft, craft\models\EntryVersion
- Since
- 3.0.0
- Deprecated in
- in 3.2.0
Class BaseEntryRevision model.
View source (opens new window)
# Public Properties
# Protected Properties
Property | Description |
---|---|
revisionCreatorId | string (opens new window), null (opens new window) – Revision creator ID to be saved |
revisionNotes | string (opens new window), null (opens new window) – Revision notes to be saved |
# 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() (opens new window) | Sets a component property to be null. |
actions() | Returns the available element actions (opens new window) for a given source. |
activeAttributes() (opens new window) | Returns the attribute names that are subject to validation in the current scenario. |
addError() | Adds a new error to the specified attribute. |
addErrors() (opens new window) | 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() (opens new window) | This method is invoked after validation ends. |
attachBehavior() (opens new window) | Attaches a behavior to this component. |
attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
attributeHints() (opens new window) | 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() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
className() (opens new window) | Returns the fully qualified name of this class. |
clearErrors() (opens new window) | Removes errors for all attributes or a single attribute. |
createValidators() (opens new window) | Creates validator objects based on the validation rules specified in rules() (opens new window). |
datetimeAttributes() | Returns the names of any attributes that should hold DateTime (opens new window) values. |
defaultTableAttributes() | Returns the list of table attribute keys that should be shown by default. |
detachBehavior() (opens new window) | Detaches a behavior from the component. |
detachBehaviors() (opens new window) | 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() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
exporters() | Returns the available export options for a given source. |
extraFields() (opens new window) | Returns the list of fields that can be expanded further and returned by toArray() (opens new window). |
fieldLayouts() | Returns all of the field layouts associated with elements from the given source. |
fields() (opens new window) | Returns the list of fields that should be returned by default by toArray() (opens new window) 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. |
findSource() | Returns a source definition by a given source key/path and context. |
formName() (opens new window) | Returns the form name that this model class should use. |
generateAttributeLabel() (opens new window) | Generates a user friendly attribute label based on the give attribute name. |
getActiveValidators() (opens new window) | Returns the validators applicable to the current scenario (opens new window). |
getAncestors() | Returns the element’s ancestors. |
getAttributeHint() (opens new window) | Returns the text hint for the specified attribute. |
getAttributeLabel() | Returns the text label for the specified attribute. |
getAttributeStatus() | Returns the status of a given attribute. |
getAttributes() (opens new window) | Returns attribute values. |
getAuthor() | Returns the entry's author. |
getAvailableEntryTypes() | Returns the available entry types for the entry. |
getBehavior() (opens new window) | Returns the named behavior object. |
getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
getCacheTags() | Returns the cache tags that should be cleared when this element is saved. |
getCanonical() | Returns the canonical version of the element. |
getCanonicalId() | Returns the element’s canonical ID. |
getCanonicalUid() | Returns the element’s canonical UUID. |
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 edit URL in the control panel. |
getCurrentRevision() | Returns the element’s current revision, if one exists. |
getDescendants() | Returns the element’s descendants. |
getDirtyAttributes() | Returns a list of attribute names that have changed since the element was first loaded. |
getDirtyFields() | Returns a list of custom field handles that have changed since the element was first loaded. |
getEagerLoadedElementCount() | Returns the count of eager-loaded elements for a given handle. |
getEagerLoadedElements() | Returns the eager-loaded elements for a given handle. |
getEditorHtml() | Returns the HTML for the element’s editor slideout. |
getEnabledForSite() | Returns whether the element is enabled for the current site. |
getError() | Returns the first error of the specified attribute. |
getErrorSummary() (opens new window) | Returns the errors for all attributes as a one-dimensional array. |
getErrors() (opens new window) | 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. |
getFieldStatus() | Returns the status of a given field. |
getFieldValue() | Returns the value for a given field. |
getFieldValues() | Returns the element’s normalized custom field values, indexed by their handles. |
getFirstError() (opens new window) | Returns the first error of the specified attribute. |
getFirstErrors() (opens new window) | Returns the first error of every attribute in the model. |
getGqlTypeName() | Returns the GraphQL type name for this element type. |
getHasCheckeredThumb() | Returns whether the element’s thumbnail should have a checkered background. |
getHasDescendants() | Returns whether the element has descendants. |
getHasFreshContent() | Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors). |
getHasRoundedThumb() | Returns whether the element’s thumbnail should be rounded. |
getHtmlAttributes() | Returns any attributes that should be included in the element’s DOM representation in the control panel. |
getId() | |
getIsCanonical() | Returns whether this is the canonical element. |
getIsDeletable() | Returns whether the current user can delete the element. |
getIsDerivative() | Returns whether this is a derivative element, such as a draft or revision. |
getIsDraft() | Returns whether this is a draft. |
getIsEditable() | Returns whether the current user can edit the element. |
getIsFresh() | Returns whether the element is "fresh" (not yet explicitly saved, and without validation errors). |
getIsHomepage() | Returns whether this element represents the site homepage. |
getIsProvisionalDraft() | Returns whether this is a provisional draft. |
getIsRevision() | Returns whether this is a revision. |
getIsTitleTranslatable() | Returns whether the Title field should be shown as translatable in the UI. |
getIsUnpublishedDraft() | Returns whether the element is an unpublished draft. |
getIsUnsavedDraft() | Returns whether the element is an unpublished draft. |
getIterator() (opens new window) | Returns an iterator for traversing the attributes in the model. |
getLanguage() | Returns the language of the element. |
getLink() | Returns an anchor pre-filled with this element’s URL and title. |
getLocalized() | Returns the same element in other locales. |
getMetadata() | Returns element metadata that can be shown on its edit page or within element editor slideouts. |
getModifiedAttributes() | Returns the attribute names that have changed for this element. |
getModifiedFields() | Returns the field handles that have changed for this element. |
getNext() | Returns the next element relative to this one, from a given set of criteria. |
getNextSibling() | Returns the element’s next sibling. |
getOutdatedAttributes() | Returns the attribute names that have been updated on the canonical element since the last time it was merged into this element. |
getOutdatedFields() | Returns the field handles that have been updated on the canonical element since the last time it was merged into this element. |
getParent() | Returns the element’s parent. |
getParentUri() | Returns the parent element’s URI, if there is one. |
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() (opens new window) | 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. |
getSidebarHtml() | Returns the HTML for any fields/info that should be shown within the sidebar of element editor slideouts. |
getSite() | Returns the site the element is associated with. |
getSourceId() | Returns the element’s canonical ID. |
getSourceUid() | Returns the element’s canonical UID. |
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. |
getTitleTranslationDescription() | Returns the description of the Title field’s translation support. |
getTitleTranslationKey() | Returns the Title’s translation key. |
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() (opens new window) | Returns all the validators declared in rules() (opens new window). |
gqlMutationNameByContext() | Returns the GraphQL mutation name by an element's context. |
gqlScopesByContext() | Returns the GraphQL scopes required by element's context. |
gqlTypeNameByContext() | Returns the GraphQL type name by an element's context. |
hasContent() | Returns whether elements of this type will be storing any data in the content table (titles 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() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
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. |
indexElementCount() | Returns the total number of elements that will be shown on an element index, for the given element query. |
indexHtml() | Returns the element index HTML. |
init() | Initializes the object. |
instance() (opens new window) | Returns static class instance, which can be used to obtain meta information. |
isAncestorOf() | Returns whether this element is an ancestor of another one. |
isAttributeActive() (opens new window) | Returns a value indicating whether the attribute is active in the current scenario. |
isAttributeDirty() | Returns whether an attribute has changed since the element was first loaded. |
isAttributeModified() | Returns whether an attribute value has changed for this element. |
isAttributeOutdated() | Returns whether an attribute value has fallen behind the canonical element’s value. |
isAttributeRequired() (opens new window) | Returns a value indicating whether the attribute is required. |
isAttributeSafe() (opens new window) | 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. |
isFieldDirty() | Returns whether a custom field value has changed since the element was first loaded. |
isFieldEmpty() | Returns whether a field is empty. |
isFieldModified() | Returns whether a field value has changed for this element. |
isFieldOutdated() | Returns whether a field value has fallen behind the canonical element’s value. |
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. |
isSelectable() | Returns whether the component should be selectable in component Type selects. |
isSiblingOf() | Returns whether this element is a sibling of another one. |
load() (opens new window) | Populates the model with input data. |
loadMultiple() (opens new window) | Populates a set of models with the data from end user. |
lowerDisplayName() | Returns the lowercase version of displayName(). |
markAsClean() | Resets the record of dirty attributes and fields. |
markAsDirty() | Marks all fields and attributes as dirty. |
mergeCanonicalChanges() | Merges changes from the canonical element into this one. |
metaFieldsHtml() | Returns the HTML for any meta fields that should be shown within the sidebar of element editor slideouts. Or if the element doesn’t have a field layout, they’ll be shown in the main body of the slideout. |
off() (opens new window) | Detaches an existing event handler from this component. |
offsetExists() | Returns whether there is an element at the specified offset. |
offsetGet() (opens new window) | Returns the element at the specified offset. |
offsetSet() (opens new window) | Sets the element at the specified offset. |
offsetUnset() (opens new window) | Sets the element value at the specified offset to null. |
on() (opens new window) | Attaches an event handler to an event. |
onUnsafeAttribute() (opens new window) | This method is invoked when an unsafe attribute is being massively assigned. |
pluralDisplayName() | Returns the plural version of displayName(). |
pluralLowerDisplayName() | Returns the plural, lowercase 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() (opens new window) | Returns the attribute names that are safe to be massively assigned in the current scenario. |
scenarios() (opens new window) | Returns a list of scenarios and the corresponding active attributes. |
searchableAttributes() | Defines which element attributes should be searchable. |
setAttributes() (opens new window) | Sets the attribute values in a massive way. |
setAuthor() | Sets the entry's author. |
setCanonical() | Sets the canonical version of the element. |
setCanonicalId() | Sets the element’s canonical ID. |
setDirtyAttributes() | Sets the list of dirty attribute names. |
setEagerLoadedElementCount() | Sets the count of eager-loaded elements for a given handle. |
setEagerLoadedElements() | Sets some eager-loaded elements on a given handle. |
setEnabledForSite() | Sets whether the element is enabled for the current site. |
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. |
setIsFresh() | Sets whether the element is "fresh" (not yet explicitly saved, and without validation errors). |
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() (opens new window) | Sets the scenario for the model. |
setUiLabel() | Defines what the element should be called within the control panel. |
sortOptions() | Returns the sort options for the element type. |
sourcePath() | Returns the source path for a given source key, step key, and context. |
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() (opens new window) | Converts the model into an array. |
trackChanges() | Returns whether Craft should keep track of attribute and custom field changes made to this element type, including when the last time they were changed, and who was logged-in at the time. |
trigger() (opens new window) | Triggers an event. |
updateTitle() | Updates the entry's title, if its entry type has a dynamic title format. |
validate() (opens new window) | 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() (opens new window) | Validates multiple models. |
# Protected Methods
Method | Description |
---|---|
cpEditUrl() | Returns the element’s edit URL in the control panel. |
defineActions() | Defines the available element actions for a given source. |
defineDefaultTableAttributes() | Returns the list of table attribute keys that should be shown by default. |
defineExporters() | Defines the available element exporters for a given source. |
defineFieldLayouts() | Defines the field layouts associated with elements for a given source. |
defineRules() | Returns the validation rules for attributes. |
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() (opens new window) | 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() (opens new window) | 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. |
hasFieldLayout() | Returns whether the element has a field layout with at least one tab. |
htmlAttributes() | Returns any attributes that should be included in the element’s DOM representation in the control panel. |
indexElements() | Returns the resulting elements for an element index. |
isDeletable() | Returns whether the current user can delete the element. |
isEditable() | Returns whether the current user can edit the element. |
metadata() | Returns element metadata that can be shown on its edit page or within element editor slideouts. |
normalizeFieldValue() | Normalizes a field’s value. |
prepElementQueryForTableAttribute() | Prepares an element query for an element index that includes a given table attribute. |
previewTargets() | Returns the additional locations that should be available for previewing the element, besides its primary URL. |
resolveFields() (opens new window) | Determines which fields can be returned by toArray() (opens new window). |
route() | Returns the route that should be used when the element’s URI is requested. |
searchKeywords() | Returns the search keywords for a given search attribute. |
slugFieldHtml() | Returns the HTML for the element’s Slug field. |
tableAttributeHtml() | Returns the HTML that should be shown for a given attribute in Table View. |
uiLabel() | Returns what the element should be called within the control panel. |
# Constants
Constant | Description |
---|---|
ATTR_STATUS_CONFLICTED | |
ATTR_STATUS_MODIFIED | |
ATTR_STATUS_OUTDATED | |
HOMEPAGE_URI | |
SCENARIO_DEFAULT | The name of the default scenario. |
SCENARIO_ESSENTIALS | |
SCENARIO_LIVE | |
STATUS_ARCHIVED | |
STATUS_DISABLED | |
STATUS_ENABLED | |
STATUS_EXPIRED | |
STATUS_LIVE | |
STATUS_PENDING |