Programmation PHP/Symfony/Composant


DescriptionModifier

Le framework Symfony possède des dizaines de composants[1], 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-bundleModifier

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

consoleModifier

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

php bin/console help list

dotenvModifier

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

IS_DEV_SERVER=1

Le parameters.yml récupère ensuite cette valeur et vérifie qu'il s'agit d'un booléen :

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

yamlModifier

Ajoute la conversion de fichier YAML en tableau PHP[5]. 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.

routingModifier

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.

serializerModifier

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

 composer require symfony/serializer

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

formModifier

Construit des formulaires HTML.


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

validatorModifier

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.

translationModifier

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-dispatcherModifier

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.

processModifier

Permet de lancer des sous-processus en parallèle[7]. 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[8] :

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

cacheModifier

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

assetModifier

Fonction Twig pour accéder aux fichiers CSS, JS ou images.

webpack-encoreModifier

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

messengerModifier

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[9]. 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;

workflowModifier

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

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

configModifier

Permet de manipuler des fichiers de configurations.

contractsModifier

Pour la programmation par contrat.

css-selectorModifier

Pour utiliser XPath.

debugModifier

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

dependency-injectionModifier

Normalise l'utilisation du container de services.

dom-crawlerModifier

Fournit des méthodes pour parcourir le DOM.

expression-languageModifier

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

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

filesystemModifier

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

finderModifier

Recherche dans les dossiers et fichiers.

securityModifier

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.

guardModifier

Extension de sécurité pour des authentifications complexes.

http-clientModifier

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


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

http-foundationModifier

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-kernelModifier

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

inflectorModifier

Deprecated depuis Symfony 5.

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

intlModifier

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

ldapModifier

Connexion aux serveur LDAP.

lockModifier

Pour verrouiller les accès aux ressources.

mailerModifier

Pour envoyer des emails.

mimeModifier

Manipulation des messages MIME.

notifierModifier

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

options-resolverModifier

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

phpunit-bridgeModifier

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-accessModifier

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

property-infoModifier

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

stopwatchModifier

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

runtimeModifier

Deprecated depuis Symfony 5.3. Permettre de découpler l'application de son code de retour.

stringModifier

API convertissant certains objets en chaine de caractères.

templatingModifier

Extension de construction de templates.


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

var-dumperModifier

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-exporterModifier

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ésuetsModifier

icuModifier

Fermé en 2014.

localeModifier

Arrêté dans Symfony 2.2.

class-loaderModifier

Retiré depuis Symfony 4.0.

Composants non listés comme telsModifier

apache-packModifier

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

Ajoutés en 2020Modifier

UidModifier

RateLimiterModifier

SemaphoreModifier

RéférencesModifier