Accueil > Programmation > PHP > Magento 2 > Magento 2 Tuto 2.3 - L’injection de dépendances
Magento 2 Tuto 2.3 - L’injection de dépendances
mardi 15 novembre 2016, par
L’injection de dépendances
C’est un mécanisme qui permet d’instancier les classes dont nous avons besoin dans nos objets. Je vous laisse voir d’autres tutos pour le détail, il en existe de très bien faits et passons directement au vif du sujet : celui de magento.
Comme dans toute injection de dépendance, on place des factory dans les constructeurs de nos clases. Une factory est une classe qui suit un design pattern qui comprend une méthode de « construction » qui prend un type de classe en entrée et retourne une instance de cette classe.
L’injection de dépendances de magento 2
Dans magento, on a un « générateur de factory » qui est celui de symfony. Pour inclure une dépendance, on va ajouter dans le constructeur de notre classe un paramètre de type
Par exemple, si je veux une collection de produits, dont la classe est Magento\Catalog\Model\ResourceModel\Product\Collection
Mon factory magique sera : \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory
Si nous prenons l’exemple d’un bloc, nous aurons une déclaration semblable à ceci :
- <?php
- namespace Pangolin\ExtendedProducts\Block;
- /**
- * Block Message
- */
- class Message extends \Magento\Framework\View\Element\Template
- {
- /**
- * var \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory
- */
- protected $_produceCollectionFactory;
- /**
- * @var integer
- */
- private $nbProducts;
- /**
- * @param \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productCollectionFactory
- */
- public function __construct(\Magento\Framework\View\Element\Template\Context $context,
- \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productCollectionFactory
- ) {
- $this->_produceCollectionFactory = $productCollectionFactory;
- parent::__construct($context);
- }
- }
Pour instancier notre collection, il suffit d’appeler la méthode « create() » :
- /** @var \Magento\Catalog\Model\ResourceModel\Product\Collection $productCollection */
- $productCollection = $this→_produceCollectionFactory->create();
Magento a un mécanisme interne qui analyse tous les constructeurs de vos classes et génère les factory automatiquement dans le répertoire var/generation. Attention, si vous changez la déclaration d’un constructeur, magento génère une erreur. Il vous faudra supprimer le fichier correspondant à votre classe dans var/generation.
Les dépendances sont gérées dans des fichiers nommés di.xml. Par exemple, la configuration suivante :
- <preference for="Magento\Framework\View\ConfigInterface" type="Magento\Framework\View\Config" />
signifie que si on injecte la classe Magento\Framework\View\ConfigInterface dans un constructeur, on obtiendra une instance de la classe Magento\Framework\View\Config
Cette configuration est nécessaire également si vous étendez une classe native magento : les modules natifs instancieront votre classe et non plus la classe native si vous configurez cette préférence.
Voilà, c’est l’essentiel et c’est tout pour l’instant. Mais cet article est voué à s’étoffer.
