class MenuLinkContent

Same name in this branch
  1. 10 core/modules/menu_link_content/src/Plugin/Menu/MenuLinkContent.php \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent
Same name and namespace in other branches
  1. 9 core/modules/menu_link_content/src/Entity/MenuLinkContent.php \Drupal\menu_link_content\Entity\MenuLinkContent
  2. 9 core/modules/menu_link_content/src/Plugin/Menu/MenuLinkContent.php \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent
  3. 8.9.x core/modules/menu_link_content/src/Entity/MenuLinkContent.php \Drupal\menu_link_content\Entity\MenuLinkContent
  4. 8.9.x core/modules/menu_link_content/src/Plugin/Menu/MenuLinkContent.php \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent
  5. 11.x core/modules/menu_link_content/src/Entity/MenuLinkContent.php \Drupal\menu_link_content\Entity\MenuLinkContent
  6. 11.x core/modules/menu_link_content/src/Plugin/Menu/MenuLinkContent.php \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent

Defines the menu link content entity class.

@property \Drupal\Core\Field\FieldItemList $link @property \Drupal\Core\Field\FieldItemList $rediscover

Plugin annotation


@ContentEntityType(
  id = "menu_link_content",
  label = @Translation("Custom menu link"),
  label_collection = @Translation("Custom menu links"),
  label_singular = @Translation("custom menu link"),
  label_plural = @Translation("custom menu links"),
  label_count = @PluralTranslation(
    singular = "@count custom menu link",
    plural = "@count custom menu links",
  ),
  handlers = {
    "storage" = "\Drupal\menu_link_content\MenuLinkContentStorage",
    "storage_schema" = "Drupal\menu_link_content\MenuLinkContentStorageSchema",
    "access" = "Drupal\menu_link_content\MenuLinkContentAccessControlHandler",
    "form" = {
      "default" = "Drupal\menu_link_content\Form\MenuLinkContentForm",
      "delete" = "Drupal\menu_link_content\Form\MenuLinkContentDeleteForm"
    },
    "list_builder" = "Drupal\menu_link_content\MenuLinkListBuilder"
  },
  admin_permission = "administer menu",
  base_table = "menu_link_content",
  data_table = "menu_link_content_data",
  revision_table = "menu_link_content_revision",
  revision_data_table = "menu_link_content_field_revision",
  translatable = TRUE,
  entity_keys = {
    "id" = "id",
    "revision" = "revision_id",
    "label" = "title",
    "langcode" = "langcode",
    "uuid" = "uuid",
    "bundle" = "bundle",
    "published" = "enabled",
  },
  revision_metadata_keys = {
    "revision_user" = "revision_user",
    "revision_created" = "revision_created",
    "revision_log_message" = "revision_log_message",
  },
  links = {
    "canonical" = "/admin/structure/menu/item/{menu_link_content}/edit",
    "edit-form" = "/admin/structure/menu/item/{menu_link_content}/edit",
    "delete-form" = "/admin/structure/menu/item/{menu_link_content}/delete",
  },
  constraints = {
    "MenuTreeHierarchy" = {}
  },
)

Hierarchy

Expanded class hierarchy of MenuLinkContent

29 files declare their use of MenuLinkContent
ConfigAccessTest.php in core/modules/settings_tray/tests/src/FunctionalJavascript/ConfigAccessTest.php
DisplayPathTest.php in core/modules/views_ui/tests/src/Functional/DisplayPathTest.php
LanguageSwitchingTest.php in core/modules/language/tests/src/Functional/LanguageSwitchingTest.php
LinksetControllerTestBase.php in core/modules/system/tests/src/Functional/Menu/LinksetControllerTestBase.php
MenuActiveTrail403Test.php in core/tests/Drupal/FunctionalTests/Menu/MenuActiveTrail403Test.php

... See full list

File

core/modules/menu_link_content/src/Entity/MenuLinkContent.php, line 68

Namespace

Drupal\menu_link_content\Entity
View source
class MenuLinkContent extends EditorialContentEntityBase implements MenuLinkContentInterface {
    
    /**
     * A flag for whether this entity is wrapped in a plugin instance.
     *
     * @var bool
     */
    protected $insidePlugin = FALSE;
    
    /**
     * {@inheritdoc}
     */
    public function setInsidePlugin() {
        $this->insidePlugin = TRUE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTitle() {
        return $this->get('title')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getUrlObject() {
        return $this->link
            ->first()
            ->getUrl();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getMenuName() {
        return $this->get('menu_name')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->get('description')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getPluginId() {
        return 'menu_link_content:' . $this->uuid();
    }
    
    /**
     * {@inheritdoc}
     */
    public function isEnabled() {
        return (bool) $this->get('enabled')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function isExpanded() {
        return (bool) $this->get('expanded')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getParentId() {
        // Cast the parent ID to a string, only an empty string means no parent,
        // NULL keeps the existing parent.
        return (string) $this->get('parent')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getWeight() {
        return (int) $this->get('weight')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getPluginDefinition() {
        $definition = [];
        $definition['class'] = 'Drupal\\menu_link_content\\Plugin\\Menu\\MenuLinkContent';
        $definition['menu_name'] = $this->getMenuName();
        if ($url_object = $this->getUrlObject()) {
            $definition['url'] = NULL;
            $definition['route_name'] = NULL;
            $definition['route_parameters'] = [];
            if (!$url_object->isRouted()) {
                $definition['url'] = $url_object->getUri();
            }
            else {
                $definition['route_name'] = $url_object->getRouteName();
                $definition['route_parameters'] = $url_object->getRouteParameters();
            }
            $definition['options'] = $url_object->getOptions();
        }
        $definition['title'] = $this->getTitle();
        $definition['description'] = $this->getDescription();
        $definition['weight'] = $this->getWeight();
        $definition['id'] = $this->getPluginId();
        $definition['metadata'] = [
            'entity_id' => $this->id(),
        ];
        $definition['form_class'] = '\\Drupal\\menu_link_content\\Form\\MenuLinkContentForm';
        $definition['enabled'] = $this->isEnabled() ? 1 : 0;
        $definition['expanded'] = $this->isExpanded() ? 1 : 0;
        $definition['provider'] = 'menu_link_content';
        $definition['discovered'] = 0;
        $definition['parent'] = $this->getParentId();
        return $definition;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function preCreate(EntityStorageInterface $storage, array &$values) {
        $values += [
            'bundle' => 'menu_link_content',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function preSave(EntityStorageInterface $storage) {
        parent::preSave($storage);
        if (parse_url($this->link->uri, PHP_URL_SCHEME) === 'internal') {
            $this->setRequiresRediscovery(TRUE);
        }
        else {
            $this->setRequiresRediscovery(FALSE);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function postSave(EntityStorageInterface $storage, $update = TRUE) {
        parent::postSave($storage, $update);
        // Don't update the menu tree if a pending revision was saved.
        if (!$this->isDefaultRevision()) {
            return;
        }
        
        /** @var \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager */
        $menu_link_manager = \Drupal::service('plugin.manager.menu.link');
        // The menu link can just be updated if there is already a menu link entry
        // on both entity and menu link plugin level.
        $definition = $this->getPluginDefinition();
        // Even when $update is FALSE, for top level links it is possible the link
        // already is in the storage because of the getPluginDefinition() call
        // above, see https://www.drupal.org/node/2605684#comment-10515450 for the
        // call chain. Because of this the $update flag is ignored and only the
        // existence of the definition (equals to being in the tree storage) is
        // checked.
        if ($menu_link_manager->getDefinition($this->getPluginId(), FALSE)) {
            // When the entity is saved via a plugin instance, we should not call
            // the menu tree manager to update the definition a second time.
            if (!$this->insidePlugin) {
                $menu_link_manager->updateDefinition($this->getPluginId(), $definition, FALSE);
            }
        }
        else {
            $menu_link_manager->addDefinition($this->getPluginId(), $definition);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function preDelete(EntityStorageInterface $storage, array $entities) {
        parent::preDelete($storage, $entities);
        
        /** @var \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager */
        $menu_link_manager = \Drupal::service('plugin.manager.menu.link');
        foreach ($entities as $menu_link) {
            
            /** @var \Drupal\menu_link_content\Entity\MenuLinkContent $menu_link */
            $menu_link_manager->removeDefinition($menu_link->getPluginId(), FALSE);
            // Children get re-attached to the menu link's parent.
            $parent_plugin_id = $menu_link->getParentId();
            $children = $storage->loadByProperties([
                'parent' => $menu_link->getPluginId(),
            ]);
            foreach ($children as $child) {
                
                /** @var \Drupal\menu_link_content\Entity\MenuLinkContent $child */
                $child->set('parent', $parent_plugin_id)
                    ->save();
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
        
        /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
        $fields = parent::baseFieldDefinitions($entity_type);
        // Add the publishing status field.
        $fields += static::publishedBaseFieldDefinitions($entity_type);
        $fields['id']->setLabel(t('Entity ID'))
            ->setDescription(t('The entity ID for this menu link content entity.'));
        $fields['uuid']->setDescription(t('The content menu link UUID.'));
        $fields['langcode']->setDescription(t('The menu link language code.'));
        $fields['bundle']->setDescription(t('The content menu link bundle.'))
            ->setSetting('max_length', EntityTypeInterface::BUNDLE_MAX_LENGTH)
            ->setSetting('is_ascii', TRUE);
        $fields['title'] = BaseFieldDefinition::create('string')->setLabel(t('Menu link title'))
            ->setDescription(t('The text to be used for this link in the menu.'))
            ->setRequired(TRUE)
            ->setTranslatable(TRUE)
            ->setRevisionable(TRUE)
            ->setSetting('max_length', 255)
            ->setDisplayOptions('view', [
            'label' => 'hidden',
            'type' => 'string',
            'weight' => -5,
        ])
            ->setDisplayOptions('form', [
            'type' => 'string_textfield',
            'weight' => -5,
        ])
            ->setDisplayConfigurable('form', TRUE);
        $fields['description'] = BaseFieldDefinition::create('string')->setLabel(t('Description'))
            ->setDescription(t('Shown when hovering over the menu link.'))
            ->setTranslatable(TRUE)
            ->setRevisionable(TRUE)
            ->setSetting('max_length', 255)
            ->setDisplayOptions('view', [
            'label' => 'hidden',
            'type' => 'string',
            'weight' => 0,
        ])
            ->setDisplayOptions('form', [
            'type' => 'string_textfield',
            'weight' => 0,
        ]);
        $fields['menu_name'] = BaseFieldDefinition::create('string')->setLabel(t('Menu name'))
            ->setDescription(t('The menu name. All links with the same menu name (such as "tools") are part of the same menu.'))
            ->setDefaultValue('tools')
            ->setSetting('is_ascii', TRUE);
        $fields['link'] = BaseFieldDefinition::create('link')->setLabel(t('Link'))
            ->setDescription(t('The location this menu link points to.'))
            ->setRevisionable(TRUE)
            ->setRequired(TRUE)
            ->setSettings([
            'link_type' => LinkItemInterface::LINK_GENERIC,
            'title' => DRUPAL_DISABLED,
        ])
            ->setDisplayOptions('form', [
            'type' => 'link_default',
            'weight' => -2,
        ]);
        $fields['external'] = BaseFieldDefinition::create('boolean')->setLabel(t('External'))
            ->setDescription(t('A flag to indicate if the link points to a full URL starting with a protocol, like http:// (1 = external, 0 = internal).'))
            ->setDefaultValue(FALSE)
            ->setRevisionable(TRUE);
        $fields['rediscover'] = BaseFieldDefinition::create('boolean')->setLabel(t('Indicates whether the menu link should be rediscovered'))
            ->setDefaultValue(FALSE);
        $fields['weight'] = BaseFieldDefinition::create('integer')->setLabel(t('Weight'))
            ->setDescription(t('Link weight among links in the same menu at the same depth. In the menu, the links with high weight will sink and links with a low weight will be positioned nearer the top.'))
            ->setDefaultValue(0)
            ->setDisplayOptions('view', [
            'label' => 'hidden',
            'type' => 'number_integer',
            'weight' => 0,
        ])
            ->setDisplayOptions('form', [
            'type' => 'number',
            'weight' => 20,
        ]);
        $fields['expanded'] = BaseFieldDefinition::create('boolean')->setLabel(t('Show as expanded'))
            ->setDescription(t('If selected and this menu link has children, the menu will always appear expanded. This option may be overridden for the entire menu tree when placing a menu block.'))
            ->setDefaultValue(FALSE)
            ->setDisplayOptions('view', [
            'label' => 'hidden',
            'type' => 'boolean',
            'weight' => 0,
        ])
            ->setDisplayOptions('form', [
            'settings' => [
                'display_label' => TRUE,
            ],
            'weight' => 0,
        ]);
        // Override some properties of the published field added by
        // \Drupal\Core\Entity\EntityPublishedTrait::publishedBaseFieldDefinitions().
        $fields['enabled']->setLabel(t('Enabled'));
        $fields['enabled']->setDescription(t('A flag for whether the link should be enabled in menus or hidden.'));
        $fields['enabled']->setTranslatable(FALSE);
        $fields['enabled']->setDisplayOptions('view', [
            'label' => 'hidden',
            'type' => 'boolean',
            'weight' => 0,
        ]);
        $fields['enabled']->setDisplayOptions('form', [
            'settings' => [
                'display_label' => TRUE,
            ],
            'weight' => -1,
        ]);
        $fields['parent'] = BaseFieldDefinition::create('string')->setLabel(t('Parent plugin ID'))
            ->setDescription(t('The ID of the parent menu link plugin, or empty string when at the top level of the hierarchy.'));
        $fields['changed'] = BaseFieldDefinition::create('changed')->setLabel(t('Changed'))
            ->setDescription(t('The time that the menu link was last edited.'))
            ->setTranslatable(TRUE)
            ->setRevisionable(TRUE);
        // @todo Keep this field hidden until we have a revision UI for menu links.
        //   @see https://www.drupal.org/project/drupal/issues/2350939
        $fields['revision_log_message']->setDisplayOptions('form', [
            'region' => 'hidden',
        ]);
        return $fields;
    }
    
    /**
     * {@inheritdoc}
     */
    public function requiresRediscovery() {
        return $this->get('rediscover')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setRequiresRediscovery($rediscovery) {
        $this->set('rediscover', $rediscovery);
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ContentEntityBase::$activeLangcode protected property Language code identifying the entity active language.
ContentEntityBase::$defaultLangcode protected property Local cache for the default language code.
ContentEntityBase::$defaultLangcodeKey protected property The default langcode entity key.
ContentEntityBase::$enforceDefaultTranslation protected property Override the result of isDefaultTranslation().
ContentEntityBase::$enforceRevisionTranslationAffected protected property Whether the revision translation affected flag has been enforced.
ContentEntityBase::$entityKeys protected property Holds untranslatable entity keys such as the ID, bundle, and revision ID.
ContentEntityBase::$fieldDefinitions protected property Local cache for field definitions.
ContentEntityBase::$fields protected property The array of fields, each being an instance of FieldItemListInterface.
ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck protected static property Local cache for fields to skip from the checking for translation changes.
ContentEntityBase::$isDefaultRevision protected property Indicates whether this is the default revision.
ContentEntityBase::$langcodeKey protected property The language entity key.
ContentEntityBase::$languages protected property Local cache for the available language objects.
ContentEntityBase::$loadedRevisionId protected property The loaded revision ID before the new revision was set.
ContentEntityBase::$newRevision protected property Boolean indicating whether a new revision should be created on save.
ContentEntityBase::$revisionTranslationAffectedKey protected property The revision translation affected entity key.
ContentEntityBase::$translatableEntityKeys protected property Holds translatable entity keys such as the label.
ContentEntityBase::$translationInitialize protected property A flag indicating whether a translation object is being initialized.
ContentEntityBase::$translations protected property An array of entity translation metadata.
ContentEntityBase::$validated protected property Whether entity validation was performed.
ContentEntityBase::$validationRequired protected property Whether entity validation is required before saving the entity.
ContentEntityBase::$values protected property The plain data values of the contained fields.
ContentEntityBase::access public function Checks data value access. Overrides EntityBase::access 1
ContentEntityBase::addTranslation public function
ContentEntityBase::bundle public function Gets the bundle of the entity. Overrides EntityBase::bundle
ContentEntityBase::bundleFieldDefinitions public static function 5
ContentEntityBase::clearTranslationCache protected function Clears entity translation object cache to remove stale references.
ContentEntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityBase::create
ContentEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ContentEntityBase::get public function
ContentEntityBase::getEntityKey protected function Gets the value of the given entity key, if defined. 1
ContentEntityBase::getFieldDefinition public function
ContentEntityBase::getFieldDefinitions public function
ContentEntityBase::getFields public function
ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip in ::hasTranslationChanges. 1
ContentEntityBase::getIterator public function
ContentEntityBase::getLanguages protected function
ContentEntityBase::getLoadedRevisionId public function
ContentEntityBase::getRevisionId public function
ContentEntityBase::getTranslatableFields public function
ContentEntityBase::getTranslatedField protected function Gets a translated field.
ContentEntityBase::getTranslation public function
ContentEntityBase::getTranslationLanguages public function
ContentEntityBase::getTranslationStatus public function Returns the translation status. Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated public function
ContentEntityBase::hasField public function
ContentEntityBase::hasTranslation public function
ContentEntityBase::hasTranslationChanges public function
ContentEntityBase::id public function Gets the identifier. Overrides EntityBase::id
ContentEntityBase::initializeTranslation protected function Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision public function
ContentEntityBase::isDefaultTranslation public function
ContentEntityBase::isDefaultTranslationAffectedOnly public function
ContentEntityBase::isLatestRevision public function
ContentEntityBase::isLatestTranslationAffectedRevision public function
ContentEntityBase::isNewRevision public function
ContentEntityBase::isNewTranslation public function
ContentEntityBase::isRevisionTranslationAffected public function
ContentEntityBase::isRevisionTranslationAffectedEnforced public function
ContentEntityBase::isTranslatable public function
ContentEntityBase::isValidationRequired public function
ContentEntityBase::label public function Gets the label of the entity. Overrides EntityBase::label 4
ContentEntityBase::language public function Gets the language of the entity. Overrides EntityBase::language
ContentEntityBase::onChange public function
ContentEntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityBase::postCreate 1
ContentEntityBase::preSaveRevision public function 3
ContentEntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityBase::referencedEntities 1
ContentEntityBase::removeTranslation public function
ContentEntityBase::set public function
ContentEntityBase::setDefaultLangcode protected function Populates the local cache for the default language code.
ContentEntityBase::setDefaultTranslationEnforced public function Set or clear an override of the isDefaultTranslation() result.
ContentEntityBase::setNewRevision public function
ContentEntityBase::setRevisionTranslationAffected public function
ContentEntityBase::setRevisionTranslationAffectedEnforced public function
ContentEntityBase::setValidationRequired public function
ContentEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray
ContentEntityBase::updateFieldLangcodes protected function Updates language for already instantiated fields.
ContentEntityBase::updateLoadedRevisionId public function
ContentEntityBase::updateOriginalValues public function Updates the original values with the interim changes.
ContentEntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase::uuid
ContentEntityBase::validate public function 1
ContentEntityBase::wasDefaultRevision public function
ContentEntityBase::__clone public function Magic method: Implements a deep clone.
ContentEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct
ContentEntityBase::__get public function Implements the magic method for getting object properties.
ContentEntityBase::__isset public function Implements the magic method for isset().
ContentEntityBase::__set public function Implements the magic method for setting object properties.
ContentEntityBase::__sleep public function Overrides EntityBase::__sleep
ContentEntityBase::__unset public function Implements the magic method for unset().
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate 3
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName 1
EntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget 1
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getOriginalId public function Gets the original ID. Overrides EntityInterface::getOriginalId 1
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::invalidateTagsOnDelete protected static function Invalidates an entity's cache tags upon delete. 1
EntityBase::invalidateTagsOnSave protected function Invalidates an entity's cache tags upon save. 2
EntityBase::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew 2
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 17
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
EntityBase::save public function Saves an entity permanently. Overrides EntityInterface::save 3
EntityBase::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl 2
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuidGenerator protected function Gets the UUID generator.
EntityChangedTrait::getChangedTime public function Gets the timestamp of the last entity change for the current translation.
EntityChangedTrait::getChangedTimeAcrossTranslations public function Returns the timestamp of the last entity change across all translations.
EntityChangedTrait::setChangedTime public function Sets the timestamp of the last entity change for the current translation.
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck
EntityPublishedTrait::isPublished public function
EntityPublishedTrait::publishedBaseFieldDefinitions public static function Returns an array of base field definitions for publishing status.
EntityPublishedTrait::setPublished public function
EntityPublishedTrait::setUnpublished public function
MenuLinkContent::$insidePlugin protected property A flag for whether this entity is wrapped in a plugin instance.
MenuLinkContent::baseFieldDefinitions public static function Overrides EditorialContentEntityBase::baseFieldDefinitions
MenuLinkContent::getDescription public function Gets the description of the menu link for the UI. Overrides MenuLinkContentInterface::getDescription
MenuLinkContent::getMenuName public function Gets the menu name of the custom menu link. Overrides MenuLinkContentInterface::getMenuName
MenuLinkContent::getParentId public function Gets the plugin ID of the parent menu link. Overrides MenuLinkContentInterface::getParentId
MenuLinkContent::getPluginDefinition public function Builds up the menu link plugin definition for this entity. Overrides MenuLinkContentInterface::getPluginDefinition
MenuLinkContent::getPluginId public function Gets the menu plugin ID associated with this entity. Overrides MenuLinkContentInterface::getPluginId
MenuLinkContent::getTitle public function Gets the title of the menu link. Overrides MenuLinkContentInterface::getTitle
MenuLinkContent::getUrlObject public function Gets the URL object pointing to the URL of the menu link content entity. Overrides MenuLinkContentInterface::getUrlObject
MenuLinkContent::getWeight public function Returns the weight of the menu link content entity. Overrides MenuLinkContentInterface::getWeight
MenuLinkContent::isEnabled public function Returns whether the menu link is marked as enabled. Overrides MenuLinkContentInterface::isEnabled
MenuLinkContent::isExpanded public function Returns whether the menu link is marked as always expanded. Overrides MenuLinkContentInterface::isExpanded
MenuLinkContent::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides ContentEntityBase::postSave
MenuLinkContent::preCreate public static function Changes the values of an entity before it is created. Overrides EntityBase::preCreate
MenuLinkContent::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete
MenuLinkContent::preSave public function Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase::preSave
MenuLinkContent::requiresRediscovery public function Returns whether the menu link requires rediscovery. Overrides MenuLinkContentInterface::requiresRediscovery
MenuLinkContent::setInsidePlugin public function Flags this instance as being wrapped in a menu link plugin instance. Overrides MenuLinkContentInterface::setInsidePlugin
MenuLinkContent::setRequiresRediscovery public function Flags a link as requiring rediscovery. Overrides MenuLinkContentInterface::setRequiresRediscovery
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
RevisionLogEntityTrait::getEntityType abstract public function Gets the entity type definition.
RevisionLogEntityTrait::getRevisionCreationTime public function Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().
RevisionLogEntityTrait::getRevisionLogMessage public function Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().
RevisionLogEntityTrait::getRevisionUser public function Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().
RevisionLogEntityTrait::getRevisionUserId public function Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().
RevisionLogEntityTrait::revisionLogBaseFieldDefinitions public static function Provides revision-related base field definitions for an entity type.
RevisionLogEntityTrait::setRevisionCreationTime public function Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().
RevisionLogEntityTrait::setRevisionLogMessage public function Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().
RevisionLogEntityTrait::setRevisionUser public function Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().
RevisionLogEntityTrait::setRevisionUserId public function Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().
SynchronizableEntityTrait::$isSyncing protected property Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function
TranslationStatusInterface::TRANSLATION_CREATED constant Status code identifying a newly created translation.
TranslationStatusInterface::TRANSLATION_EXISTING constant Status code identifying an existing translation.
TranslationStatusInterface::TRANSLATION_REMOVED constant Status code identifying a removed translation.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.