Download the PHP package yassrzg/dsfr-card-image-bundle without Composer

On this page you can find all versions of the php package yassrzg/dsfr-card-image-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package dsfr-card-image-bundle

DSFR Card Image Bundle

Images adaptées aux cartes du Système de Design de l'État (DSFR) pour Symfony : chaque image est recadrée ou réduite selon un profil (cadre, mode, format, qualité), convertie en WebP, enregistrée à part des originaux et réutilisée ensuite.

Sommaire

  1. Objectifs
  2. Fonctionnalités
  3. Prérequis
  4. Installation
  5. Enregistrement du bundle
  6. Configuration
  7. Utilisation dans Twig
  8. Profils
  9. Stockage des images générées
  10. Régénération
  11. Gestion des erreurs
  12. Commande
  13. Tests et qualité
  14. Limites connues
  15. Compatibilité

Objectifs

Les composants Carte du DSFR affichent l'image dans un cadre aux proportions fixes (fr-ratio-16x9 par défaut ; 32x9, 3x2, 4x3, 1x1, 3x4, 2x3 en option), avec object-fit: cover. Envoyer au navigateur une photo de 4 000 pixels pour une carte de 400 pixels de large alourdit la page, et une image aux mauvaises proportions est coupée au hasard du cadre. Le bundle produit, côté serveur, l'image dont la carte a besoin :

Le bundle n'impose ni entité, ni Doctrine, ni structure de dossiers, ni balisage HTML : il fournit l'adresse de l'image, le balisage DSFR reste celui de l'application.

Fonctionnalités

Prérequis

Vérifier GD et WebP : php -r 'var_dump(extension_loaded("gd") && (imagetypes() & IMG_WEBP));'. Sous Debian ou Ubuntu : apt install php8.3-gd (adapter la version).

Installation

Tant que le paquet n'est pas publié sur Packagist, déclarer le dépôt Git dans le composer.json de l'application :

puis :

Une fois une version publiée (étiquette v1.0.0…), composer require yassrzg/dsfr-card-image-bundle suffit.

Enregistrement du bundle

Avec Symfony Flex, le bundle est ajouté à config/bundles.php. Sinon :

Pour servir les images d'un dossier (option source_directory) par la route du bundle, importer ses routes :

La route est GET|HEAD <préfixe>/{profile}/{path} (nom : dsfr_card_image). Les règles d'accès se posent dans l'application, par exemple :

Configuration

Toutes les options, avec leurs valeurs par défaut :

Une configuration invalide (dimension nulle, mode ou format inconnu, qualité hors limites, nom de profil invalide) est refusée au démarrage de l'application.

Utilisation dans Twig

card_image_url(image, profil) renvoie l'adresse de l'image adaptée au profil, pour l'attribut src.

Chemin relatif au dossier source (route du bundle importée) :

Objet de l'application (entité, document…) : déclarer un résolveur d'adresse. Le premier résolveur qui prend l'image en charge est utilisé ; celui du bundle (chemins) passe en dernier (priorité −100).

Avec l'autoconfiguration (par défaut dans config/services.yaml), la classe est prise en compte sans autre déclaration. Le contrôleur de l'application garde ses propres règles d'accès et confie la réponse au bundle :

Hors de Twig (contrôleur, API), le service Yassrzg\DsfrCardImageBundle\Url\ImageUrlGenerator donne la même adresse (generate($image, $profile)), et Yassrzg\DsfrCardImageBundle\ImageVariantGenerator le fichier généré (generate($cheminAbsolu, $profil) → ImageVariant : path, format, mimeType()).

Image entière (logo)

Le DSFR affiche l'image de carte en object-fit: cover. Pour une image produite par un profil contain (logo, schéma), l'afficher entière, par exemple :

Profils

Option Valeurs Défaut Rôle
width entier ≥ 1 (obligatoire) Largeur maximale de l'image produite, en pixels
height entier ≥ 1 (obligatoire) Hauteur maximale, en pixels
mode cover, contain cover cover : recadrage centré aux proportions du cadre ; contain : image entière réduite dans le cadre
format auto, webp, jpeg, png option format Format de sortie
quality 1 à 100 option quality Qualité de compression

Les noms de profils comportent des lettres minuscules, des chiffres, _ et -.

Une image n'est jamais agrandie : une source plus petite que le cadre garde sa taille (en cover, elle est seulement recadrée aux bonnes proportions).

Choisir les dimensions : largeur affichée de la carte × 2 (écrans haute densité), hauteur tirée des proportions du cadre DSFR. Exemples pour une grille fr-col-md-4 d'un conteneur DSFR (environ 400 px) :

Stockage des images générées

Régénération

Rien à faire quand un original ou un profil change : la nouvelle image est générée au premier affichage. Les anciennes images restent dans le dossier jusqu'à la purge :

Elles sont recréées à la demande. Après un changement de version de GD, purger pour profiter du nouvel encodeur.

Gestion des erreurs

Toutes les exceptions du bundle implémentent Yassrzg\DsfrCardImageBundle\Exception\ExceptionInterface :

Exception Cas
InvalidProfileException Profil mal défini (nom, dimensions, qualité)
UnknownProfileException Profil absent de la configuration
SourceNotFoundException Original absent ou illisible
UnsupportedImageException Fichier qui n'est pas une image JPEG, PNG, GIF ou WebP ; image au-delà de max_pixels ; format de sortie non géré par le GD du serveur
ImageProcessingException GD absent, image corrompue, dossier des images générées non accessible en écriture
UnresolvableImageException Aucun résolveur d'adresse pour l'objet passé à card_image_url()

ImageVariantGenerator::generate() lève ces exceptions. ImageResponseFactory::create() les traduit pour le navigateur :

Situation Réponse
Image générée L'image (image/webp…), cache navigateur, Last-Modified
Profil inconnu 404
Original absent Image de remplacement SVG neutre (cache 5 minutes)
Traitement impossible, l'original est une image L'original, avec un avertissement dans le journal (canal dsfr_card_image)
Traitement impossible, le fichier n'est pas une image Image de remplacement : le contenu du fichier n'est jamais servi

Dans un gabarit, un profil inconnu ou un objet sans résolveur provoque une erreur dès l'affichage de la page.

Commande

Commande Rôle
dsfr-card-image:purge [profil] Supprime les images générées (toutes, ou celles d'un profil) ; les originaux ne sont pas touchés

Tests et qualité

Les tests couvrent le calcul des dimensions (recadrage, ajustement, images minuscules ou très grandes, proportions quelconques), les formats d'entrée et de sortie, la transparence, l'orientation EXIF, les fichiers absents, illisibles, corrompus ou non images, les droits d'écriture, la réutilisation et la régénération des images, la préservation des originaux, la configuration (valeurs par défaut et valeurs invalides), l'enregistrement des services, la fonction Twig, la route (images, image de remplacement, 304, chemins hors du dossier) et la commande. Les tests qui produisent des images demandent l'extension GD.

Limites connues

Compatibilité

Composant Versions Vérifié avec
PHP 8.3, 8.4 8.3.36, 8.4.27
Symfony 7.4, 8.x 7.4.0 (versions les plus anciennes acceptées), 7.4.22, 8.0.15, 8.1.10
Twig 3.21 et plus 3.27
GD WebP, JPEG, PNG, GIF GD 2.3.3

Licence

GPL-2.0-or-later, voir LICENSE.

Auteur

Conçu et développé par yassine REZGUI (github.com/yassrzg).


All versions of dsfr-card-image-bundle with dependencies

PHP Build Version
Package Version
Requires php Version >=8.3
psr/log Version ^1.1|^2.0|^3.0
symfony/config Version ^7.4|^8.0
symfony/dependency-injection Version ^7.4|^8.0
symfony/filesystem Version ^7.4|^8.0
symfony/http-foundation Version ^7.4|^8.0
symfony/http-kernel Version ^7.4|^8.0
symfony/routing Version ^7.4|^8.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package yassrzg/dsfr-card-image-bundle contains the following files

Loading the files please wait ...