class RouteBuilder in Drupal 8

Provides a proxy class for \Drupal\Core\Routing\RouteBuilder.

Hierarchy

• class \Drupal\Core\ProxyClass\Routing\RouteBuilder implements DestructableInterface, RouteBuilderInterface uses DependencySerializationTrait

See also

\Drupal\Component\ProxyBuilder

File

core/lib/Drupal/Core/ProxyClass/Routing/RouteBuilder.php, line 15

Namespace

Drupal\Core\ProxyClass\Routing

class RouteBuilder implements \Drupal\Core\Routing\RouteBuilderInterface, \Drupal\Core\DestructableInterface {
  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\Routing\RouteBuilder
   */
  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 setRebuildNeeded() {
    return $this
      ->lazyLoadItself()
      ->setRebuildNeeded();
  }

  /**
   * {@inheritdoc}
   */
  public function rebuild() {
    return $this
      ->lazyLoadItself()
      ->rebuild();
  }

  /**
   * {@inheritdoc}
   */
  public function rebuildIfNeeded() {
    return $this
      ->lazyLoadItself()
      ->rebuildIfNeeded();
  }

  /**
   * {@inheritdoc}
   */
  public function destruct() {
    return $this
      ->lazyLoadItself()
      ->destruct();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
RouteBuilder::$container	protected	property	The service container.
RouteBuilder::$drupalProxyOriginalServiceId	protected	property	The id of the original proxied service.
RouteBuilder::$service	protected	property	The real proxied service, after it was lazy loaded.
RouteBuilder::destruct	public	function	Performs destruct operations. Overrides DestructableInterface::destruct
RouteBuilder::lazyLoadItself	protected	function	Lazy loads the real service from the container.
RouteBuilder::rebuild	public	function	Rebuilds the route information and dumps it. Overrides RouteBuilderInterface::rebuild
RouteBuilder::rebuildIfNeeded	public	function	Rebuilds the route information if necessary, and dumps it. Overrides RouteBuilderInterface::rebuildIfNeeded
RouteBuilder::setRebuildNeeded	public	function	Sets the router to be rebuilt next time rebuildIfNeeded() is called. Overrides RouteBuilderInterface::setRebuildNeeded
RouteBuilder::__construct	public	function	Constructs a ProxyClass Drupal proxy object.