class MenuActiveTrail

Same name in this branch
  1. 11.x core/lib/Drupal/Core/Menu/MenuActiveTrail.php \Drupal\Core\Menu\MenuActiveTrail
Same name in other branches
  1. 9 core/lib/Drupal/Core/Menu/MenuActiveTrail.php \Drupal\Core\Menu\MenuActiveTrail
  2. 8.9.x core/lib/Drupal/Core/Menu/MenuActiveTrail.php \Drupal\Core\Menu\MenuActiveTrail
  3. 10 core/lib/Drupal/Core/ProxyClass/Menu/MenuActiveTrail.php \Drupal\Core\ProxyClass\Menu\MenuActiveTrail
  4. 10 core/lib/Drupal/Core/Menu/MenuActiveTrail.php \Drupal\Core\Menu\MenuActiveTrail

Provides a proxy class for \Drupal\Core\Menu\MenuActiveTrail.

Hierarchy

Expanded class hierarchy of MenuActiveTrail

See also

\Drupal\Component\ProxyBuilder

File

core/lib/Drupal/Core/ProxyClass/Menu/MenuActiveTrail.php, line 15

Namespace

Drupal\Core\ProxyClass\Menu
View source
class MenuActiveTrail implements \Drupal\Core\Cache\CacheCollectorInterface, \Drupal\Core\DestructableInterface, \Drupal\Core\Menu\MenuActiveTrailInterface {
    use \Drupal\Core\DependencyInjection\DependencySerializationTrait;
    
    /**
     * The id of the original proxied service.
     *
     * @var string
     */
    protected $drupalProxyOriginalServiceId;
    
    /**
     * The real proxied service, after it was lazy loaded.
     *
     * @var \Drupal\Core\Menu\MenuActiveTrail
     */
    protected $service;
    
    /**
     * The service container.
     *
     * @var \Symfony\Component\DependencyInjection\ContainerInterface
     */
    protected $container;
    
    /**
     * Constructs a ProxyClass Drupal proxy object.
     *
     * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
     *   The container.
     * @param string $drupal_proxy_original_service_id
     *   The service ID of the original service.
     */
    public function __construct(\Symfony\Component\DependencyInjection\ContainerInterface $container, $drupal_proxy_original_service_id) {
        $this->container = $container;
        $this->drupalProxyOriginalServiceId = $drupal_proxy_original_service_id;
    }
    
    /**
     * Lazy loads the real service from the container.
     *
     * @return object
     *   Returns the constructed real service.
     */
    protected function lazyLoadItself() {
        if (!isset($this->service)) {
            $this->service = $this->container
                ->get($this->drupalProxyOriginalServiceId);
        }
        return $this->service;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getActiveTrailIds($menu_name) {
        return $this->lazyLoadItself()
            ->getActiveTrailIds($menu_name);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getActiveLink($menu_name = NULL) {
        return $this->lazyLoadItself()
            ->getActiveLink($menu_name);
    }
    
    /**
     * {@inheritdoc}
     */
    public function has($key) {
        return $this->lazyLoadItself()
            ->has($key);
    }
    
    /**
     * {@inheritdoc}
     */
    public function get($key) {
        return $this->lazyLoadItself()
            ->get($key);
    }
    
    /**
     * {@inheritdoc}
     */
    public function set($key, $value) {
        return $this->lazyLoadItself()
            ->set($key, $value);
    }
    
    /**
     * {@inheritdoc}
     */
    public function delete($key) {
        return $this->lazyLoadItself()
            ->delete($key);
    }
    
    /**
     * {@inheritdoc}
     */
    public function reset() {
        return $this->lazyLoadItself()
            ->reset();
    }
    
    /**
     * {@inheritdoc}
     */
    public function clear() {
        return $this->lazyLoadItself()
            ->clear();
    }
    
    /**
     * {@inheritdoc}
     */
    public function destruct() {
        return $this->lazyLoadItself()
            ->destruct();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MenuActiveTrail::$container protected property The service container.
MenuActiveTrail::$drupalProxyOriginalServiceId protected property The id of the original proxied service.
MenuActiveTrail::$service protected property The real proxied service, after it was lazy loaded.
MenuActiveTrail::clear public function Clears the collected cache entry. Overrides CacheCollectorInterface::clear
MenuActiveTrail::delete public function Deletes the element. Overrides CacheCollectorInterface::delete
MenuActiveTrail::destruct public function Performs destruct operations. Overrides DestructableInterface::destruct
MenuActiveTrail::get public function Gets value from the cache. Overrides CacheCollectorInterface::get
MenuActiveTrail::getActiveLink public function Fetches a menu link which matches the route name, parameters and menu name. Overrides MenuActiveTrailInterface::getActiveLink
MenuActiveTrail::getActiveTrailIds public function Gets the active trail IDs of the specified menu tree. Overrides MenuActiveTrailInterface::getActiveTrailIds
MenuActiveTrail::has public function Returns whether data exists for this key. Overrides CacheCollectorInterface::has
MenuActiveTrail::lazyLoadItself protected function Lazy loads the real service from the container.
MenuActiveTrail::reset public function Resets the local cache. Overrides CacheCollectorInterface::reset
MenuActiveTrail::set public function Sets cache data. Overrides CacheCollectorInterface::set
MenuActiveTrail::__construct public function Constructs a ProxyClass Drupal proxy object.

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