12.15.2. Inyección de dependencias en un bloque

En los artículos anteriores analizamos qué son los Servicios, la Inyección de Dependencias (DI) y cómo usarlos en un controlador:

12.15. Servicios e Inyección de Dependencias.
12.15.1. Inyección de dependencias en el controlador

En este artículo se muestra un ejemplo de cómo agregar servicios mediante DI en una clase de bloque:

/modules/custom/drupalbook/src/Plugin/Block/CartBlock.php:

<?php

namespace Drupal\drupalbook\Plugin\Block;

use Drupal\commerce_cart\CartProviderInterface;
use Drupal\Core\Block\BlockBase;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Proporciona un bloque de carrito.
 *
 * @Block(
 *   id = "commerce_cart",
 *   admin_label = @Translation("Carrito"),
 *   category = @Translation("Comercio")
 * )
 */
class CartBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * El proveedor del carrito.
   *
   * @var \Drupal\commerce_cart\CartProviderInterface
   */
  protected $cartProvider;

  /**
   * El gestor de tipos de entidad.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Construye un nuevo CartBlock.
   *
   * @param array $configuration
   *   Configuración del plugin.
   * @param string $plugin_id
   *   El ID del plugin.
   * @param mixed $plugin_definition
   *   Definición del plugin.
   * @param \Drupal\commerce_cart\CartProviderInterface $cart_provider
   *   El proveedor del carrito.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   El gestor de entidades.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, CartProviderInterface $cart_provider, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);

    $this->cartProvider = $cart_provider;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('commerce_cart.cart_provider'),
      $container->get('entity_type.manager')
    );
  }

  /**
   * Construye el bloque del carrito.
   *
   * @return array
   *   Un array de renderizado.
   */
  public function build() {
     ...
     
    /** @var \Drupal\commerce_order\Entity\OrderInterface[] $carts */
    $carts = $this->cartProvider->getCarts();
    ...
  }
}

Primero, añadimos la interfaz ContainerFactoryPluginInterface a la clase del bloque:

class CartBlock extends BlockBase implements ContainerFactoryPluginInterface {

Después, definimos las propiedades donde almacenaremos los objetos de los servicios:

  protected $cartProvider;
  protected $entityTypeManager;

Luego, establecemos los parámetros estándar del plugin en el constructor:

  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);

Después de los parámetros estándar, añadimos los parámetros necesarios para los servicios:

  public function __construct(array $configuration, $plugin_id, $plugin_definition, CartProviderInterface $cart_provider, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);

    $this->cartProvider = $cart_provider;
    $this->entityTypeManager = $entity_type_manager;
  }

En el método create() también especificamos primero los parámetros estándar del plugin y luego los objetos de servicio necesarios:

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('commerce_cart.cart_provider'),
      $container->get('entity_type.manager')
    );
  }

Después de eso, podemos usar los objetos de servicio desde la variable $this:

  public function build() {
     ...
     
    /** @var \Drupal\commerce_order\Entity\OrderInterface[] $carts */
    $carts = $this->cartProvider->getCarts();
    ...
  }