Programmation PHP avec Symfony/Composant

Description

modifier

Le framework Symfony permet nativement les fonctionnalités minimum dans un souci de performances, à l'instar d'un micro-framework. Par exemple son compilateur permet d'utiliser plusieurs patrons de conception (design patterns) via des mots réservés dans services.yaml :


Toutefois, on peut lui ajouter des composants[2], dont il convient de connaitre les fonctionnalités pour ne pas réinventer la roue. Pour les installer :

composer require symfony/nom_du_composant

Les quatre premiers ci-dessous sont inclus par défaut dans le microframework symfony/skeleton.

framework-bundle

modifier

Structure la configuration principale du framework sans laquelle aucun composant n'est installable[3].

console

modifier

Patrons de conception "Commande".

Fournit la possibilité d'exécuter le framework avec des commandes shell[4]. Par exemple pour obtenir la liste de toutes les commandes disponibles dans un projet :

php bin/console help list

Gère les variables d'environnement non versionnées, contenues dans un fichier .env[5]. Elles peuvent aussi bénéficier de type checking en préfixant les types avec ":". Ex de .env :

IS_DEV_SERVER=1

Le services.yaml, parameters: récupère ensuite cette valeur et vérifie qu'il s'agit d'un booléen (via le processeur de variable d'environnement "bool") :

is_dev_server: '%env(bool:IS_DEV_SERVER)%'

Il existe plusieurs processeurs de variable d'environnement (en plus de "bool" et des autres types)[6] :

  • base64: encode en base64.
  • default: remplace le deuxième paramètre par le premier si absent. Ex :
    • $addTestValues: '%env(bool:default::ADD_TEST_VALUES)%' injecte "null" si ADD_TEST_VALUES n'est pas défini.
    • $addTestValues: '%env(bool:default:ADD_TEST_VALUES2:ADD_TEST_VALUES1)%' injecte le contenu de ADD_TEST_VALUES2 si ADD_TEST_VALUES1 n'est pas défini.
  • file: remplace le chemin d'un fichier par son contenu.
  • not: renvoie l'inverse.
  • require: fait un require() PHP.
  • resolve: remplace le nom d'une variable par sa valeur.
  • trim: fait un trim() PHP.

Pour définir une valeur par défaut en cas de variable d'environnement manquante (sans utiliser default:), dans services.yaml, parameters: :

env(MY_MISSING_CONSTANT): '0'

Ajoute la conversion de fichier YAML en tableau PHP[7]. Ce format de données constitue une alternative plus lisible au XML pour renseigner la configuration des services. Par défaut le framework se configure avec config.yaml.

routing

modifier

patron de conception "Façade".

Installe les annotations permettant de router des URLs vers les classes des contrôleurs MVC.


Pour plus de détails voir : Programmation PHP avec Symfony/Contrôleur#Routing.

serializer

modifier

Permet de convertir des objets en tableaux ou dans les principaux formats de notation : JSON, XML, YAML et CSV[8].

 composer require symfony/serializer

Ce composant est notamment utilisé pour créer des APIs.

Construit des formulaires HTML.


Pour plus de détails voir : Programmation PHP avec Symfony/Formulaire.

validator

modifier

Fournit des règles de validation pour les données telles que les adresses emails ou les codes postaux. Utile à coupler avec les formulaires pour contrôler les saisies.

Ces règles peuvent porter sur les propriétés ou les getters.

Il permet aussi de créer des groupes de validateurs, et de les ordonner par séquences. Par défaut chaque classe a automatiquement deux groupes de validateurs : "default" et celui de son nom. Si une séquence est définie, le groupe "default" n'est plus égal au groupe de la classe (celui par défaut) mais à la séquence par défaut[9].

translation

modifier

Les traductions sont stockées dans un fichier différent par domaine et par langue (code ISO 639). Les formats acceptés sont YAML, XML, PHP[10].

On peut ensuite récupérer ces dictionnaires en Twig (via le filtre "trans"), ou en PHP (via le service "translator").

Par exemple, le domaine par défaut étant "messages", le français se trouve donc dans translations/messages.fr.yml ou translations/messages.fr-FR.yml.

Installation

modifier
 composer require symfony/translation

Pour avoir les traductions inutilisées en anglais :

 bin/console debug:translation en --only-unused

Pour les traductions manquantes en anglais :

 bin/console debug:translation en --only-missing

On peut restreindre à un seul domaine avec une option : --domain=mon_domaine

Traduction en PHP

modifier

Le domaine et la langue sont facultatifs (car ils ont des valeurs par défaut) :

 $translator->trans('Hello World', domain: 'login', locale: 'fr_FR');
 le composant Symfony Form appelle automatiquement Translations pour ses "labels".

Traduction en Twig

modifier

Les traductions en Twig sont appelées par le filtre "trans" :

 {% trans_default_domain 'login' %}
 {{ 'Hello World' |trans }}

Ou :

 {{ 'Hello World' |trans({}, 'login', 'fr-FR') }}

Variables

modifier
  • YAML : la variable est entre accolades (selon la norme de l'ICU[11])
 Hello World: 'Hello World name!'
  • Twig :
 {{ Hello World |trans({"name": userName}) }}
  • PHP
 $translator->trans('Hello World', ['name' => $userName]);

Dans un formulaire Symfony :

        $builder
            ->add('hello', TextType::class,([
                'label' => 'Hello World',
                'label_translation_parameters' => [
                    'name' => $userName,
                ]
            ]))
        ;

Par défaut le domaine de traduction est "message" mais on peut désactiver ces dernières avec : choice_translation_domain => false.

event-dispatcher

modifier

Patrons de conception "Observateur"[12] et "Médiateur"[13].

Assure la possibilité d'écouter des évènements pour qu'ils déclenchent des actions.


Pour plus de détails voir : Programmation PHP avec Symfony/Évènement.

process

modifier

Permet de lancer des sous-processus en parallèle[14]. Exemple qui lance une commande shell :

    $process = new Process(['ls']);
    $process->run();

 

En l'absence de $process->stop() ou de timeout, le sous-processus peut être stoppé en redémarrant le serveur PHP.

Exemple de requête SQL asynchrone[15] :

        $sql = 'SELECT * FROM ma_table LIMIT 1';
        $process = Process::fromShellCommandline(sprintf('../bin/console doctrine:query:sql "%s"', $sql));
        $process->setTimeout(3600);
        $process->start();

Gère les connexions, lectures et écritures vers des serveurs de mémoire caches tels que Redis ou Memcached.

Il fournit une classe cacheItem conforme à la PSR, instanciable par plusieurs adaptateurs.

Le cache ne sert qu'à accélérer l'application donc une panne sur celui-ci ne doit pas la bloquer. C'est pourquoi il vaut mieux avoir un ou plusieurs caches de secours, même moins rapides, pour prendre le relais dans une chaine de caches.

Pour mettre cela en place sur Symfony, définir le chaine et ses composants dans cache.yaml.


Pour plus de détails voir : Programmation PHP/Redis#Dans Symfony.

Ajoute la fonction Twig asset() pour accéder aux fichiers CSS, JS ou images selon leurs versions[16].

webpack-encore

modifier

Intégration de Webpack pour gérer la partie front end (ex : minifications des CSS et JS).

Installation[17]

modifier
 composer require symfony/webpack-encore-bundle
 yarn install
 yarn build

NB : si Yarn n'est pas installé, le faire avec npm : apt install nodejs npm; npm install --global yarn.

Cela crée les fichiers package.json et yarn.lock contenant les dépendances JavaScript, le dossier assets/ contenant les JS et CSS versionnés, et le fichier webpack.config.js dans lequel ils sont appelés.

De plus, des fonctions Twig permettent d'y accéder depuis les templates : encore_entry_link_tags() et encore_entry_script_tags().

Par ailleurs, cela installe le framework JS Stimulus, et interprète les attributs de données pour appeler ses contrôleurs ou méthodes.

Rebuild

modifier

Pour que le code se build en cours de frappe, deux solutions[18] :

  • Avec Yarn :
    • yarn watch
    • yarn dev-server
  • Avec npm :
    • npm watch
    • npm run dev-server

La différence entre les deux est que le dev-server peut mettre à jour la page sans même la rafraichir.

messenger

modifier

Patrons de conception "Chaîne de responsabilité".

Messenger permet d'utiliser des queues au protocole AMQP. En résumé, il gère l'envoi de messages dans des bus, ces messages transitent par d'éventuels middlewares puis arrivent à destination dans des handlers[19]. On peut aussi persister ces messages en les envoyant dans des transports via un DSN, par exemple dans RabbitMQ, Redis ou Doctrine (donc une table des SGBD les plus populaires).

 php bin/console debug:messenger

Chaque middleware doit passer le relais au suivant ainsi :

return $stack->next()->handle($envelope, $stack);

Pour stopper le message dans un middleware sans qu'il arrive aux handlers :

return $envelope;

workflow

modifier

Patrons de conception "État".

Ce composant nécessite de créer (en YAML, XML ou PHP) la configuration d'un automate fini[20], c'est-à-dire la liste de ses transitions et états (appelés "places").

Ces graphes sont ensuite visualisables en image ainsi :

use Symfony\Component\Workflow\Definition;
use Symfony\Component\Workflow\Dumper\StateMachineGraphvizDumper;

class WorkflowDisplayer
...
$definition = new Definition($places, $transitions);
echo (new StateMachineGraphvizDumper())->dump($definition);
sudo apt install graphviz
php WorkflowDisplayer.php | dot -Tpng -o workflow.png

browser-kit

modifier

Simule un navigateur pour les tests d'intégration.

Permet de manipuler des fichiers de configurations.

contracts

modifier

Pour la programmation par contrat.

css-selector

modifier

Pour utiliser XPath.

Fournit des méthodes statiques pour déboguer le PHP.

dependency-injection

modifier

Normalise l'utilisation du container de services.

Permet aussi d'exécuter du code pendant la compilation via un compiler pass, en implémentant l'interface CompilerPassInterface avec sa méthode process[21].

dom-crawler

modifier

Fournit des méthodes pour parcourir le DOM.

expression-language

modifier

Patrons de conception "Interpréteur".

Expression language sert à évaluer des expressions, ce qui peut permettre de définir des règles métier[22].

Installation :

composer require symfony/expression-language

Exemple :

$el = new ExpressionLanguage();
$operation = '1 + 2';
echo(
    sprintf(
        "L'opération %s vaut %s",
        $el->compile($operation));
        $el->evaluate($operation));
    )
);
// Affiche : L'opération 1 + 2 vaut 3

filesystem

modifier

Méthodes de lecture et écriture dans les dossiers et fichiers.

Recherche dans les dossiers et fichiers.

security

modifier

Ensemble de sous-composants assurant la sécurité d'un site. Ex : authentification, anti-CSRF ou droit des utilisateurs d'accéder à une page.

Dans security.yaml, on peut par exemple définir les classes qui vont assurer l'authentification (guard), ou celle User qui sera instanciée après.

Pour obtenir l'utilisateur ou son token, on peut injecter :

TokenStorageInterface $tokenStorage

pour avoir l'utilisateur courant avec $this->tokenStorage->getToken()->getUser().

Extension de sécurité pour des authentifications complexes.

http-client

modifier

Pour lancer des requêtes HTTP depuis l'application.


Pour plus de détails voir : Programmation PHP avec Symfony/HttpClient.

http-foundation

modifier

Fournit des classes pour manipuler les requêtes HTTP, comme Request et Response que l'on retrouve dans les contrôleurs.

Par exemple :

use Symfony\Component\HttpFoundation\Response;
//...
echo Response::HTTP_OK; // 200
echo Response::HTTP_NOT_FOUND; // 404

http-kernel

modifier

Permet d'utiliser des évènements lors des transformations des requêtes HTTP en réponses.

inflector

modifier

Deprecated depuis Symfony 5.

Accorde les mots anglais au pluriel à partir de leurs singuliers.

Internationalisation, comme par exemple la classe "Locale" pour gérer une langue.

Connexion aux serveur LDAP.

Pour verrouiller les accès aux ressources[23].

Par exemple, pour ne pas qu'une commande soit lancée deux fois simultanément, bien que le composant console aie aussi cette fonctionnalité :

 use Symfony\Component\Console\Command\LockableTrait;
 ...
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        if ($this->lock() === false) {
            return Command::SUCCESS;
        }

        ...

        $this->release();
        return Command::SUCCESS;
    }

Pour envoyer des emails.

Manipulation des messages MIME.

notifier

modifier

Pour envoyer des notifications telles que des emails, des SMS, des messages instantanés, etc.

options-resolver

modifier

Gère les remplacements de propriétés par d'autres, avec certaines par défaut.

phpunit-bridge

modifier

Patron de conception "Pont" qui apporte plusieurs fonctionnalités liées aux tests unitaires, telles que la liste des tests désuets ou des mocks de fonctions PHP natif.

property-access

modifier

Pour lire les attributs de classe à partir de leurs getters, ou des tableaux.

property-info

modifier

Pour lire les métadonnées des attributs de classe.

stopwatch

modifier

Chronomètre pour mesurer des temps d'exécution.

API convertissant certains objets en chaine de caractères. Ex :

use Symfony\Component\String\Slugger\AsciiSlugger;

$slugger = new AsciiSlugger();
echo $slugger->slug('caractères spéciaux € $');

Résultat :

caracteres-speciaux-EUR

templating

modifier

Extension de construction de templates.


Pour plus de détails voir : Programmation PHP avec Symfony/Templating.

var-dumper

modifier

Ajoute une fonction globale dump() pour déboguer des objets en les affichant avec une coloration syntaxique et des menus déroulant.

Ajoute aussi dd() pour dump() and die().

var-exporter

modifier

Permet d'instancier une classe sans utiliser son constructeur.

polyfill*

modifier

On trouve aussi une vingtaine de composants polyfill, fournissant des fonctions PHP retirées dans les versions les plus récentes.

Composants désuets

modifier

locale (<= v2.3)

modifier

Arrêté en 2011, car remplacé par le composant intl[24].

icu (<= v2.6)

modifier

Arrêté en 2014, car remplacé par le composant intl[25].

class-loader (<= v3.3)

modifier

Arrêté en 2011, car remplacé par composer.json[26].

Ajoutés en 2020

modifier

Uid (sic) (>= v5.1)

modifier

Pour générer des UUID[27].

RateLimiter (>= v5.2)

modifier

Patron de conception "Proxy", qui permet de limiter la consommation de ressources du serveur par les clients[28]

Semaphore (>= v5.2)

modifier

Pour donner l'exclusivité d'accès à une ressource[29].

Ajoutés en 2021

modifier

PasswordHasher (>= v5.3)

modifier

Pour gérer les chiffrements[30].

Runtime (>= v5.3)

modifier

Pour le démarrage (bootstrap) : permettre de découpler l'application de son code de retour. [31].

Ajoutés en 2022

modifier

HtmlSanitizer (>= v6.1)

modifier

Clock (>= v6.2)

modifier

Symfony UX (>= v5.4)

modifier

ux-autocomplete

modifier

ux-chartjs

modifier

Utilise Chart.js via Stimulus pour afficher des graphiques, via la fonction Twig render_chart()[32].

ux-react

modifier

Ajoute le framework React.js.


Pour plus de détails voir : Programmation PHP avec Symfony/Stimulus.

Ajoute le framework Vue.js.

Ajoutés en 2023

modifier

Webhook et RemoteEvent (>= v6.3)

modifier

[33]

AssetMapper (>= v6.3)

modifier

[34]

Scheduler (>= v6.3)

modifier

[35]

Composants non listés comme tels

modifier

apache-pack

modifier

Pour faire tourner le site sans passer par le serveur symfony server:start.

Références

modifier
  1. https://symfony.com/doc/current/service_container/factories.html
  2. https://symfony.com/components
  3. https://symfony.com/doc/current/reference/configuration/framework.html
  4. https://symfony.com/doc/current/components/console.html
  5. https://symfony.com/doc/current/components/dotenv.html
  6. https://symfony.com/doc/current/configuration/env_var_processors.html
  7. https://symfony.com/doc/current/components/yaml.html
  8. https://symfony.com/doc/current/components/serializer.html
  9. https://symfony.com/doc/current/validation/sequence_provider.html
  10. https://symfony.com/doc/current/translation.html
  11. https://symfony.com/doc/current/reference/formats/message_format.html
  12. http://www.jpsymfony.com/design_patterns/le-design-pattern-observer-avec-symfony2
  13. https://github.com/certificationy/symfony-pack/blob/babd3fee68a7e793767f67c6df140630f52e7f8d/data/architecture.yml#L13
  14. https://symfony.com/doc/current/components/process.html
  15. https://gist.github.com/appaydin/42eaf953172fc7ea6a8b193694645324
  16. https://symfony.com/doc/current/components/asset.html
  17. https://symfonycasts.com/screencast/stimulus/encore
  18. https://symfony.com/doc/current/frontend/encore/simple-example.html
  19. https://vria.eu/delve_into_the_heart_of_the_symfony_messenger/
  20. https://symfony.com/doc/current/workflow.html
  21. https://symfony.com/doc/current/components/dependency_injection/compilation.html
  22. https://symfony.com/doc/current/components/expression_language.html
  23. https://symfony.com/doc/current/components/lock.html
  24. https://symfony.com/components/Locale
  25. https://symfony.com/components/Icu
  26. https://symfony.com/components/ClassLoader
  27. https://symfony.com/doc/current/components/uid.html
  28. https://symfony.com/doc/current/rate_limiter.html
  29. https://symfony.com/doc/current/components/semaphore.html
  30. https://symfony.com/blog/new-in-symfony-5-3-passwordhasher-component
  31. https://symfony.com/blog/new-in-symfony-5-3-runtime-component
  32. https://symfony.com/bundles/ux-chartjs/current/index.html
  33. https://symfony.com/blog/new-in-symfony-6-3-webhook-and-remoteevent-components
  34. https://symfony.com/blog/new-in-symfony-6-3-assetmapper-component
  35. https://symfony.com/blog/new-in-symfony-6-3-scheduler-component