<?php

/**

* @link https://craftcms.com/

* @copyright Copyright (c) Pixel & Tonic, Inc.

* @license https://craftcms.github.io/license/

*/

namespace craft\base;

use ArrayIterator;

use Craft;

use craft\behaviors\CustomFieldBehavior;

use craft\behaviors\DraftBehavior;

use craft\behaviors\RevisionBehavior;

use craft\cache\ElementQueryTagDependency;

use craft\controllers\ElementsController;

use craft\db\CoalesceColumnsExpression;

use craft\db\Command;

use craft\db\Connection;

use craft\db\ExcludeDescendantIdsExpression;

use craft\db\Query;

use craft\db\Table;

use craft\elements\actions\Delete;

use craft\elements\actions\DeleteActionInterface;

use craft\elements\actions\Duplicate;

use craft\elements\actions\Edit;

use craft\elements\actions\SetStatus;

use craft\elements\actions\View as ViewAction;

use craft\elements\conditions\ElementCondition;

use craft\elements\conditions\ElementConditionInterface;

use craft\elements\ContentBlock;

use craft\elements\db\EagerLoadPlan;

use craft\elements\db\ElementQuery;

use craft\elements\db\ElementQueryInterface;

use craft\elements\db\NestedElementQueryInterface;

use craft\elements\ElementCollection;

use craft\elements\Entry;

use craft\elements\exporters\Expanded;

use craft\elements\exporters\Raw;

use craft\elements\User;

use craft\enums\AttributeStatus;

use craft\enums\Color;

use craft\errors\FieldNotFoundException;

use craft\errors\InvalidFieldException;

use craft\events\AuthorizationCheckEvent;

use craft\events\DefineAltActionsEvent;

use craft\events\DefineAttributeHtmlEvent;

use craft\events\DefineAttributeKeywordsEvent;

use craft\events\DefineEagerLoadingMapEvent;

use craft\events\DefineHtmlEvent;

use craft\events\DefineMenuItemsEvent;

use craft\events\DefineMetadataEvent;

use craft\events\DefineUrlEvent;

use craft\events\DefineValueEvent;

use craft\events\ElementIndexTableAttributeEvent;

use craft\events\ElementStructureEvent;

use craft\events\ModelEvent;

use craft\events\RegisterElementActionsEvent;

use craft\events\RegisterElementCardAttributesEvent;

use craft\events\RegisterElementDefaultCardAttributesEvent;

use craft\events\RegisterElementDefaultTableAttributesEvent;

use craft\events\RegisterElementExportersEvent;

use craft\events\RegisterElementFieldLayoutsEvent;

use craft\events\RegisterElementHtmlAttributesEvent;

use craft\events\RegisterElementSearchableAttributesEvent;

use craft\events\RegisterElementSortOptionsEvent;

use craft\events\RegisterElementSourcesEvent;

use craft\events\RegisterElementTableAttributesEvent;

use craft\events\RegisterPreviewTargetsEvent;

use craft\events\RenderElementEvent;

use craft\events\SetEagerLoadedElementsEvent;

use craft\events\SetElementRouteEvent;

use craft\fieldlayoutelements\BaseField;

use craft\fieldlayoutelements\CustomField;

use craft\fields\ContentBlock as ContentBlockField;

use craft\gql\interfaces\Element as ElementGqlType;

use craft\helpers\App;

use craft\helpers\ArrayHelper;

use craft\helpers\Cp;

use craft\helpers\Db;

use craft\helpers\ElementHelper;

use craft\helpers\Html;

use craft\helpers\StringHelper;

use craft\helpers\Template;

use craft\helpers\UrlHelper;

use craft\i18n\Formatter;

use craft\models\FieldLayout;

use craft\models\Site;

use craft\validators\DateTimeValidator;

use craft\validators\ElementUriValidator;

use craft\validators\SiteIdValidator;

use craft\validators\SlugValidator;

use craft\validators\StringValidator;

use craft\web\UploadedFile;

use craft\web\View;

use DateTime;

use GraphQL\Type\Definition\Type;

use Illuminate\Support\Arr;

use Illuminate\Support\Collection;

use ReflectionClass;

use Traversable;

use Twig\Markup;

use UnitEnum;

use yii\base\ArrayableTrait;

use yii\base\Event;

use yii\base\InvalidCallException;

use yii\base\InvalidConfigException;

use yii\base\NotSupportedException;

use yii\base\UnknownPropertyException;

use yii\db\Expression;

use yii\db\ExpressionInterface;

use yii\validators\BooleanValidator;

use yii\validators\RequiredValidator;

use yii\validators\Validator;

use yii\web\Response;

/**

* Element is the base class for classes representing elements in terms of objects.

*

* @mixin CustomFieldBehavior

* @property int|null $canonicalId The element’s canonical ID

* @property-read string $canonicalUid The element’s canonical UID

* @property-read bool $isCanonical Whether this is the canonical element

* @property-read bool $isDerivative Whether this is a derivative element, such as a draft or revision

* @property ElementQueryInterface $ancestors The element’s ancestors

* @property ElementQueryInterface $children The element’s children

* @property string|null $cpEditUrl The element’s edit URL in the control panel

* @property ElementQueryInterface $descendants The element’s descendants

* @property string $editorHtml The HTML for the element’s editor HUD

* @property bool $enabledForSite Whether the element is enabled for this site

* @property string $fieldContext The field context this element’s content uses

* @property FieldLayout|null $fieldLayout The field layout used by this element

* @property array $fieldParamNamespace The namespace used by custom field params on the request

* @property array $fieldValues The element’s normalized custom field values, indexed by their handles

* @property bool $hasDescendants Whether the element has descendants

* @property array $htmlAttributes Any attributes that should be included in the element’s DOM representation in the control panel

* @property Markup|null $link An anchor pre-filled with this element’s URL and title

* @property ElementInterface|null $canonical The canonical element, if one exists for the current site

* @property ElementInterface|null $next The next element relative to this one, from a given set of criteria

* @property ElementInterface|null $nextSibling The element’s next sibling

* @property ElementInterface|null $parent The element’s parent

* @property int|null $parentId The element’s parent’s ID

* @property ElementInterface|null $prev The previous element relative to this one, from a given set of criteria

* @property ElementInterface|null $prevSibling The element’s previous sibling

* @property string|null $ref The reference string to this element

* @property mixed $route The route that should be used when the element’s URI is requested

* @property array $serializedFieldValues Array of the element’s serialized custom field values, indexed by their handles

* @property ElementQueryInterface $siblings All of the element’s siblings

* @property Site $site Site the element is associated with

* @property string|null $status The element’s status

* @property int[]|array $supportedSites The sites this element is associated with

* @property int $totalDescendants The total number of descendants that the element has

* @property string|null $uriFormat The URI format used to generate this element’s URL

* @property string|null $url The element’s full URL

* @property-write int|null $revisionCreatorId revision creator ID to be saved

* @property-write string|null $revisionNotes revision notes to be saved

* @phpstan-import-type EagerLoadingMap from ElementInterface

* @author Pixel & Tonic, Inc. <[email protected]>

* @since 3.0.0

*/

abstract class Element extends Component implements ElementInterface

{

use ElementTrait;

use ArrayableTrait {

toArray as traitToArray;

}

/**

* @since 3.3.6

*/

public const HOMEPAGE_URI = '__home__';

// Statuses

// -------------------------------------------------------------------------

public const STATUS_ENABLED = 'enabled';

public const STATUS_DISABLED = 'disabled';

public const STATUS_ARCHIVED = 'archived';

/** @since 5.0.0 */

public const STATUS_DRAFT = 'draft';

// Validation scenarios

// -------------------------------------------------------------------------

public const SCENARIO_ESSENTIALS = 'essentials';

public const SCENARIO_LIVE = 'live';

// Events

// -------------------------------------------------------------------------

/**

* @event RegisterElementSourcesEvent The event that is triggered when registering the available sources for the element type.

*/

public const EVENT_REGISTER_SOURCES = 'registerSources';

/**

* @event RegisterElementFieldLayoutsEvent The event that is triggered when registering all of the field layouts

* associated with elements from a given source.

* @see fieldLayouts()

* @since 3.5.0

*/

public const EVENT_REGISTER_FIELD_LAYOUTS = 'registerFieldLayouts';

/**

* @event RegisterElementActionsEvent The event that is triggered when registering the available bulk actions for the element type.

*/

public const EVENT_REGISTER_ACTIONS = 'registerActions';

/**

* @event RegisterElementExportersEvent The event that is triggered when registering the available exporters for the element type.

* @since 3.4.0

*/

public const EVENT_REGISTER_EXPORTERS = 'registerExporters';

/**

* @event RegisterElementSearchableAttributesEvent The event that is triggered when registering the searchable attributes for the element type.

*/

public const EVENT_REGISTER_SEARCHABLE_ATTRIBUTES = 'registerSearchableAttributes';

/**

* @event RegisterElementSortOptionsEvent The event that is triggered when registering the sort options for the element type.

*/

public const EVENT_REGISTER_SORT_OPTIONS = 'registerSortOptions';

/**

* @event RegisterElementTableAttributesEvent The event that is triggered when registering the table attributes for the element type.

*/

public const EVENT_REGISTER_TABLE_ATTRIBUTES = 'registerTableAttributes';

/**

* @event RegisterElementTableAttributesEvent The event that is triggered when registering the table attributes for the element type.

*/

public const EVENT_REGISTER_DEFAULT_TABLE_ATTRIBUTES = 'registerDefaultTableAttributes';

/**

* @event ElementIndexTableAttributeEvent The event that is triggered when preparing an element query for an element index, for each

* attribute present in the table.

*

* Paired with [[EVENT_REGISTER_TABLE_ATTRIBUTES]] and [[EVENT_DEFINE_ATTRIBUTE_HTML]], this allows optimization of queries on element indexes.

*

* ```php

* use craft\base\Element;

* use craft\elements\Entry;

* use craft\events\DefineAttributeHtmlEvent;

* use craft\events\ElementIndexTableAttributeEvent;

* use craft\events\RegisterElementTableAttributesEvent;

* use craft\helpers\Cp;

* use yii\base\Event;

*

* Event::on(

* Entry::class,

* Element::EVENT_REGISTER_TABLE_ATTRIBUTES,

* function(RegisterElementTableAttributesEvent $e) {

* $e->tableAttributes['authorExpertise'] = ['label' => 'Author Expertise'];

* }

* );

*

* Event::on(

* Entry::class,

* Element::EVENT_PREP_QUERY_FOR_TABLE_ATTRIBUTE,

* function(ElementIndexTableAttributeEvent $e) {

* $query = $e->query;

* $attr = $e->attribute;

*

* if ($attr === 'authorExpertise') {

* $query->andWith(['author.areasOfExpertiseCategoryField']);

* }

* }

* );

*

* Event::on(

* Entry::class,

* Element::EVENT_DEFINE_ATTRIBUTE_HTML,

* function(DefineAttributeHtmlEvent $e) {

* $attribute = $e->attribute;

*

* if ($attribute !== 'authorExpertise') {

* return;

* }

*

* // The field data is eager-loaded!

* $author = $e->sender->getAuthor();

* $categories = $author->areasOfExpertiseCategoryField;

*

* $e->html = Cp::elementPreviewHtml($categories);

* }

* );

* ```

*

* @since 3.7.14

*/

public const EVENT_PREP_QUERY_FOR_TABLE_ATTRIBUTE = 'prepQueryForTableAttribute';

/**

* @event RegisterElementCardAttributesEvent The event that is triggered when registering the card attributes for the element type.

* @since 5.5.0

*/

public const EVENT_REGISTER_CARD_ATTRIBUTES = 'registerCardAttributes';

/**

* @event RegisterElementCardAttributesEvent The event that is triggered when registering the card attributes for the element type.

* @since 5.5.0

*/

public const EVENT_REGISTER_DEFAULT_CARD_ATTRIBUTES = 'registerDefaultCardAttributes';

/**

* @event DefineEagerLoadingMapEvent The event that is triggered when defining an eager-loading map.

*

* ```php

* use craft\base\Element;

* use craft\base\ElementInterface;

* use craft\db\Query;

* use craft\elements\Entry;

* use craft\events\DefineEagerLoadingMapEvent;

* use yii\base\Event;

*

* // Add support for `with(['bookClub'])` to entries

* Event::on(

* Entry::class,

* Element::EVENT_DEFINE_EAGER_LOADING_MAP,

* function(DefineEagerLoadingMapEvent $event) {

* if ($event->handle === 'bookClub') {

* $bookEntryIds = array_map(fn(ElementInterface $element) => $element->id, $event->elements);

* $event->elementType = \my\plugin\BookClub::class,

* $event->map = (new Query)

* ->select(['source' => 'bookId', 'target' => 'clubId'])

* ->from('{{%bookclub_books}}')

* ->where(['bookId' => $bookEntryIds])

* ->all();

* $event->handled = true;

* }

* }

* );

* ```

*

* @since 3.1.0

*/

public const EVENT_DEFINE_EAGER_LOADING_MAP = 'defineEagerLoadingMap';

/**

* @event SetEagerLoadedElementsEvent The event that is triggered when setting eager-loaded elements.

*

* Set [[Event::$handled]] to `true` to prevent the elements from getting stored to the private

* `$_eagerLoadedElements` array.

*

* @since 3.5.0

*/

public const EVENT_SET_EAGER_LOADED_ELEMENTS = 'setEagerLoadedElements';

/**

* @event RegisterPreviewTargetsEvent The event that is triggered when registering the element’s preview targets.

* @since 3.2.0

*/

public const EVENT_REGISTER_PREVIEW_TARGETS = 'registerPreviewTargets';

/**

* @event DefineAttributeHtmlEvent The event that is triggered when defining an attribute’s HTML for table and card views.

* @see getAttributeHtml()

* @since 5.0.0

*/

public const EVENT_DEFINE_ATTRIBUTE_HTML = 'defineAttributeHtml';

/**

* @event DefineAttributeHtmlEvent The event that is triggered when defining an attribute’s inline input HTML.

* @see getInlineAttributeInputHtml()

* @since 5.0.0

*/

public const EVENT_DEFINE_INLINE_ATTRIBUTE_INPUT_HTML = 'defineInlineAttributeInputHtml';

/**

* @event RegisterElementHtmlAttributesEvent The event that is triggered when registering the HTML attributes that should be included in the element’s DOM representation in the control panel.

*/

public const EVENT_REGISTER_HTML_ATTRIBUTES = 'registerHtmlAttributes';

/**

* @event DefineHtmlEvent The event that is triggered when defining additional buttons that should be shown at the top of the element’s edit page.

* @see getAdditionalButtons()

* @since 4.0.0

*/

public const EVENT_DEFINE_ADDITIONAL_BUTTONS = 'defineAdditionalButtons';

/**

* @event DefineAltActionsEvent The event that is triggered when defining alternative form actions for the element.

* @see getAltActions()

* @since 5.6.0

*/

public const EVENT_DEFINE_ALT_ACTIONS = 'defineAltActions';

/**

* @event DefineMenuItemsEvent The event that is triggered when defining action menu items..

* @see getActionMenuItems()

* @since 5.0.0

*/

public const EVENT_DEFINE_ACTION_MENU_ITEMS = 'defineActionMenuItems';

/**

* @event DefineHtmlEvent The event that is triggered when defining the HTML for the editor sidebar.

* @see getSidebarHtml()

* @since 3.7.0

*/

public const EVENT_DEFINE_SIDEBAR_HTML = 'defineSidebarHtml';

/**

* @event DefineHtmlEvent The event that is triggered when defining the HTML for meta fields within the editor sidebar.

* @see metaFieldsHtml()

* @since 3.7.0

*/

public const EVENT_DEFINE_META_FIELDS_HTML = 'defineMetaFieldsHtml';

/**

* @event DefineMetadataEvent The event that is triggered when defining the element’s metadata info.

* @see getMetadata()

* @since 3.7.0

*/

public const EVENT_DEFINE_METADATA = 'defineMetadata';

/**

* @event AuthorizationCheckEvent The event that is triggered when determining whether a user is authorized to view the element’s edit page.

*

* To authorize the user, set [[AuthorizationCheckEvent::$authorized]] to `true`.

*

* ```php

* Event::on(

* Entry::class,

* Element::EVENT_AUTHORIZE_VIEW,

* function(AuthorizationCheckEvent $event) {

* $event->authorized = true;

* }

* );

* ```

*

* @see canView()

* @since 4.0.0

* @deprecated in 4.3.0. [[\craft\services\Elements::EVENT_AUTHORIZE_VIEW]] should be used instead.

*/

public const EVENT_AUTHORIZE_VIEW = 'authorizeView';

/**

* @event AuthorizationCheckEvent The event that is triggered when determining whether a user is authorized to save the element in its current state.

*

* To authorize the user, set [[AuthorizationCheckEvent::$authorized]] to `true`.

*

* ```php

* Event::on(

* Entry::class,

* Element::EVENT_AUTHORIZE_SAVE,

* function(AuthorizationCheckEvent $event) {

* $event->authorized = true;

* }

* );

* ```

*

* @see canSave()

* @since 4.0.0

* @deprecated in 4.3.0. [[\craft\services\Elements::EVENT_AUTHORIZE_SAVE]] should be used instead.

*/

public const EVENT_AUTHORIZE_SAVE = 'authorizeSave';

/**

* @event AuthorizationCheckEvent The event that is triggered when determining whether a user is authorized to create drafts for the element.

*

* To authorize the user, set [[AuthorizationCheckEvent::$authorized]] to `true`.

*

* ```php

* Event::on(

* Entry::class,

* Element::EVENT_AUTHORIZE_CREATE_DRAFTS,

* function(AuthorizationCheckEvent $event) {

* $event->authorized = true;

* }

* );

* ```

*

* @see canCreateDrafts()

* @since 4.0.0

* @deprecated in 4.3.0. [[\craft\services\Elements::EVENT_AUTHORIZE_CREATE_DRAFTS]] should be used instead.

*/

public const EVENT_AUTHORIZE_CREATE_DRAFTS = 'authorizeCreateDrafts';

/**

* @event AuthorizationCheckEvent The event that is triggered when determining whether a user is authorized to duplicate the element.

*

* To authorize the user, set [[AuthorizationCheckEvent::$authorized]] to `true`.

*

* ```php

* Event::on(

* Entry::class,

* Element::EVENT_AUTHORIZE_DUPLICATE,

* function(AuthorizationCheckEvent $event) {

* $event->authorized = true;

* }

* );

* ```

*

* @see canDuplicate()

* @since 4.0.0

* @deprecated in 4.3.0. [[\craft\services\Elements::EVENT_AUTHORIZE_DUPLICATE]] should be used instead.

*/

public const EVENT_AUTHORIZE_DUPLICATE = 'authorizeDuplicate';

/**

* @event AuthorizationCheckEvent The event that is triggered when determining whether a user is authorized to delete the element.

*

* To authorize the user, set [[AuthorizationCheckEvent::$authorized]] to `true`.

*

* ```php

* Event::on(

* Entry::class,

* Element::EVENT_AUTHORIZE_DELETE,

* function(AuthorizationCheckEvent $event) {

* $event->authorized = true;

* }

* );

* ```

*

* @see canDelete()

* @since 4.0.0

* @deprecated in 4.3.0. [[\craft\services\Elements::EVENT_AUTHORIZE_DELETE]] should be used instead.

*/

public const EVENT_AUTHORIZE_DELETE = 'authorizeDelete';

/**

* @event AuthorizationCheckEvent The event that is triggered when determining whether a user is authorized to delete the element for its current site.

*

* To authorize the user, set [[AuthorizationCheckEvent::$authorized]] to `true`.

*

* ```php

* Event::on(

* Entry::class,

* Element::EVENT_AUTHORIZE_DELETE_FOR_SITE,

* function(AuthorizationCheckEvent $event) {

* $event->authorized = true;

* }

* );

* ```

*

* @see canDeleteForSite()

* @since 4.0.0

* @deprecated in 4.3.0. [[\craft\services\Elements::EVENT_AUTHORIZE_DELETE_FOR_SITE]] should be used instead.

*/

public const EVENT_AUTHORIZE_DELETE_FOR_SITE = 'authorizeDeleteForSite';

/**

* @event SetElementRouteEvent The event that is triggered when defining the route that should be used when this element’s URL is requested.

*

* Set [[Event::$handled]] to `true` to explicitly tell the element that a route has been set (even if you’re

* setting it to `null`).

*

* ```php

* Event::on(craft\elements\Entry::class, craft\base\Element::EVENT_SET_ROUTE, function(craft\events\SetElementRouteEvent $e) {

* // @var craft\elements\Entry $entry

* $entry = $e->sender;

*

* if ($entry->uri === 'pricing') {

* $e->route = 'module/pricing/index';

*

* // Explicitly tell the element that a route has been set,

* // and prevent other event handlers from running, and tell

* $e->handled = true;

* }

* });

* ```

*/

public const EVENT_SET_ROUTE = 'setRoute';

/**

* @event DefineValueEvent The event that is triggered when defining the cache tags that should be cleared when

* this element is saved.

* @see getCacheTags()

* @since 4.1.0

*/

public const EVENT_DEFINE_CACHE_TAGS = 'defineCacheTags';

/**

* @event DefineAttributeKeywordsEvent The event that is triggered when defining the search keywords for an

* element attribute.

*

* Note that you _must_ set [[Event::$handled]] to `true` if you want the element to accept your custom

* [[DefineAttributeKeywordsEvent::$keywords|$keywords]] value.

*

* ```php

* Event::on(

* craft\elements\Entry::class,

* craft\base\Element::EVENT_DEFINE_KEYWORDS,

* function(craft\events\DefineAttributeKeywordsEvent $e

* ) {

* // @var craft\elements\Entry $entry

* $entry = $e->sender;

*

* // Prevent entry titles in the Parts section from getting search keywords

* if ($entry->section->handle === 'parts' && $e->attribute === 'title') {

* $e->keywords = '';

* $e->handled = true;

* }

* });

* ```

*

* @since 3.5.0

*/

public const EVENT_DEFINE_KEYWORDS = 'defineKeywords';

/**

* @event DefineUrlEvent The event that is triggered before defining the element’s URL.

*

* It can be used to provide a custom URL, completely bypassing the default URL generation.

*

* ```php

* use craft\base\Element;

* use craft\elements\Entry;

* use craft\events\DefineUrlEvent;

* use craft\helpers\UrlHelper;

* use yii\base\Event;

*

* Event::on(

* Entry::class,

* Element::EVENT_BEFORE_DEFINE_URL,

* function(DefineUrlEvent $e

* ) {

* // @var Entry $entry

* $entry = $e->sender;

*

* $event->url = '...';

* });

* ```

*

* To prevent the element from getting a URL, ensure `$event->url` is set to `null`,

* and set `$event->handled` to `true`.

*

* Note that [[EVENT_DEFINE_URL]] will still be called regardless of what happens with this event.

*

* @see getUrl()

* @since 4.4.6

*/

public const EVENT_BEFORE_DEFINE_URL = 'beforeDefineUrl';

/**

* @event DefineUrlEvent The event that is triggered when defining the element’s URL.

*

* ```php

* use craft\base\Element;

* use craft\elements\Entry;

* use craft\events\DefineUrlEvent;

* use craft\helpers\UrlHelper;

* use yii\base\Event;

*

* Event::on(

* Entry::class,

* Element::EVENT_DEFINE_URL,

* function(DefineUrlEvent $e

* ) {

* // @var Entry $entry

* $entry = $e->sender;

*

* // Add a custom query string param to the URL

* if ($event->value !== null) {

* $event->url = UrlHelper::urlWithParams($event->url, [

* 'foo' => 'bar',

* ]);

* }

* });

* ```

*

* To prevent the element from getting a URL, ensure `$event->url` is set to `null`,

* and set `$event->handled` to `true`.

*

* @see getUrl()

* @since 4.3.0

*/

public const EVENT_DEFINE_URL = 'defineUrl';

/**

* @event ModelEvent The event that is triggered before the element is saved.

*

* You may set [[\yii\base\ModelEvent::$isValid]] to `false` to prevent the element from getting saved.

*

* If you want to ignore events for drafts or revisions, call [[\craft\helpers\ElementHelper::isDraftOrRevision()]]

* from your event handler:

*

* ```php

* use craft\base\Element;

* use craft\elements\Entry;

* use craft\events\ModelEvent;

* use craft\helpers\ElementHelper;

* use yii\base\Event;

*

* Event::on(Entry::class, Element::EVENT_BEFORE_SAVE, function(ModelEvent $e) {

* // @var Entry $entry

* $entry = $e->sender;

*

* if (ElementHelper::isDraftOrRevision($entry)) {

* return;

* }

*

* // ...

* });

* ```

*/

public const EVENT_BEFORE_SAVE = 'beforeSave';

/**

* @event ModelEvent The event that is triggered after the element is saved.

*

* If you want to ignore events for drafts or revisions, call [[\craft\helpers\ElementHelper::isDraftOrRevision()]]

* from your event handler:

*

* ```php

* use craft\base\Element;

* use craft\elements\Entry;

* use craft\events\ModelEvent;

* use craft\helpers\ElementHelper;

* use yii\base\Event;

*

* Event::on(Entry::class, Element::EVENT_AFTER_SAVE, function(ModelEvent $e) {

* // @var Entry $entry

* $entry = $e->sender;

*

* if (ElementHelper::isDraftOrRevision($entry)) {

* return;

* }

*

* // ...

* });

* ```

*/

public const EVENT_AFTER_SAVE = 'afterSave';

/**

* @event ModelEvent The event that is triggered after the element is fully saved and propagated to other sites.

*

* If you want to ignore events for drafts or revisions, call [[\craft\helpers\ElementHelper::isDraftOrRevision()]]

* from your event handler:

*

* ```php

* use craft\base\Element;

* use craft\elements\Entry;

* use craft\events\ModelEvent;

* use craft\helpers\ElementHelper;

* use yii\base\Event;

*

* Event::on(Entry::class, Element::EVENT_AFTER_PROPAGATE, function(ModelEvent $e) {

* // @var Entry $entry

* $entry = $e->sender;

*

* if (ElementHelper::isDraftOrRevision($entry) {

* return;

* }

*

* // ...

* });

* ```

*

* @since 3.2.0

*/

public const EVENT_AFTER_PROPAGATE = 'afterPropagate';

/**

* @event ModelEvent The event that is triggered before the element is deleted.

*

* You may set [[\yii\base\ModelEvent::$isValid]] to `false` to prevent the element from getting deleted.

*/

public const EVENT_BEFORE_DELETE = 'beforeDelete';

/**

* @event \yii\base\Event The event that is triggered after the element is deleted.

*/

public const EVENT_AFTER_DELETE = 'afterDelete';

/**

* @event ModelEvent The event that is triggered before the element is restored.

*

* You may set [[\yii\base\ModelEvent::$isValid]] to `false` to prevent the element from getting restored.

* @since 3.1.0

*/

public const EVENT_BEFORE_RESTORE = 'beforeRestore';

/**

* @event \yii\base\Event The event that is triggered after the element is restored.

* @since 3.1.0

*/

public const EVENT_AFTER_RESTORE = 'afterRestore';

/**

* @event ElementStructureEvent The event that is triggered before the element is moved in a structure.

*

* You may set [[\yii\base\ModelEvent::$isValid]] to `false` to prevent the element from getting moved.

*/

public const EVENT_BEFORE_MOVE_IN_STRUCTURE = 'beforeMoveInStructure';

/**

* @event ElementStructureEvent The event that is triggered after the element is moved in a structure.

*/

public const EVENT_AFTER_MOVE_IN_STRUCTURE = 'afterMoveInStructure';

/**

* @event RenderElementEvent The event that is triggered before an element is rendered.

* @since 5.7.5

*

* ```php

* use craft\base\Element;

* use craft\events\RenderElementEvent;

* use yii\base\Event;

*

* Event::on(

* Element::class,

* Element::EVENT_RENDER,

* function(RenderElementEvent $event) {

* $event->output = '…';

* }

* );

* ```

*/

public const EVENT_RENDER = 'render';

/**

* @see sources()

*/

private static array $sources = [];

/**

* @inheritdoc

*/

public static function displayName(): string

{

return Craft::t('app', 'Element');

}

/**

* @inheritdoc

*/

public static function lowerDisplayName(): string

{

return StringHelper::toLowerCase(static::displayName());

}

/**

* @inheritdoc

*/

public static function pluralDisplayName(): string

{

return Craft::t('app', 'Elements');

}

/**

* @inheritdoc

*/

public static function pluralLowerDisplayName(): string

{

return StringHelper::toLowerCase(static::pluralDisplayName());

}

/**

* @inheritdoc

*/

public static function refHandle(): ?string

{

return null;

}

/**

* @inheritdoc

*/

public static function hasDrafts(): bool

{

return false;

}

/**

* @inheritdoc

*/

public static function trackChanges(): bool

{

return false;

}

/**

* @inheritdoc

*/

public static function hasTitles(): bool

{

return false;

}

/**

* @inheritdoc

*/

public static function hasThumbs(): bool

{

return false;

}

/**

* @inheritdoc

*/

public static function hasUris(): bool

{

return false;

}

/**

* @inheritdoc

*/

public static function isLocalized(): bool

{

return false;

}

/**

* @inheritdoc

*/

public static function hasStatuses(): bool

{

return false;

}

/**

* @inheritdoc

*/

public static function statuses(): array

{

return [

self::STATUS_ENABLED => Craft::t('app', 'Enabled'),

self::STATUS_DISABLED => Craft::t('app', 'Disabled'),

];

}

/**

* @inheritdoc

* @return ElementQueryInterface

*/

public static function find(): ElementQueryInterface

{

return new ElementQuery(static::class);

}

/**

* @inheritdoc

*/

public static function findOne(mixed $criteria = null): ?static

{

return static::findByCondition($criteria, true);

}

/**

* @inheritdoc

*/

public static function findAll(mixed $criteria = null): array

{

return static::findByCondition($criteria, false);

}

/**

* @interitdoc

*/

public static function get(int|string $id): ?static

{

return static::find()

->id($id)

->fixedOrder()

->drafts(null)

->provisionalDrafts(null)

->revisions(null)

->status(null)

->one();

}

/**

* @inheritdoc

*/

public static function createCondition(): ElementConditionInterface

{

return Craft::createObject(ElementCondition::class, [static::class]);

}

/**

* @inheritdoc

*/

public static function multiPageSources(): bool

{

return false;

}

/**

* @inheritdoc

*/

public static function sources(string $context): array

{

if (!isset(self::$sources[static::class][$context])) {

// Memoize the results immediately, in case sources() gets called again via the event

self::$sources[static::class][$context] = static::defineSources($context);

// Fire a 'registerSources' event

if (Event::hasHandlers(static::class, self::EVENT_REGISTER_SOURCES)) {

$event = new RegisterElementSourcesEvent([

'context' => $context,

'sources' => self::$sources[static::class][$context],

]);

Event::trigger(static::class, self::EVENT_REGISTER_SOURCES, $event);

self::$sources[static::class][$context] = $event->sources;

}