Defective Code Logo

Total Downloads Latest Stable Version Latest Stable Version

English | العربية | বাংলা | Bosanski | Deutsch | Español | Français | हिन्दी | Italiano | 日本語 | 한국어 | मराठी | Português | Русский | Kiswahili | தமிழ் | తెలుగు | Türkçe | اردو | Tiếng Việt | 中文

Mise à niveau

Si vous effectuez une mise à niveau à partir d'une version précédente, veuillez consulter le Guide de mise à niveau pour les changements majeurs et les étapes de migration.

Introduction

MJML est un langage de balisage spécifiquement conçu pour simplifier le processus de codage des emails responsives. Sa syntaxe sémantique garantit facilité et simplicité, tandis que sa vaste bibliothèque de composants standards accélère le développement et réduit la complexité de votre code d’email. Le moteur open-source de MJML génère un HTML de haute qualité, responsive et conforme aux meilleures pratiques. Si vous avez déjà rencontré des frustrations en travaillant avec Outlook, ce package est fait pour vous.

Notre implémentation de MJML sert d'enveloppe pour l'API MJML officielle. Elle permet une compilation pratique de MJML en HTML directement dans PHP, sans avoir besoin de NodeJS. Ce package est idéal pour les applications PHP qui souhaitent intégrer MJML sans les tracas de l'installation de NodeJS et de la CLI MJML.

Exemple

// Sans Laravel
(new MJML)->render(
    '<mjml><mj-body><mj-section><mj-column><mj-text>Hello World</mj-text></mj-column></mj-section></mj-body></mjml>'
);
 
// HTML minifié
(new MJML)->minify()->render(
    '<mjml><mj-body><mj-section><mj-column><mj-text>Hello World</mj-text></mj-column></mj-section></mj-body></mjml>'
);
 
// Avec Laravel
MJML::render(
    '<mjml><mj-body><mj-section><mj-column><mj-text>Hello World</mj-text></mj-column></mj-section></mj-body></mjml>'
);
 
// Avec Laravel et HTML minifié
MJML::minify()->render(
    '<mjml><mj-body><mj-section><mj-column><mj-text>Hello World</mj-text></mj-column></mj-section></mj-body></mjml>'
);

Installation

  1. Ajoutez d'abord ce qui suit à votre fichier composer.json pour indiquer à notre package de récupérer les bons binaires pour votre système d'exploitation lors de l'installation de notre package. Les binaires seront téléchargés après que vous ayez exécuté install, update, ou dump-autoload.

    {
        "post-autoload-dump": ["DefectiveCode\\MJML\\PullBinary::all"]
    }

    Le binaire MJML sera obtenu à partir de notre CDN et enregistré dans le dossier "bin" de ce package lors de l'installation ou de la mise à jour de composer. Assurez-vous que vous avez les binaires nécessaires chargés pour vos environnements local et de production.

    Par défaut, all récupérera tous les binaires que nous supportons. Nous vous recommandons de restreindre cela aux systèmes d'exploitation et d'architecture dont vous avez besoin pour économiser de la bande passante et des temps d'installation. Voici les binaires disponibles.

    Système d'exploitation Architecture Commande Composer Post-Mise à jour
    Tous Tous DefectiveCode\MJML\PullBinary::all
    Darwin (MacOS) arm64 DefectiveCode\MJML\PullBinary::darwin-arm64
    Darwin (MacOS) x64 DefectiveCode\MJML\PullBinary::darwin-x64
    Linux (glibc) arm64 DefectiveCode\MJML\PullBinary::linux-arm64
    Linux (glibc) x64 DefectiveCode\MJML\PullBinary::linux-x64
    Linux (musl) arm64 DefectiveCode\MJML\PullBinary::linux-arm64-musl
    Linux (musl) x64 DefectiveCode\MJML\PullBinary::linux-x64-musl

  2. Ensuite, installez le package PHP en exécutant la commande composer suivante :

    composer require defectivecode/mjml

  3. C'est tout ! Si vous utilisez Laravel, notre package s'installera automatiquement grâce à la découverte de packages de Laravel.

Utilisation (Sans Laravel)

Voir l'utilisation avec Laravel ci-dessous si vous utilisez Laravel.

Rendu de MJML

Pour rendre MJML, il suffit de passer votre chaîne MJML à la méthode render :

use DefectiveCode\MJML;
 
$html = (new MJML)->render(
    '<mjml><mj-body><mj-section><mj-column><mj-text>Hello World</mj-text></mj-column></mj-section></mj-body></mjml>'
);

Validation de MJML

Pour valider MJML, il suffit de passer votre chaîne MJML à la méthode isValid :

use DefectiveCode\MJML;
 
$isValid = (new MJML)->isValid(
    '<mjml><mj-body><mj-section><mj-column><mj-text>Hello World</mj-text></mj-column></mj-section></mj-body></mjml>'
);

Utilisation (Avec Laravel)

Rendu de MJML

Pour rendre MJML, il suffit de passer votre chaîne MJML à la méthode render de la façade MJML :

use DefectiveCode\MJML\Facades\MJML;
 
$html = MJML::render(
    '<mjml><mj-body><mj-section><mj-column><mj-text>Hello World</mj-text></mj-column></mj-section></mj-body></mjml>'
);

Validation de MJML

Pour valider MJML, il suffit de passer votre chaîne MJML à la méthode isValid de la façade MJML :

use DefectiveCode\MJML\Facades\MJML;
 
$isValid = MJML::isValid(
    '<mjml><mj-body><mj-section><mj-column><mj-text>Hello World</mj-text></mj-column></mj-section></mj-body></mjml>'
);

Configuration

Vous pouvez publier le fichier de configuration en utilisant la commande suivante :

php artisan vendor:publish --provider="DefectiveCode\MJML\MJMLServiceProvider"

Cela créera un fichier de configuration mjml.php dans votre dossier config. Toutes les options répertoriées dans le fichier de configuration sont passées à l'objet config lorsque vous utilisez la façade MJML.

Configuration

Toutes les options de configuration peuvent être définies en appelant les méthodes suivantes directement sur l'objet MJML.

use DefectiveCode\MJML;
 
$html = (new MJML)
    ->setMinify(true)
    ->setBeautify(false)
    ->render(
        '<mjml><mj-body><mj-section><mj-column><mj-text>Hello World</mj-text></mj-column></mj-section></mj-body></mjml>'
    );

Notre package suit la même configuration que le package MJML officiel sauf pour les éléments suivants :

Polices

Notre package utilise les polices suivantes par défaut :

Vous pouvez changer les polices en utilisant les méthodes suivantes :

Commentaires

Les commentaires sont conservés par défaut. Si vous souhaitez supprimer les commentaires, vous pouvez utiliser la méthode removeComments().

Vous pouvez également revenir à removeComments() en appelant la méthode keepComments().

Ignorer les inclusions

Par défaut, notre package inclura tous les mj-include tags. Vous pouvez ajuster ce comportement en appelant la méthode ignoreIncludes(bool $ignore).

Embellissement

Notre package embellira le HTML en utilisant js-beautify avec les options par défaut suivantes :

Bien que js-beautify utilise le snake_case pour fournir des options, vous devez utiliser le camelCase lorsque vous utilisez notre package. Nous avons fait ce choix pour maintenir la cohérence de notre package avec le reste des options de configuration. Notre package convertira automatiquement les options camelCase en snake_case.

Vous pouvez remplacer l'une de ces options en fournissant une configuration valide de js-beautify en utilisant les méthodes suivantes :

Minifier

Notre package minifiera la sortie HTML lorsque cela est activé. La minification effectue les actions suivantes :

Vous pouvez activer ou désactiver la minification en appelant la méthode minify(bool $minify).

Pourquoi une minification basée sur PHP ? Le package MJML officiel utilise html-minifier pour la minification, qui présente une vulnérabilité connue ReDoS (CVE-2022-37620) sans solution disponible puisque le package n'est plus maintenu. Pour éviter d'inclure des dépendances vulnérables, nous avons déplacé la minification vers PHP en utilisant une implémentation légère et sécurisée.

Niveau de Validation

Notre package validera le MJML en utilisant le niveau de validation soft par défaut. Vous pouvez changer cela en utilisant la méthode validationLevel(ValidationLevel $validationLevel) . Voici les niveaux de validation disponibles :

Chemin de Fichier

Notre package utilisera le répertoire . par défaut. Vous pouvez changer cela en appelant la méthode filePath(string $path).

Jus

Nous ne fournissons aucune option de jus par défaut. Vous pouvez ajouter des options de jus en utilisant les méthodes suivantes :

Directives de Support

Merci d'avoir choisi notre paquet open source ! Veuillez prendre un moment pour consulter ces directives de support. Elles vous aideront à tirer le meilleur parti de notre projet.

Support Axé sur la Communauté

Notre projet open-source est alimenté par notre incroyable communauté. Si vous avez des questions ou avez besoin d'aide, StackOverflow et d'autres ressources en ligne sont vos meilleures options.

Bugs et Priorisation des Fonctionnalités

La réalité de la gestion d'un projet open-source signifie que nous ne pouvons pas traiter tous les bugs ou demandes de fonctionnalités immédiatement. Nous priorisons les problèmes dans l'ordre suivant :

1. Bugs Affectant Nos Produits Payants

Les bugs qui impactent nos produits payants seront toujours notre priorité absolue. Dans certains cas, nous ne traiterons peut-être que les bugs qui nous affectent directement.

2. Demandes de Tirage de la Communauté

Si vous avez identifié un bug et avez une solution, veuillez soumettre une demande de tirage. Après les problèmes affectant nos produits, nous accordons la prochaine priorité la plus élevée à ces corrections pilotées par la communauté. Une fois examinée et approuvée, nous fusionnerons votre solution et créditerons votre contribution.

3. Soutien Financier

Pour les problèmes en dehors des catégories mentionnées, vous pouvez choisir de financer leur résolution. Chaque problème ouvert est lié à un bon de commande où vous pouvez contribuer financièrement. Nous priorisons ces problèmes en fonction du montant du financement fourni.

Contributions de la Communauté

L'open-source prospère lorsque sa communauté est active. Même si vous ne réparez pas de bugs, envisagez de contribuer par des améliorations de code, des mises à jour de documentation, des tutoriels, ou en aidant les autres dans les canaux communautaires. Nous encourageons vivement tout le monde, en tant que communauté, à aider à soutenir le travail open-source.

Pour réitérer, DefectiveCode priorisera les bugs en fonction de leur impact sur nos produits payants, des demandes de tirage de la communauté, et du soutien financier reçu pour les problèmes.

Licence - Licence MIT

Copyright © Defective Code, LLC. Tous droits réservés

La permission est par la présente accordée, gratuitement, à toute personne obtenant une copie de ce logiciel et des fichiers de documentation associés (le "Logiciel"), de traiter le Logiciel sans restriction, y compris sans limitation les droits d'utiliser, de copier, de modifier, de fusionner, de publier, de distribuer, de sous-licencier, et/ou de vendre des copies du Logiciel, et de permettre aux personnes à qui le Logiciel est fourni de le faire, sous réserve des conditions suivantes :

L'avertissement de copyright ci-dessus et cet avis de permission doivent être inclus dans toutes les copies ou portions substantielles du Logiciel.

LE LOGICIEL EST FOURNI "EN L'ÉTAT", SANS GARANTIE D'AUCUNE SORTE, EXPRESSE OU TACITE, Y COMPRIS MAIS SANS S'Y LIMITER AUX GARANTIES DE COMMERCIALITÉ, D'ADAPTATION À UN OBJECTIF PARTICULIER ET DE NON CONTREFAÇON. EN AUCUN CAS, LES AUTEURS OU DÉTENTEURS DE DROITS D'AUTEUR NE POURRONT ÊTRE TENUS RESPONSABLES DE TOUTE RECLAMATION, DOMMAGE OU AUTRE RESPONSABILITÉ, QUE CE SOIT DANS LE CADRE D'UN CONTRAT, DUN DÉLIT OU AUTRE, DÉCOULANT DE, OU EN RELATION AVEC LE LOGICIEL OU L'UTILISATION OU AUTRES TRANSACTIONS DANS LE LOGICIEL.