StaticDiscoveryDecorator.php

Same filename in other branches
  1. 9 core/lib/Drupal/Component/Plugin/Discovery/StaticDiscoveryDecorator.php
  2. 8.9.x core/lib/Drupal/Component/Plugin/Discovery/StaticDiscoveryDecorator.php
  3. 11.x core/lib/Drupal/Component/Plugin/Discovery/StaticDiscoveryDecorator.php

Namespace

Drupal\Component\Plugin\Discovery

File

core/lib/Drupal/Component/Plugin/Discovery/StaticDiscoveryDecorator.php

View source
<?php

namespace Drupal\Component\Plugin\Discovery;


/**
 * A decorator that allows manual registration of undiscoverable definitions.
 */
class StaticDiscoveryDecorator extends StaticDiscovery {
    
    /**
     * The Discovery object being decorated.
     *
     * @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface
     */
    protected $decorated;
    
    /**
     * A callback or closure used for registering additional definitions.
     *
     * @var callable
     */
    protected $registerDefinitions;
    
    /**
     * Constructs a \Drupal\Component\Plugin\Discovery\StaticDiscoveryDecorator object.
     *
     * @param \Drupal\Component\Plugin\Discovery\DiscoveryInterface $decorated
     *   The discovery object that is being decorated.
     * @param callable|null $registerDefinitions
     *   (optional) A callback or closure used for registering additional
     *   definitions.
     */
    public function __construct(DiscoveryInterface $decorated, $registerDefinitions = NULL) {
        $this->decorated = $decorated;
        $this->registerDefinitions = $registerDefinitions;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefinition($base_plugin_id, $exception_on_invalid = TRUE) {
        if (isset($this->registerDefinitions)) {
            call_user_func($this->registerDefinitions);
        }
        $this->definitions += $this->decorated
            ->getDefinitions();
        return parent::getDefinition($base_plugin_id, $exception_on_invalid);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefinitions() {
        if (isset($this->registerDefinitions)) {
            call_user_func($this->registerDefinitions);
        }
        $this->definitions += $this->decorated
            ->getDefinitions();
        return parent::getDefinitions();
    }
    
    /**
     * Passes through all unknown calls onto the decorated object.
     */
    public function __call($method, $args) {
        return call_user_func_array([
            $this->decorated,
            $method,
        ], $args);
    }

}

Classes

Title Deprecated Summary
StaticDiscoveryDecorator A decorator that allows manual registration of undiscoverable definitions.

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