Menu.php

Same filename in this branch
  1. 11.x core/modules/system/src/Plugin/migrate/source/Menu.php
Same filename in other branches
  1. 9 core/modules/system/src/Entity/Menu.php
  2. 9 core/modules/system/src/Plugin/migrate/source/Menu.php
  3. 8.9.x core/modules/system/src/Entity/Menu.php
  4. 8.9.x core/modules/system/src/Plugin/migrate/source/Menu.php
  5. 10 core/modules/system/src/Entity/Menu.php
  6. 10 core/modules/system/src/Plugin/migrate/source/Menu.php

Namespace

Drupal\system\Entity

File

core/modules/system/src/Entity/Menu.php

View source
<?php

namespace Drupal\system\Entity;

use Drupal\Core\Config\Entity\ConfigEntityBase;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\system\MenuInterface;

/**
 * Defines the Menu configuration entity class.
 *
 * @ConfigEntityType(
 *   id = "menu",
 *   label = @Translation("Menu"),
 *   label_collection = @Translation("Menus"),
 *   label_singular = @Translation("menu"),
 *   label_plural = @Translation("menus"),
 *   label_count = @PluralTranslation(
 *     singular = "@count menu",
 *     plural = "@count menus",
 *   ),
 *   handlers = {
 *     "access" = "Drupal\system\MenuAccessControlHandler",
 *     "storage" = "Drupal\system\MenuStorage",
 *   },
 *   admin_permission = "administer menu",
 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "label"
 *   },
 *   config_export = {
 *     "id",
 *     "label",
 *     "description",
 *     "locked",
 *   }
 * )
 */
class Menu extends ConfigEntityBase implements MenuInterface {
    
    /**
     * The menu machine name.
     *
     * @var string
     */
    protected $id;
    
    /**
     * The human-readable name of the menu entity.
     *
     * @var string
     */
    protected $label;
    
    /**
     * The menu description.
     *
     * @var string
     */
    protected $description;
    
    /**
     * The locked status of this menu.
     *
     * @var bool
     */
    protected $locked = FALSE;
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->description;
    }
    
    /**
     * {@inheritdoc}
     */
    public function isLocked() {
        return (bool) $this->locked;
    }
    
    /**
     * {@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) {
            // Delete all links from the menu.
            $menu_link_manager->deleteLinksInMenu($menu->id());
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function save() {
        $return = parent::save();
        \Drupal::cache('menu')->invalidateAll();
        // Invalidate the block cache to update menu-based derivatives.
        if (\Drupal::moduleHandler()->moduleExists('block')) {
            \Drupal::service('plugin.manager.block')->clearCachedDefinitions();
        }
        return $return;
    }
    
    /**
     * {@inheritdoc}
     */
    public function delete() {
        parent::delete();
        \Drupal::cache('menu')->invalidateAll();
        // Invalidate the block cache to update menu-based derivatives.
        if (\Drupal::moduleHandler()->moduleExists('block')) {
            \Drupal::service('plugin.manager.block')->clearCachedDefinitions();
        }
    }

}

Classes

Title Deprecated Summary
Menu Defines the Menu configuration entity class.

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