Tag ​
- Type
- Class
- Namespace
- craft\elements
- Inherits
- craft\elements\Tag » 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.0
Tag represents a tag element.
Public Properties ​
Property | Description |
---|---|
activeValidators | yii\validators\Validator – The validators applicable to the current scenario. |
ancestors | craft\elements\db\ElementQueryInterface – The element’s ancestors |
archived | boolean – Whether the element is archived |
attributes | array – Attribute values (name => value). |
awaitingFieldValues | boolean – Whether the element is still awaiting its custom field values |
behaviors | yii\base\Behavior – List of behaviors attached to this component. |
cacheTags | string[] |
canonical | craft\base\ElementInterface, null – The canonical element, if one exists for the current site |
canonicalId | integer, null – The element’s canonical ID |
canonicalUid | string – The element’s canonical UID |
children | craft\elements\db\ElementQueryInterface – The element’s children |
contentId | integer, null – The element’s content row ID |
contentTable | string – The name of the table this element’s content is stored in |
cpEditUrl | string, null – The element’s edit URL in the control panel |
currentRevision | static , null |
dateCreated | DateTime, null – The date that the element was created |
dateDeleted | DateTime, null – The date that the element was trashed |
dateLastMerged | DateTime, null – The date that the canonical element was last merged into this one |
dateUpdated | DateTime, null – The date that the element was last updated |
deletedWithGroup | boolean – Whether the tag was deleted along with its group |
descendants | craft\elements\db\ElementQueryInterface – The element’s descendants |
dirtyAttributes | string[] |
dirtyFields | string[] |
draftId | integer, null – The ID of the draft’s row in the drafts table |
duplicateOf | craft\base\ElementInterface, null – The element that this element is being duplicated by. |
editorHtml | string – The HTML for the element’s 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. |
fieldColumnPrefix | string – The field column prefix this element’s content uses |
fieldContext | string – The field context this element’s content uses |
fieldLayout | craft\models\FieldLayout, null – The field layout used by this element |
fieldLayoutId | integer, null – The element’s field layout ID |
fieldParamNamespace | array – The namespace used by custom field params on the request |
fieldValues | array – The element’s normalized custom field values, indexed by their handles |
firstErrors | array – The first errors. |
firstSave | boolean – Whether the element is being saved for the first time in a normal state (not as a draft or revision). |
gqlTypeName | string |
group | craft\models\TagGroup – the tag's group |
groupId | integer, null – Group ID |
hardDelete | boolean – Whether the element is being hard-deleted. |
hasCheckeredThumb | boolean |
hasDescendants | boolean – Whether the element has descendants |
hasFreshContent | boolean – Whether the element’s content is "fresh" (unsaved and without validation errors) |
hasRoundedThumb | boolean |
htmlAttributes | array – Any attributes that should be included in the element’s DOM representation in the control panel |
id | integer, null – The element’s ID |
isCanonical | boolean |
isDeletable | boolean |
isDerivative | boolean |
isDraft | boolean |
isEditable | boolean – Whether the current user can edit the element |
isFresh | boolean |
isHomepage | boolean |
isNewForSite | boolean – Whether the element is being saved to the current site for the first time. |
isProvisionalDraft | boolean – Whether this is a provisional draft. |
isRevision | boolean |
isTitleTranslatable | boolean |
isUnpublishedDraft | boolean |
isUnsavedDraft | boolean |
iterator | ArrayIterator – An iterator for traversing the items in the list. |
language | string |
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 – An anchor pre-filled with this element’s URL and title |
localized | craft\elements\db\ElementQueryInterface[], static[] |
mergingCanonicalChanges | boolean – Whether recent changes to the canonical element are being merged into this element. |
metadata | array – The data, with keys representing the labels. |
modifiedAttributes | string[] |
modifiedFields | string[] |
newSiteIds | integer[] – The site IDs that the element was just propagated to for the first time. |
next | craft\base\ElementInterface, null – The next element relative to this one, from a given set of criteria |
nextSibling | craft\base\ElementInterface, null – The element’s next sibling |
outdatedAttributes | string[] |
outdatedFields | string[] |
parent | craft\base\ElementInterface, null – The element’s parent |
parentUri | string, null |
prev | craft\base\ElementInterface, null – The previous element relative to this one, from a given set of criteria |
prevSibling | craft\base\ElementInterface, null – The element’s previous sibling |
previewTargets | array |
previewing | boolean – Whether the element is currently being previewed. |
propagateAll | boolean – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values. |
propagating | boolean – Whether the element is being saved in the context of propagating another site's version of the element. |
ref | string, null – The reference string to this element |
resaving | boolean – Whether the element is being resaved by a ResaveElement job or a resave console command. |
revisionId | integer – The ID of the revision’s row in the revisions table |
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 should be used when the element’s URI is requested |
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 |
serializedFieldValues | array – Array of the element’s serialized custom field values, indexed by their handles |
siblings | craft\elements\db\ElementQueryInterface – All of the element’s siblings |
sidebarHtml | string |
site | craft\models\Site – Site the element is associated with |
siteId | integer, null – The site ID the element is associated with |
siteSettingsId | integer, null – The ID of the element’s record in the elements_sites table |
slug | string, null – The element’s slug |
sourceId | integer, null |
sourceUid | string |
status | string, null – The element’s status |
structureId | integer, null – The element’s structure ID |
supportedSites | integer[], array – The sites this element is associated with |
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 |
titleTranslationDescription | string, null |
titleTranslationKey | string – The translation key |
totalDescendants | integer – The total number of descendants that the element has |
trashed | boolean – Whether the element has been soft-deleted. |
uiLabel | string |
uid | string, null – The element’s UID |
updatingFromDerivative | boolean – Whether the element is being updated from a derivative element, such as a draft or revision. |
uri | string, null – The element’s URI |
uriFormat | string, null – The URI format used to generate this element’s URL |
url | string, null – The element’s full URL |
validators | ArrayObject, yii\validators\Validator – All the validators declared in the model. |
cacheTags
​
- Type
- string[]
- Default value
null
- Access
- Read-only
- Since
- 3.5.0
deletedWithGroup
​
- Type
- boolean
- Default value
false
Whether the tag was deleted along with its group
See also beforeDelete()
gqlTypeName
​
- Type
- string
- Default value
null
- Access
- Read-only
- Since
- 3.3.0
group
​
- Type
- craft\models\TagGroup
- Default value
null
the tag's group
groupId
​
Group ID
Protected Properties ​
Property | Description |
---|---|
revisionCreatorId | string, null – Revision creator ID to be saved |
revisionNotes | string, null – 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() | Sets a component property to be null. |
actions() | Returns the available element actions for a given source. |
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. |
exporters() | Returns the available export options for a given source. |
extraFields() | Returns the list of fields that can be expanded further and returned by toArray(). |
fieldLayouts() | Returns all of the field layouts associated with elements from the given source. |
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. |
findSource() | Returns a source definition by a given source key/path and context. |
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. |
getAttributeStatus() | Returns the status of a given attribute. |
getAttributes() | Returns attribute values. |
getBehavior() | Returns the named behavior object. |
getBehaviors() | 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() | 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. |
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() | Returns the first error of the specified attribute. |
getFirstErrors() | Returns the first error of every attribute in the model. |
getGqlTypeName() | Returns the GraphQL type name for this element type. |
getGroup() | Returns the tag's group. |
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() | 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() | Returns the scenario that this model is used in. |
getSearchKeywords() | Returns the search keywords for a given search attribute. |
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. |
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(). |
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() | 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. |
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() | 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. |
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() | 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. |
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() | Populates the model with input data. |
loadMultiple() | 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. |
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(). |
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() | 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. |
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() | 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() | 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() | Triggers an event. |
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. |
validateTitle() | Validates the tag title. |
afterSave()
​
Performs actions after an element is saved.
Arguments ​
$isNew
(boolean) – Whether the element is brand new
Throws ​
- yii\base\Exception
if reasons
beforeDelete()
​
Performs actions before an element is deleted.
Returns ​
boolean – Whether the element should be deleted
displayName()
​
Returns the display name of this class.
Returns ​
string – The display name of this class.
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).
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);
}
}
Returns ​
craft\elements\db\TagQuery – The newly created craft\elements\db\TagQuery instance.
getCacheTags()
​
- Since
- 3.5.0
Returns the cache tags that should be cleared when this element is saved.
Returns ​
string[]
getFieldLayout()
​
Returns the field layout used by this element.
Returns ​
craft\models\FieldLayout, null
getGqlTypeName()
​
- Since
- 3.3.0
Returns the GraphQL type name for this element type.
Returns ​
getGroup()
​
Returns the tag's group.
Returns ​
Throws ​
- yii\base\InvalidConfigException
if groupId is missing or invalid
gqlMutationNameByContext()
​
- Since
- 3.5.0
Returns the GraphQL mutation name by an element's context.
Arguments ​
$context
(mixed
) – The element's context, such as a volume, entry type, or Matrix block type.
Returns ​
gqlScopesByContext()
​
- Since
- 3.3.0
Returns the GraphQL scopes required by element's context.
Arguments ​
$context
(mixed
) – The element's context, such as a volume, entry type or Matrix block type.
Returns ​
gqlTypeNameByContext()
​
- Since
- 3.3.0
Returns the GraphQL type name by an element's context.
Arguments ​
$context
(mixed
) – The element's context, such as a volume, entry type or Matrix block type.
Returns ​
hasContent()
​
Returns whether elements of this type will be storing any data in the content
table (titles or custom fields).
Returns ​
boolean – Whether elements of this type will be storing any data in the content
table.
hasTitles()
​
Returns whether elements of this type have traditional titles.
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.
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.
Returns ​
boolean – Whether elements of this type store data on a per-site basis.
lowerDisplayName()
​
- Since
- 3.3.17
Returns the lowercase version of displayName().
Returns ​
pluralDisplayName()
​
- Since
- 3.2.0
Returns the plural version of displayName().
Returns ​
pluralLowerDisplayName()
​
- Since
- 3.3.17
Returns the plural, lowercase version of displayName().
Returns ​
refHandle()
​
Returns the handle that should be used to refer to this element type from reference tags.
Returns ​
string, null – The reference handle, or null if the element type doesn’t support reference tags
validateTitle()
​
- Since
- 3.4.12
Validates the tag title.
Arguments ​
$attribute
(string)$params
(array, null)$validator
(yii\validators\InlineValidator)
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() | 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. |
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. |
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. |
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() | Determines which fields can be returned by toArray(). |
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. |
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.
Returns ​
defineSources()
​
Defines the sources that elements of this type may belong to.
Arguments ​
Returns ​
array – The sources.
isEditable()
​
- Since
- 3.7.0
Returns whether the current user can edit the element.
Returns ​
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 |