12.15.2. Dependency Injection in un blocco

Negli articoli precedenti abbiamo analizzato cosa sono i Services, la Dependency Injection (DI) e come utilizzarli nel nostro Controller:

12.15. Services e Dependency Injection.
12.15.1. Dependency Injection nel controller

In questo articolo un esempio di come aggiungere i servizi tramite DI in una classe di blocco:

/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;


/**
 * Fornisce un blocco carrello.
 *
 * @Block(
 *   id = "commerce_cart",
 *   admin_label = @Translation("Cart"),
 *   category = @Translation("Commerce")
 * )
 */
class CartBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * Il cart provider.
   *
   * @var \Drupal\commerce_cart\CartProviderInterface
   */
  protected $cartProvider;

  /**
   * L’entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Costruttore di un nuovo CartBlock.
   *
   * @param array $configuration
   *   Un array di configurazione con le informazioni sull’istanza del plugin.
   * @param string $plugin_id
   *   L’ID del plugin per l’istanza del plugin.
   * @param mixed $plugin_definition
   *   La definizione di implementazione del plugin.
   * @param \Drupal\commerce_cart\CartProviderInterface $cart_provider
   *   Il cart provider.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   L’entity type manager.
   */
  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')
    );
  }

  /**
   * Costruisce il blocco carrello.
   *
   * @return array
   *   Un render array.
   */
  public function build() {
     ...
     
         /** @var \Drupal\commerce_order\Entity\OrderInterface[] $carts */
    $carts = $this->cartProvider->getCarts();
    ...
  }
}

Per prima cosa aggiungiamo l’interfaccia ContainerFactoryPluginInterface alla classe del nostro blocco:

class CartBlock extends BlockBase implements ContainerFactoryPluginInterface {

Dopo di ciò definiamo le proprietà in cui andremo a salvare gli oggetti dei servizi:

  protected $cartProvider;
  protected $entityTypeManager;

Poi impostiamo i parametri standard del plugin nel costruttore:

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

Dopo i parametri standard del costruttore del plugin, dobbiamo passare i parametri necessari per gli oggetti dei servizi:

  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;
  }

Nel metodo create() indichiamo prima i parametri standard per il plugin e poi gli oggetti dei servizi richiesti:

  /**
   * {@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')
    );
  }

Dopo questo possiamo utilizzare gli oggetti dei servizi tramite la variabile $this:

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