Programmation PHP/Symfony/Composant

Un livre de Wikilivres.
Aller à la navigation Aller à la recherche

Description[modifier | modifier le wikicode]

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 | modifier le wikicode]

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

console[modifier | modifier le wikicode]

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

dotenv[modifier | modifier le wikicode]

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'

yaml[modifier | modifier le wikicode]

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 | modifier le wikicode]

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/Symfony#Routing.

serializer[modifier | modifier le wikicode]

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.

form[modifier | modifier le wikicode]

Construit des formulaires HTML.


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

validator[modifier | modifier le wikicode]

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 | modifier le wikicode]

Module de traductions dans des fichiers contenant le ISO 639-1 de chaque langue du projet. Par défaut le français est dans translations/messages.fr.yml. On peut ensuite récupérer ces dictionnaires en Twig, ou en PHP via le service "translator".

event-dispatcher[modifier | modifier le wikicode]

Patrons de conception "Observateur"[10] et "Médiateur"[11].

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


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

process[modifier | modifier le wikicode]

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

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

Logo

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[13] :

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

cache[modifier | modifier le wikicode]

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.

asset[modifier | modifier le wikicode]

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

webpack-encore[modifier | modifier le wikicode]

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

Installation[15] :

composer install encore
yarn install
yarn build

NB : si yarn n'est pas installé, le faire avec 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.

messenger[modifier | modifier le wikicode]

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[16]. 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 | modifier le wikicode]

Patrons de conception "État".

Ce composant nécessite de créer (en YAML, XML ou PHP) la configuration d'un automate fini[17], 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 | modifier le wikicode]

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

config[modifier | modifier le wikicode]

Permet de manipuler des fichiers de configurations.

contracts[modifier | modifier le wikicode]

Pour la programmation par contrat.

css-selector[modifier | modifier le wikicode]

Pour utiliser XPath.

debug[modifier | modifier le wikicode]

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

dependency-injection[modifier | modifier le wikicode]

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[18].

dom-crawler[modifier | modifier le wikicode]

Fournit des méthodes pour parcourir le DOM.

expression-language[modifier | modifier le wikicode]

Patrons de conception "Interpréteur".

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

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 | modifier le wikicode]

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

finder[modifier | modifier le wikicode]

Recherche dans les dossiers et fichiers.

security[modifier | modifier le wikicode]

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().

guard[modifier | modifier le wikicode]

Extension de sécurité pour des authentifications complexes.

http-client[modifier | modifier le wikicode]

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


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

http-foundation[modifier | modifier le wikicode]

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 | modifier le wikicode]

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

inflector[modifier | modifier le wikicode]

Deprecated depuis Symfony 5.

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

intl[modifier | modifier le wikicode]

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

ldap[modifier | modifier le wikicode]

Connexion aux serveur LDAP.

lock[modifier | modifier le wikicode]

Pour verrouiller les accès aux ressources.

mailer[modifier | modifier le wikicode]

Pour envoyer des emails.

mime[modifier | modifier le wikicode]

Manipulation des messages MIME.

notifier[modifier | modifier le wikicode]

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

options-resolver[modifier | modifier le wikicode]

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

phpunit-bridge[modifier | modifier le wikicode]

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 | modifier le wikicode]

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

property-info[modifier | modifier le wikicode]

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

stopwatch[modifier | modifier le wikicode]

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

string[modifier | modifier le wikicode]

API convertissant certains objets en chaine de caractères.

templating[modifier | modifier le wikicode]

Extension de construction de templates.


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

var-dumper[modifier | modifier le wikicode]

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 | modifier le wikicode]

Permet d'instancier une classe sans utiliser son constructeur.

polyfill*[modifier | modifier le wikicode]

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 | modifier le wikicode]

locale (<= v2.3)[modifier | modifier le wikicode]

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

icu (<= v2.6)[modifier | modifier le wikicode]

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

class-loader (<= v3.3)[modifier | modifier le wikicode]

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

Ajoutés en 2020[modifier | modifier le wikicode]

Uid (>= v5.1)[modifier | modifier le wikicode]

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

RateLimiter (>= v5.2)[modifier | modifier le wikicode]

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

Semaphore (>= v5.2)[modifier | modifier le wikicode]

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

Ajoutés en 2021[modifier | modifier le wikicode]

PasswordHasher (>= v5.3)[modifier | modifier le wikicode]

Pour gérer les chiffrements[26].

Runtime (>= v5.3)[modifier | modifier le wikicode]

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

Ajoutés en 2022[modifier | modifier le wikicode]

HtmlSanitizer (=> v6.1)[modifier | modifier le wikicode]

Clock (=> v6.2)[modifier | modifier le wikicode]

Symfony UX[modifier | modifier le wikicode]

ux-autocomplete[modifier | modifier le wikicode]

ux-chartjs[modifier | modifier le wikicode]

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

ux-react[modifier | modifier le wikicode]

Ajoute le framework React.js.

ux-vue[modifier | modifier le wikicode]

Ajoute le framework Vue.js.

Composants non listés comme tels[modifier | modifier le wikicode]

apache-pack[modifier | modifier le wikicode]

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

Références[modifier | modifier le wikicode]

  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. http://www.jpsymfony.com/design_patterns/le-design-pattern-observer-avec-symfony2
  11. https://github.com/certificationy/symfony-pack/blob/babd3fee68a7e793767f67c6df140630f52e7f8d/data/architecture.yml#L13
  12. https://symfony.com/doc/current/components/process.html
  13. https://gist.github.com/appaydin/42eaf953172fc7ea6a8b193694645324
  14. https://symfony.com/doc/current/components/asset.html
  15. https://symfonycasts.com/screencast/stimulus/encore
  16. https://vria.eu/delve_into_the_heart_of_the_symfony_messenger/
  17. https://symfony.com/doc/current/workflow.html
  18. https://symfony.com/doc/current/components/dependency_injection/compilation.html
  19. https://symfony.com/doc/current/components/expression_language.html
  20. https://symfony.com/components/Locale
  21. https://symfony.com/components/Icu
  22. https://symfony.com/components/ClassLoader
  23. https://symfony.com/doc/current/components/uid.html
  24. https://symfony.com/doc/current/rate_limiter.html
  25. https://symfony.com/doc/current/components/semaphore.html
  26. https://symfony.com/blog/new-in-symfony-5-3-passwordhasher-component
  27. https://symfony.com/blog/new-in-symfony-5-3-runtime-component
  28. https://symfony.com/bundles/ux-chartjs/current/index.html