mars 2023 – devfrontend.info

Objectif

Utiliser les arguments pour afficher ou masquer une partie de template PHTML dans le DOM qui va être généré (il peut arriver qu’on cherche à afficher certaines parties d’un PHTML et à en masquer d’autres sous condition)
Utiliser $block->hasData() et $block->getData() dans un template PHTML pour interroger les arguments placés dans le layout XML
Utiliser la fonctionnalité de Custom Layout Update pour surcharger un layout XML de page

Ressources en ligne:

Doc officielle: Common layout customization tasks > Create cms-page/product/category-specific selectable layouts
Doc officielle: Common layout customization tasks > Modify block arguments

Layout XML

ATTENTION: j’ai écrit ça un peu vite; se référer plutôt à la doc officielle (lien ci-dessus).

On crée un Custom Layout Update. Le nom du fichier est important:

cms_page_view_selectable_socialmedia_NoSocialFooter.xml: la surcharge sera à appliquer à la main, via le BO, pour n’importe quelle page CMS.
cms_page_view_id_socialmedia.xml: la surcharge sera appliquée automatiquement à la page CMS dont l’URL Key est « socialmedia ».

Fichier: app/design/frontend/Vendor/default/Magento_Cms/layout/cms_page_view_selectable_socialmedia_NoSocialFooter.xml

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceBlock name="footer.main">
            <arguments>
                <argument name="display_social_footer" xsi:type="boolean">false</argument>
            </arguments>
        </referenceBlock>
    </body>
</page>

<?xml version="1.0"?>

<body>

<argument name="display_social_footer" xsi:type="boolean">false</argument>

</arguments>

</referenceBlock>

</body>

</page>

Template PHTML

Fichier: app/design/frontend/Vendor/default/Magento_Theme/templates/html/footer/main.phtml

<?php

/**
 * @var \Magento\Framework\View\Element\Template $block
 */

// [1]
$displaySocialFooter = $block->hasData('display_social_footer') ? $block->getData('display_social_footer') : true;
?>

// [2]
<?php if ($displaySocialFooter): ?>
    <p>Lorem ipsum dolor sit amet</p>
<?php endif; ?>

<?php

/**

* @var \Magento\Framework\View\Element\Template $block

// [1]

$displaySocialFooter = $block->hasData('display_social_footer') ? $block->getData('display_social_footer') : true;

// [2]

<?php if ($displaySocialFooter): ?>

<p>Lorem ipsum dolor sit amet</p>

<?php endif; ?>

[1] On interroge le $block pour savoir si l’argument display_social_footer est redéfini dans le layout XML. Mais par défaut, on set la variable $display_social_footer à true.
[2] Si l’argument display_social_footer est redéfini à false dans mon exemple dans le layout XML (pour cela, il faut que le Custom Layout Update « NoSocialFooter » soit sélectionné en BO dans la config de la page CMS « socialmedia »), le <p>Lorem ipsum dolor sit amet</p> n’apparaîtra pas dans le DOM généré. Sinon, il apparaîtra.

En BO:

cache flush de rigueur!

Ressources en ligne:

ATTENTION: il y a pas mal de ressources en ligne (blogs, stack overflow) qui, sans donner de solutions incorrectes, ne donnent que des solutions partielles ou partiellement dépréciées.

J’ai notamment perdu pas mal de temps avant de comprendre qu’il existait deux systèmes de validation des champs de formulaires, dont un
est spécifique au Checkout et que ça avait son importance au moment d’ajouter un nouveau test de validation par le biais d’une mixin!

DONC… J’ai trié les ressources en deux catégories: celles à consulter en 1er et celles qui vous aideront moins, voire vous embrouilleront…

D’une manière générale avec les ressources en ligne sur Magento 2 (ou Adobe Commerce maintenant), préférez en priorité la documentation officielle de développement Front sous Magento 2/Adobe Commerce avant toute autre ressource!

Ressources à consulter en priorité

(officiel) Custom form validation rules
Magento 2 : Ajouter Une Validation Du Numéro De Téléphone – billet très complet sur le blog de Hervé Hennes. Magento 2 _ Ajouter une validation du numéro de téléphone _ Hervé Hennes et sources du module sur github.

Ressources sur ce blog (ma propre expérience de dev avec la validation des champs de formulaire sous Magento 2/Adobe Commerce)

Ajouter une validation supplémentaire au champ Code Postal (name="postcode") dans l’étape de Livraison/Shipping du Tunnel d’Achat/Checkout de Magento 2/Adobe Commerce
Ajouter une validation supplémentaire au champ Code Postal (name="postcode") dans l’étape de Paiement/Billing du Tunnel d’Achat/Checkout de Magento 2/Adobe Commerce

Ajouter une validation supplémentaire au champ Code Postal (`name="postcode"`) dans l’étape de Livraison/Shipping du Tunnel d’Achat/Checkout de Magento 2/Adobe Commerce

Comme expliqué dans l’excellent billet de Hervé Hennes sur l’ajout d’une validation sur un champ « Numéro de téléphone » dans Magento 2:

L’environnement de validation de données utilisées dans le compte clients et dans le tunnel de commandes étant différents il faudra créer 2 mixins.

app/code/Vendor/Customer/view/frontend/requirejs-config.js

let config = {
    [...]
    config: {
        mixins: {
            // Add mixin for global form validation
            'mage/validation': {
                'Vendor_Module/js/validation-mixin': true
            },
            // Add mixin for checkout form validation
            'Magento_Ui/js/lib/validation/validator': {
                'Vendor_Module/js/validator-mixin': true
            }
        }
    }
};

let config = {

[...]

config: {

mixins: {

// Add mixin for global form validation

'mage/validation': {

'Vendor_Module/js/validation-mixin': true

// Add mixin for checkout form validation

'Magento_Ui/js/lib/validation/validator': {

'Vendor_Module/js/validator-mixin': true

}

};

app/code/Vendor/Customer/view/frontend/web/js/validator-mixin.js

console.log(window.checkoutConfig);

1	console.log(window.checkoutConfig);

define([
    'jquery',
    'Magento_Checkout/js/model/postcode-validator'
], function(
    $,
    postcodeValidator
){
    'use strict';

    var message = $.mage.__("Provided Zip/Postal Code is invalid. Example: %1.");

    return function(validator) {

        validator.addRule(
            'validate-postcode-pattern',
            function (value) {
                var countryId = window.checkoutConfig.defaultCountryId;
                var patterns = window.checkoutConfig.postCodes[countryId];

                function processList(data) {
                    var examples = '';
                    var i = 0;

                    $.each(data, function(index, value) {
                        var length = Object.keys(data).length;

                        if (i === (length -1)) {
                            examples += value.example;
                        } else {
                            examples += value.example + '; ';
                        }

                        i++;
                    });

                    return examples;
                }

                message = $.mage.__("Provided Zip/Postal Code is invalid. Example: %1.").replace("%1", processList(patterns));

                return $.mage.isEmptyNoTrim(value) || postcodeValidator.validate(value, countryId);
            }, function () {
                return message;
            }
        );

        return validator;
    }
});

define([

'jquery',

'Magento_Checkout/js/model/postcode-validator'

], function(

postcodeValidator

){

'use strict';

var message = $.mage.__("Provided Zip/Postal Code is invalid. Example: %1.");

return function(validator) {

validator.addRule(

'validate-postcode-pattern',

function (value) {

var countryId = window.checkoutConfig.defaultCountryId;

var patterns = window.checkoutConfig.postCodes[countryId];

function processList(data) {

var examples = '';

var i = 0;

$.each(data, function(index, value) {

var length = Object.keys(data).length;

if (i === (length -1)) {

examples += value.example;

} else {

examples += value.example + '; ';

}

i++;

});

return examples;

}

message = $.mage.__("Provided Zip/Postal Code is invalid. Example: %1.").replace("%1", processList(patterns));

return $.mage.isEmptyNoTrim(value) || postcodeValidator.validate(value, countryId);

}, function () {

return message;

}

);

return validator;

}

});

app/code/Vendor/Customer/view/frontend/layout/checkout_index_index.xml

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" layout="checkout" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceBlock name="checkout.root">
            <arguments>
                <argument name="jsLayout" xsi:type="array">
                    <item name="components" xsi:type="array">
                        <item name="checkout" xsi:type="array">
                            <item name="children" xsi:type="array">
                                <item name="steps" xsi:type="array">
                                    <item name="children" xsi:type="array">
                                        <item name="shipping-step" xsi:type="array">
                                            <item name="children" xsi:type="array">
                                                <item name="shippingAddress" xsi:type="array">
                                                    <item name="children" xsi:type="array">
                                                        <item name="shipping-address-fieldset" xsi:type="array">
                                                            <item name="children" xsi:type="array">
                                                                <item name="postcode" xsi:type="array">
                                                                    <item name="validation" xsi:type="array">
                                                                        <item name="validate-xls-macro" xsi:type="boolean">true</item>
                                                                        <item name="validate-postcode-pattern" xsi:type="boolean">true</item>
                                                                    </item>
                                                                </item>
                                                            </item>
                                                        </item>
                                                    </item>
                                                </item>
                                            </item>
                                        </item>
                                    </item>
                                </item>
                            </item>
                        </item>
                    </item>
                </argument>
            </arguments>
        </referenceBlock>
    </body>
</page>

<?xml version="1.0"?>

<body>

</item>

</argument>

</arguments>

</referenceBlock>

</body>

</page>

Ajouter une validation supplémentaire au champ Code Postal (`name="postcode"`) dans l’étape de Paiement/Billing du Tunnel d’Achat/Checkout de Magento 2/Adobe Commerce

L’ajout d’une règle de validation supplémentaire pour le champ postcode dans l’étape de paiement nécessite d’adapter également le même champ dans le formulaire de l’étape de paiement pour proposer une expérience utilisateur homogène.

Cependant, nous ne pouvons pas procéder de la même manière (affecter la nouvelle règle de validation au formulaire et au champ voulu) via un layout XML car:

il existe autant de formulaires d’adresse de facturation que de méthodes de paiement
affecter notre règle de validation dans un layout XML (de manière statique) n’est pas une solution viable dans la mesure où un store peut proposer un certain nombre de moyens de paiement, que certains peuvent être rajoutés ou retirés dans le futur (et manqueront/seront en trop dans le layout XML)

Il vaut donc mieux se tourner vers une solution dynamique, côté back-end, qui bouclera sur les moyens de paiement existants.

Néanmoins, voici comment procéder si vous n’avez pas accès à un back-end:

Récupérer la liste de toutes les méthodes de paiement:

Ressource en ligne: Magento 2 Get All Payment Methods – Method 2: Use Object Manager

app/design/frontend/MyVendor/default/Magento_Checkout/templates/onepage.phtml

<?php
$objectManager =  \Magento\Framework\App\ObjectManager::getInstance();

$paymentHelper = $objectManager->get('Magento\Payment\Helper\Data');
$allPaymentMethods = $paymentHelper->getPaymentMethods();
$allPaymentMethodsArray = $paymentHelper->getPaymentMethodList();

var_dump($allPaymentMethodsArray);
var_dump($allPaymentMethods);

$paymentConfig = $objectManager->get('Magento\Payment\Model\Config');
$activePaymentMethods = $paymentConfig->getActiveMethods();

var_dump(array_keys($activePaymentMethods));

$orderPaymentCollection = $objectManager->get('\Magento\Sales\Model\ResourceModel\Order\Payment\Collection');
$orderPaymentCollection->getSelect()->group('method');
$paymentMethods[] = array('value' => '', 'label' => 'Any');
foreach ($orderPaymentCollection as $col) {
    $paymentMethods[] = array('value' => $col->getMethod(), 'label' => $col->getAdditionalInformation()['method_title']);
}
?>

<?php

$objectManager = \Magento\Framework\App\ObjectManager::getInstance();

$paymentHelper = $objectManager->get('Magento\Payment\Helper\Data');

$allPaymentMethods = $paymentHelper->getPaymentMethods();

$allPaymentMethodsArray = $paymentHelper->getPaymentMethodList();

var_dump($allPaymentMethodsArray);

var_dump($allPaymentMethods);

$paymentConfig = $objectManager->get('Magento\Payment\Model\Config');

$activePaymentMethods = $paymentConfig->getActiveMethods();

var_dump(array_keys($activePaymentMethods));

$orderPaymentCollection = $objectManager->get('\Magento\Sales\Model\ResourceModel\Order\Payment\Collection');

$orderPaymentCollection->getSelect()->group('method');

$paymentMethods[] = array('value' => '', 'label' => 'Any');

foreach ($orderPaymentCollection as $col) {

$paymentMethods[] = array('value' => $col->getMethod(), 'label' => $col->getAdditionalInformation()['method_title']);

}

Affecter une règle de validation custom pour chaque méthode de paiement dans le formulaire d’adresse de facturation

Ressource en ligne: Magento 2 how to add extra validation to new Billing address form fields in checkout page.

app/code/Vendor/Customer/view/frontend/layout/checkout_index_index.xml

<!-- Etape de livraison/shipping (traité à l'étape précédente de ce tuto) -->
<item name="shipping-step" xsi:type="array">
    <item name="children" xsi:type="array">
        <item name="shippingAddress" xsi:type="array">
            <item name="children" xsi:type="array">
                <item name="shipping-address-fieldset" xsi:type="array">
                    <item name="children" xsi:type="array">
                        <item name="postcode" xsi:type="array">
                            <item name="validation" xsi:type="array">
                                <item name="validate-xls-macro" xsi:type="boolean">true</item>
                                <item name="validate-postcode-pattern" xsi:type="boolean">true</item>
                            </item>
                        </item>
                    </item>
                </item>
            </item>
        </item>
    </item>
</item>

<!-- Etape de paiement/billing -->
<item name="billing-step" xsi:type="array">
    <item name="children" xsi:type="array">
        <item name="payment" xsi:type="array">
            <item name="children" xsi:type="array">
                <item name="payments-list" xsi:type="array">
                    <item name="children" xsi:type="array">

                        <!-- Répéter pour chaque méthode de paiement proposée par le store (ici: datatranscw_creditcard)--> 
                        <item name="datatranscw_creditcard-form" xsi:type="array">
                            <item name="children" xsi:type="array">
                                <item name="form-fields" xsi:type="array">
                                    <item name="children" xsi:type="array">
                                        <item name="postcode" xsi:type="array">
                                            <item name="validation" xsi:type="array">
                                                <item name="validate-xls-macro" xsi:type="boolean">true</item>
                                                <item name="validate-postcode-pattern" xsi:type="boolean">true</item>
                                            </item>
                                        </item>
                                    </item>
                                </item>
                            </item>
                        </item>

                        <!-- Méthode de paiement: datatranscw_paypal --> 
                        <item name="datatranscw_paypal-form" xsi:type="array">
                            <item name="children" xsi:type="array">
                                <item name="form-fields" xsi:type="array">
                                    <item name="children" xsi:type="array">
                                        <item name="postcode" xsi:type="array">
                                            <item name="validation" xsi:type="array">
                                                <item name="validate-xls-macro" xsi:type="boolean">true</item>
                                                <item name="validate-postcode-pattern" xsi:type="boolean">true</item>
                                            </item>
                                        </item>
                                    </item>
                                </item>
                            </item>
                        </item>

                        <!-- Méthode de paiement: checkmo --> 
                        <item name="checkmo-form" xsi:type="array">
                            <item name="children" xsi:type="array">
                                <item name="form-fields" xsi:type="array">
                                    <item name="children" xsi:type="array">
                                        <item name="postcode" xsi:type="array">
                                            <item name="validation" xsi:type="array">
                                                <item name="validate-xls-macro" xsi:type="boolean">true</item>
                                                <item name="validate-postcode-pattern" xsi:type="boolean">true</item>
                                            </item>
                                        </item>
                                    </item>
                                </item>
                            </item>
                        </item>
                    </item>
                </item>
            </item>
        </item>
    </item>
</item>

</item>

</item>

</item>

</item>

Articles récents

Catégories

Archives

Méta

Mois : mars 2023

[Javascript] Manipuler les objets JSON, astuces et bonnes pratiques

Boucler dans un objet JSON imbriqué et retourner une liste de toutes les valeurs d’une clé spécifique

[Magento 2] Utiliser les arguments dans les layouts XML pour afficher/masquer sous condition certaines zones d’un template PHTML

Objectif

Ressources en ligne:

Layout XML

Template PHTML

En BO:

[Javascript] Uncaught ReferenceError: x is not defined – Attendre qu’un objet, une variable, un élément du DOM soit présent avant d’exécuter du code

[Magento 2] Validation des champs de formulaire via les UI components, ressources en ligne et astuces

Ressources en ligne:

Ressources à consulter en priorité

Ressources sur ce blog (ma propre expérience de dev avec la validation des champs de formulaire sous Magento 2/Adobe Commerce)

Ajouter une validation supplémentaire au champ Code Postal (`name="postcode"`) dans l’étape de Livraison/Shipping du Tunnel d’Achat/Checkout de Magento 2/Adobe Commerce

Ajouter une validation supplémentaire au champ Code Postal (`name="postcode"`) dans l’étape de Paiement/Billing du Tunnel d’Achat/Checkout de Magento 2/Adobe Commerce

Récupérer la liste de toutes les méthodes de paiement:

Affecter une règle de validation custom pour chaque méthode de paiement dans le formulaire d’adresse de facturation

Ressources à consulter ensuite, si vous n’avez pas résolu votre problème

[Favicon] Astuces et bonnes pratiques de mise en place

[CSS][LESS] Un effet d’animation pour un lien souligné dont le texte s’étend sur plusieurs lignes avec background-size

[Magento 2] Désactiver l’extension Amasty Google Invisible Captcha qui bloque le click de certains boutons

Boucler dans un objet JSON imbriqué et retourner une liste de toutes les valeurs d’une clé spécifique

Objectif

Ressources en ligne:

Layout XML

Template PHTML

En BO:

Ressources en ligne:

Ressources à consulter en priorité

Ressources sur ce blog (ma propre expérience de dev avec la validation des champs de formulaire sous Magento 2/Adobe Commerce)

Ajouter une validation supplémentaire au champ Code Postal (name="postcode") dans l’étape de Livraison/Shipping du Tunnel d’Achat/Checkout de Magento 2/Adobe Commerce

Ajouter une validation supplémentaire au champ Code Postal (name="postcode") dans l’étape de Paiement/Billing du Tunnel d’Achat/Checkout de Magento 2/Adobe Commerce

Récupérer la liste de toutes les méthodes de paiement:

Affecter une règle de validation custom pour chaque méthode de paiement dans le formulaire d’adresse de facturation

Ressources à consulter ensuite, si vous n’avez pas résolu votre problème

Ajouter une validation supplémentaire au champ Code Postal (`name="postcode"`) dans l’étape de Livraison/Shipping du Tunnel d’Achat/Checkout de Magento 2/Adobe Commerce

Ajouter une validation supplémentaire au champ Code Postal (`name="postcode"`) dans l’étape de Paiement/Billing du Tunnel d’Achat/Checkout de Magento 2/Adobe Commerce