injection de dépendances – devfrontend.info

Création d’un Helper pas-à-pas

Nous allons créer un fichier `app/code/Pdv/Catalog/Helper/Data.php`.

Si le fichier en question existe déjà, vous pouvez sauter cette étape. Si le Module <Vendor>_Catalog n’existe pas, il faudra le créer au préalable. Le code pour encapsuler notre Helper est le suivant:

<?php

namespace Pdv\Catalog\Helper;

/**
 * Catalog data helper
 *
 */
class Data extends \Magento\Framework\App\Helper\AbstractHelper
{

...

}

<?php

namespace Pdv\Catalog\Helper;

/**

* Catalog data helper

class Data extends \Magento\Framework\App\Helper\AbstractHelper

{

...

}

Du Namespace du Model dont je veux injecter la propriété de la classe:

Du Namespace du Model (fichier: vendor/magento/module-configurable-product/Model/ResourceModel/Product/Type/Configurable.php namespace: namespace Magento\ConfigurableProduct\Model\ResourceModel\Product\Type;) dont je veux injecter la propriété de la classe.

/**
 * @var \Magento\ConfigurableProduct\Model\ResourceModel\Product\Type\Configurable
 */
protected $typeConfigurableResourceModel;

/**

* @var \Magento\ConfigurableProduct\Model\ResourceModel\Product\Type\Configurable

protected $typeConfigurableResourceModel;

La fonction getParentIdsByChild() qui nous intéresse dans le Model que nous allons étendre:

/**
 * Retrieve parent ids array by required child
 *
 * @param int|array $childId
 * @return string[]
 */
public function getParentIdsByChild($childId)
{
    $select = $this->getConnection()
        ->select()
        ->from(['l' => $this->getMainTable()], [])
        ->join(
            ['e' => $this->getTable('catalog_product_entity')],
            'e.' . $this->optionProvider->getProductEntityLinkField() . ' = l.parent_id',
            ['e.entity_id']
        )->where('l.product_id IN(?)', $childId);
    $parentIds = $this->getConnection()->fetchCol($select);

    return $parentIds;
}

/**

* Retrieve parent ids array by required child

* @param int|array $childId

* @return string[]

public function getParentIdsByChild($childId)

{

$select = $this->getConnection()

->select()

->from(['l' => $this->getMainTable()], [])

->join(

['e' => $this->getTable('catalog_product_entity')],

'e.' . $this->optionProvider->getProductEntityLinkField() . ' = l.parent_id',

['e.entity_id']

)->where('l.product_id IN(?)', $childId);

$parentIds = $this->getConnection()->fetchCol($select);

return $parentIds;

}

Demande à Magento une instance de mon configurable ressource model…

public function __construct(
    \Magento\ConfigurableProduct\Model\ResourceModel\Product\Type\Configurable $typeConfigurableResourceModel
) {
    ...
}

public function __construct(

\Magento\ConfigurableProduct\Model\ResourceModel\Product\Type\Configurable $typeConfigurableResourceModel

) {

...

}

…et mappe le paramètre du constructeur avec la propriété de la classe.

public function __construct(
    ...
) {
    $this->typeConfigurableResourceModel = $typeConfigurableResourceModel;
}

public function __construct(

...

) {

$this->typeConfigurableResourceModel = $typeConfigurableResourceModel;

}

Donne accès à une nouvelle méthode `getConfigurableParentIdsByChildId()` dans le template PHTML:

/**
 * @param $childId
 * @return string[]
 */
public function getConfigurableParentIdsByChildId($childId)
{
    return $this->typeConfigurableResourceModel->getParentIdsByChild($childId);
}

/**

* @param $childId

* @return string[]

public function getConfigurableParentIdsByChildId($childId)

{

return $this->typeConfigurableResourceModel->getParentIdsByChild($childId);

}

Notre Helper `app/code/Pdv/Catalog/Helper/Data.php` finalisé:

<?php

namespace Pdv\Catalog\Helper;

/**
 * Catalog data helper
 *
 */
class Data extends \Magento\Framework\App\Helper\AbstractHelper
{
    /**
     * @var \Magento\ConfigurableProduct\Model\ResourceModel\Product\Type\Configurable
     */
    protected $typeConfigurableResourceModel; // 1. Du nom du model dont je veux injecter la propriété de la classe

    public function __construct(
        \Magento\ConfigurableProduct\Model\ResourceModel\Product\Type\Configurable $typeConfigurableResourceModel // 2. Demande à Magento une instance de mon configurable ressource model
    ) {
        $this->typeConfigurableResourceModel = $typeConfigurableResourceModel; // 3. ...et mappe le paramètre du constructeur avec la propriété de la classe
    }

    /**
     * @param $childId
     * @return string[]
     */
    public function getConfigurableParentIdsByChildId($childId)
    {
        // 4. Je donne accès à ma nouvelle méthode dans le PHTML
        return $this->typeConfigurableResourceModel->getParentIdsByChild($childId);
    }
}

<?php

namespace Pdv\Catalog\Helper;

/**

* Catalog data helper

class Data extends \Magento\Framework\App\Helper\AbstractHelper

{

/**

* @var \Magento\ConfigurableProduct\Model\ResourceModel\Product\Type\Configurable

protected $typeConfigurableResourceModel; // 1. Du nom du model dont je veux injecter la propriété de la classe

public function __construct(

\Magento\ConfigurableProduct\Model\ResourceModel\Product\Type\Configurable $typeConfigurableResourceModel // 2. Demande à Magento une instance de mon configurable ressource model

) {

$this->typeConfigurableResourceModel = $typeConfigurableResourceModel; // 3. ...et mappe le paramètre du constructeur avec la propriété de la classe

}

/**

* @param $childId

* @return string[]

public function getConfigurableParentIdsByChildId($childId)

{

// 4. Je donne accès à ma nouvelle méthode dans le PHTML

return $this->typeConfigurableResourceModel->getParentIdsByChild($childId);

}

Exploiter notre nouveau Helper dans un template PHTML

Déclarer notre Helper dans notre template PHTML

Créer (ou ajouter dans) un bloc de code PHP assez haut dans votre fichier PHTML et collez-y ceci:

<?php
/** @var \Pdv\Catalog\Helper\Data $helper */
$helper = $this->helper('Pdv\Catalog\Helper\Data');
?>

<?php

/** @var \Pdv\Catalog\Helper\Data $helper */

$helper = $this->helper('Pdv\Catalog\Helper\Data');

Le chemin Pdv\Catalog\Helper\Data correspond ici au namespace déclaré dans le fichier Helper app/code/Pdv/Catalog/Helper/Data.php + au nom du ficher sans son extension *.php.

A l’endroit dans votre template PHTML où vous souhaitez récupérer l’ID du produit parent (le produit configurable duquel découlent tous les produits simples/toutes les variations), créez une variable `$parentProductId`

<?php
$parentProductId = implode("|", $helper->getConfigurableParentIdsByChildId($_product->getId()));
?>

<?php

$parentProductId = implode("|", $helper->getConfigurableParentIdsByChildId($_product->getId()));

L’utilisation d'implode est obligatoire ici, même si nous allons récupérer une string plutôt qu’un array. C’est une bizarrerie de Magento 2.

Afficher la valeur de `$parentProductId` dans votre code HTML

<div class="pricing-plan" data-configurable="<?= $parentProductId ?>">...</div>

1	<div class="pricing-plan" data-configurable="<?= $parentProductId ?>">...</div>

Article en cours de rédaction… Je ne suis pas encore parvenu à faire quelque chose de propre à défaut de faire quelque chose qui fonctionne.

Sources:

Probablement la ressource la plus utile: Magento 2: Get Associated Simple Products from Configurable Product – En utilisant l’injection de dépendances ou Object Manager.
How to get parent product id in magento 2? – Bout de code hyper crade à placer dans le PHTML de votre liste produit; ça marche, mais bon …
How to Get Parent Product ID in Magento 2 – Propose de passer par un Helper; je n’ai pas réussi à exploiter le code fourni…
How to Get Parent Product Ids in Magento 2 – Magento 2.3 – pour un produit de type Bundle ou Grouped (l’article n’évoque pas le produit Configurable).

Note: pour mettre en place l’upload d’image, nous allons installer l’extension magento2-widget-parameters. Je vous invite à consulter le billet de blog suivant pour la démarche à suivre: [Magento 2] Ajouter un sélecteur d’image ou un champ WYSIWYG dans un widget custom.

Convention: on part du principe qu’on crée un widget pour le vendor Sodifrance et le module Pdv.

Une fois l’extension magento2-widget-parameters installée, nous allons créer les fichiers suivants:

app/code/Sodifrance/Pdv/etc/widget.xml

Le champ « Clé d’URL de la page de destination » est en required="false" car l’utilisateur n’est pas obligé d’associer un lien pointant vers une autre page à ce widget. Nous verrons avec le code de la vue PHTML comment nous gérons ça en PHP par le biais d’une condition if/else.

<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">
    <widget class="Sodifrance\Pdv\Block\Widget\TwoColsDynamic" id="twocolumnsdynamic_widget">
        <label>2 columns dynamic Widget</label>
        <description>2 columns dynamic Widget for Magento 2</description>
        <parameters>
            <parameter name="block_link" xsi:type="text" required="false" visible="true" sort_order="10">
                <label>Clé d'URL de la page de destination</label>
            </parameter>
            <parameter name="left_col_title" xsi:type="text" required="false" visible="true" sort_order="10">
                <label>Left column title</label>
            </parameter>
            <parameter name="left_col_tagline" xsi:type="text" required="false" visible="true" sort_order="10">
                <label>Left column tagline</label>
            </parameter>
            <parameter name="right_col_image" xsi:type="block" required="false" visible="true" sort_order="10">
                <label translate="true">Right column image</label>
                <block class="Dmatthew\WidgetParameters\Block\Adminhtml\Widget\Type\ImageChooser">
                    <data>
                        <item name="button" xsi:type="array">
                            <item name="open" xsi:type="string">Choose Image...</item>
                        </item>
                    </data>
                </block>
            </parameter>
            <parameter name="right_col_text" xsi:type="block" required="false" visible="true" sort_order="10">
                <label translate="true">Right column text</label>
                <block class="Dmatthew\WidgetParameters\Block\Adminhtml\Widget\Type\Wysiwyg" />
            </parameter>
        </parameters>
    </widget>
</widgets>

<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">

<label>2 columns dynamic Widget</label>

<description>2 columns dynamic Widget for Magento 2</description>

<label>Clé d'URL de la page de destination</label>

</parameter>

<label>Left column title</label>

</parameter>

<label>Left column tagline</label>

</parameter>

<label translate="true">Right column image</label>

<data>

<item name="open" xsi:type="string">Choose Image...</item>

</item>

</data>

</block>

</parameter>

<label translate="true">Right column text</label>

</parameter>

</parameters>

</widget>

</widgets>

app/code/Sodifrance/Pdv/Block/Widget/TwoColsDynamic.php

Ici, on crée 2 fonctions publiques:

getWidgetMediaUrl() qui récupère l’URL de base du site, lui ajoute le chemin vers l’endroit où reposent les médias de contenu éditorial dans Magento 2 et le libellé et le format de l’image uploadée via le widget en BO.
getWidgetTargetPageUrl() qui récupère l’URL de base du site et lui ajoute la clé d’URL de la page cible, telle que renseignée via le widget en BO.

<?php
namespace Sodifrance\Pdv\Block\Widget;

use Magento\Framework\View\Element\Template;
use Magento\Widget\Block\BlockInterface;

class TwoColsDynamic extends Template implements BlockInterface {

    protected $_template = "widget/twocolsdynamic.phtml";

    /**
     * @var \Magento\Cms\Helper\Wysiwyg\Images $helper
     */
    protected $helper;
    /**
     * @var \Magento\Framework\UrlInterface $urlInterface
     */
    protected $urlInterface;

    // Alt + Inser
    public function __construct(Template\Context $context, \Magento\Cms\Helper\Wysiwyg\Images $helper, \Magento\Framework\UrlInterface $urlInterface, array $data = [])
    {
        $this->helper = $helper;
        $this->urlInterface = $urlInterface;
        parent::__construct($context, $data);
    }

    public function getWidgetMediaUrl()
    {
        return
            $this->helper->getBaseUrl() .
            $this->getData('right_col_image');
    }

    public function getWidgetTargetPageUrl()
    {
        return
            $this->urlInterface->getBaseUrl() .
            $this->getData('block_link');
    }

}

<?php

namespace Sodifrance\Pdv\Block\Widget;

use Magento\Framework\View\Element\Template;

use Magento\Widget\Block\BlockInterface;

class TwoColsDynamic extends Template implements BlockInterface {

protected $_template = "widget/twocolsdynamic.phtml";

/**

* @var \Magento\Cms\Helper\Wysiwyg\Images $helper

protected $helper;

/**

* @var \Magento\Framework\UrlInterface $urlInterface

protected $urlInterface;

// Alt + Inser

public function __construct(Template\Context $context, \Magento\Cms\Helper\Wysiwyg\Images $helper, \Magento\Framework\UrlInterface $urlInterface, array $data = [])

{

$this->helper = $helper;

$this->urlInterface = $urlInterface;

parent::__construct($context, $data);

}

public function getWidgetMediaUrl()

{

return

$this->helper->getBaseUrl() .

$this->getData('right_col_image');

}

public function getWidgetTargetPageUrl()

{

return

$this->urlInterface->getBaseUrl() .

$this->getData('block_link');

}

Note: dans l’IDE PHP Storm, il est possible de ne taper que les lignes suivantes:

    /**
     * @var \Magento\Cms\Helper\Wysiwyg\Images $helper
     */
    protected $helper;
    /**
     * @var \Magento\Framework\UrlInterface $urlInterface
     */
    protected $urlInterface;

/**

* @var \Magento\Cms\Helper\Wysiwyg\Images $helper

protected $helper;

/**

* @var \Magento\Framework\UrlInterface $urlInterface

protected $urlInterface;

Ensuite, placez le curseur sous ces lignes et faites le raccourci Alt + Inser. Vous aurez accès à une liste de bouts de code que l’IDE se propose d’écrire pour vous! Si vous choisissez « constructor » et que vous sélectionnez ensuite les 2 entrées $helper et $urlInterface (placez le curseur sur la première, puis Maj + flèche du bas), le constructeur sera généré automatiquement.

app/code/Sodifrance/Pdv/view/frontend/templates/widget/twocolsdynamic.phtml

Dans le template PHTML, on ajoute une condition <?php if (!empty($block->getData('block_link'))): ?> qui vérifie si le champ URL est rempli en BO et génère du HTML en fonction.

<?php
/** \Sodifrance\Pdv\Block\Widget\TwoColsDynamic $block */
?>

<div class="widget widget-twoColsDynamic">
    <div class="widget-twoColsDynamic-left">
        <div class="cms-blockHeading-2">
            <h2 class="heading">
                <?= $block->escapeHtml($block->getData('left_col_title')) ?>
            </h2>
        </div>
        <p><?= $block->escapeHtml($block->getData('left_col_tagline')) ?></p>
    </div>
    <div class="widget-twoColsDynamic-right">
        <?php if (!empty($block->getData('block_link'))): ?>
            <a class="widget-twoColsDynamic-right-content" href="<?= $block->getWidgetTargetPageUrl() ?>" target="_blank">
                <div class="widget-twoColsDynamic-left">
                    <img src="<?= $block->getWidgetMediaUrl() ?>" alt="*" class="img-fluid widget-twoColsDynamic-image" />
                </div>
                <div class="widget-twoColsDynamic-right">
                    <?= $block->getData('right_col_text') ?>
                </div>
            </a>
        <?php else: ?>
            <div class="widget-twoColsDynamic-right-content">
                <div class="widget-twoColsDynamic-left">
                    <img src="<?= $block->getWidgetMediaUrl() ?>" alt="*" class="img-fluid widget-twoColsDynamic-image" />
                </div>
                <div class="widget-twoColsDynamic-right">
                    <?= $block->getData('right_col_text') ?>
                </div>
            </div>
        <?php endif; ?>
    </div>
</div>

<?php

/** \Sodifrance\Pdv\Block\Widget\TwoColsDynamic $block */

<?= $block->escapeHtml($block->getData('left_col_title')) ?>

</h2>

</div>

<p><?= $block->escapeHtml($block->getData('left_col_tagline')) ?></p>

</div>

<?php if (!empty($block->getData('block_link'))): ?>

<a class="widget-twoColsDynamic-right-content" href="<?= $block->getWidgetTargetPageUrl() ?>" target="_blank">

<img src="<?= $block->getWidgetMediaUrl() ?>" alt="*" class="img-fluid widget-twoColsDynamic-image" />

</div>

<?= $block->getData('right_col_text') ?>

</div>

</a>

<?php else: ?>

<img src="<?= $block->getWidgetMediaUrl() ?>" alt="*" class="img-fluid widget-twoColsDynamic-image" />

</div>

<?= $block->getData('right_col_text') ?>

</div>

<?php endif; ?>

</div>

Flushez vos caches; le widget devrait être disponible en backoffice!

Articles récents

Catégories

Archives

Méta

Étiquette : injection de dépendances

[Magento 2] Récupérer les Simple Products associés à un Configurable Product

Création d’un Helper pas-à-pas

Nous allons créer un fichier `app/code/Pdv/Catalog/Helper/Data.php`.

Du Namespace du Model dont je veux injecter la propriété de la classe:

Demande à Magento une instance de mon configurable ressource model…

…et mappe le paramètre du constructeur avec la propriété de la classe.

Donne accès à une nouvelle méthode `getConfigurableParentIdsByChildId()` dans le template PHTML:

Notre Helper `app/code/Pdv/Catalog/Helper/Data.php` finalisé:

Exploiter notre nouveau Helper dans un template PHTML

Déclarer notre Helper dans notre template PHTML

A l’endroit dans votre template PHTML où vous souhaitez récupérer l’ID du produit parent (le produit configurable duquel découlent tous les produits simples/toutes les variations), créez une variable `$parentProductId`

Afficher la valeur de `$parentProductId` dans votre code HTML

[Magento 2] Initiation à l’injection de dépendances en créant un widget custom qui permet l’upload d’une image et l’ajout d’un lien vers une page CMS

app/code/Sodifrance/Pdv/etc/widget.xml

app/code/Sodifrance/Pdv/Block/Widget/TwoColsDynamic.php

app/code/Sodifrance/Pdv/view/frontend/templates/widget/twocolsdynamic.phtml

Création d’un Helper pas-à-pas

Nous allons créer un fichier app/code/Pdv/Catalog/Helper/Data.php.

Du Namespace du Model dont je veux injecter la propriété de la classe:

Demande à Magento une instance de mon configurable ressource model…

…et mappe le paramètre du constructeur avec la propriété de la classe.

Donne accès à une nouvelle méthode getConfigurableParentIdsByChildId() dans le template PHTML:

Notre Helper app/code/Pdv/Catalog/Helper/Data.php finalisé:

Exploiter notre nouveau Helper dans un template PHTML

Déclarer notre Helper dans notre template PHTML

A l’endroit dans votre template PHTML où vous souhaitez récupérer l’ID du produit parent (le produit configurable duquel découlent tous les produits simples/toutes les variations), créez une variable $parentProductId

Afficher la valeur de $parentProductId dans votre code HTML

app/code/Sodifrance/Pdv/etc/widget.xml

app/code/Sodifrance/Pdv/Block/Widget/TwoColsDynamic.php

app/code/Sodifrance/Pdv/view/frontend/templates/widget/twocolsdynamic.phtml

Nous allons créer un fichier `app/code/Pdv/Catalog/Helper/Data.php`.

Donne accès à une nouvelle méthode `getConfigurableParentIdsByChildId()` dans le template PHTML:

Notre Helper `app/code/Pdv/Catalog/Helper/Data.php` finalisé:

A l’endroit dans votre template PHTML où vous souhaitez récupérer l’ID du produit parent (le produit configurable duquel découlent tous les produits simples/toutes les variations), créez une variable `$parentProductId`

Afficher la valeur de `$parentProductId` dans votre code HTML