Pastille rouge: un exemple de filtre d’image avec la lib GD

This is an « educational contribution » which shows, with concrete example, how to develop a new functionality for SPIP.

En PHP, la bibliothèque de fonctions GD, familièrement appelée “la lib GD”, fournit de nombreuses possibilités de manipulation d’images. En alliant cette bibliothèque avec les fonctions usuelles fournies par SPIP, on peut créer très facilement ses propres filtres d’images.

Si j’ai bien compris, dans le domaine de l’art, pour indiquer qu’un tableau en exposition est vendu, on lui colle une pastille rouge en bas à droite. À titre d’exercice, on va donc faire un filtre d’image nommé image_pastillerouge qui rajoute cette pastille sur une image au format JPEG (comme c’est un tableau et un exercice, on va supposer que c’est du format JPEG, ça simplifie les traitements).

Dans notre fichier squelettes/mes_fonctions.php, on ajoute la fonction suivante [1].

function image_pastillerouge($url, $diametre=20, $distance=5) {
        $nom_fichier = extraire_attribut($url, 'src');
        $hachage = md5($nom_fichier.'+PastilleRouge');
        $tmp = sous_repertoire(_DIR_VAR, "cache-gd2");
        $cache = $tmp.$hachage.'.jpg';
        if (!file_exists($cache)) {
                $image = imagecreatefromjpeg($nom_fichier);
                $rouge = imagecolorallocate($image, 255, 0, 0);
                $centre_x = imagesx($image) - $diametre/2 - $distance;
                $centre_y = imagesy($image) - $diametre/2 - $distance;
                imagefilledellipse($image, $centre_x, $centre_y, $diametre, $diametre, $rouge);
                imagejpeg($image, $cache);
        }
        return "<img src=\"$cache\" />";
}

Les explications, ligne par ligne :

  1. Étant un filtre d’image, SPIP va donner à cette fonction, en premier argument, une balise HTML img. On définit aussi un diamètre de pastille par défaut et une distance au bord par défaut.
  2. On extrait le nom de fichier de la balise image.
  3. On calcule un nom de fichier unique pour garder le résultat en cache, histoire de ne pas avoir à refaire le calcul à chaque fois.
  4. On détermine le répertoire dans lequel le résultat sera gardé en cache.
  5. On détermine le chemin du fichier de cache d’après le répertoire et le nom unique.
  6. Si on n’a pas encore de cache pour cette image, on fait les calculs, sinon non.
  7. On charge les données de l’image de base en mémoire.
  8. On fait notre petit mélange, comme les peintres: 255 de rouge (la valeur maximale), 0 de vert, 0 de bleu, et on touille.
  9. On calcule les coordonnées du centre de la pastille sur l’axe horizontal: largeur de l’image moins le rayon voulu, moins une distance pour que la pastille ne soit pas collée au bord.
  10. Idem sur l’axe vertical.
  11. On applique une ellipse sur l’image aux coordonnées calculées. Comme on veut un rond, l’ellipse a une largeur et une hauteur égales.
  12. On enregistre dans le fichier cache dont on a préparé le nom.
  13. ...
  14. On reconstruit une balise img qu’on renvoie à SPIP.

Comment utiliser ce filtre ?

Pour utiliser ce filtre, il suffit de l’appeler comme n’importe quel filtre d’image dans un squelette. Par exemple :

[(#LOGO_ARTICLE||image_reduire{200,200}|image_pastillerouge)]

Vous pouvez ajouter des arguments optionnels de diamètre et de distance si vous voulez changer ponctuellement les valeurs par défaut, ce qui donne par exemple:

[(#LOGO_ARTICLE||image_reduire{200,200}|image_pastillerouge{30, 2})]

Si ça concerne tout le site, vous pouvez aussi changer ces valeurs directement dans la déclaration de la fonction (première ligne).

Footnotes

[1Toutes les fonctions de traitement d’images sont documentées dans le chapitre de la documentation PHP traitant de la lib GD.

updated on 19 August 2009

Discussion

2 discussions

  • 1

    Merci pour ces explications. J’ai cherché en vain de la documentation sur comment écrire un filtre d’image (d’où la motivation de cet article), du coup ces explications tombent très bien. Mais est-ce que ça ne vaudrait pas le coup de documenter tout ça “officiellement” ? (mes excuses par avance si cette doc existe et que je l’ai loupée)

    • Effectivement, comme l’auteur de cet exemple, c’est en recherchant de la doc que...

      Existe-t-il une documentation de référence chez SPIP sur les normes à respecter pour écrire des filtres d’image, sans avoir à décortiquer les exemples de nos bons maîîîîtres.... ? (encore que l’on a ici des explications claires)

      ... plus peut-être qq exemples de mise en oeuvre dans squelettes / modèles / textes d’articles...

      Merci à tous pour ces travaux communautaires.

    Reply to this message

  • Attention, cette contribution montre un exemple erroné.
    Les filtres images dont le nom commence par image_ doivent tous suivre et respecter la construction de ceux du core, à savoir :

    function image_exemple($im, ...)
    {
    	$fonction = array('image_exemple', func_get_args());
    	$image = image_valeurs_trans($im, "image_exemple", false,$fonction);
    
    	if (!$image) return("");
    	
    	$x_i = $image["largeur"];
    	$y_i = $image["hauteur"];
    	
    	$im = $image["fichier"];
    	$dest = $image["fichier_dest"];
    	
    	$creer = $image["creer"];
    	
    	if ($creer) {
    		$im = $image["fonction_imagecreatefrom"]($im);
    		imagepalettetotruecolor($im);
    		$im_ = imagecreatetruecolor($x_i, $y_i);
    
    		// ... traitement de l'image ...
    
    		image_gd_output($im_,$image);
    		imagedestroy($im_);
    		imagedestroy($im);
    	}
    	
    	return image_ecrire_tag($image,array('src'=>$dest));
    }

    Il est donc obligatoire :
    -  d’utiliser image_valeur_trans en entrée pour analyser l’image source et recuperer ses propriétés, en donnant comme information le nom et les arguments de la fonction
    -  de finir par image_ecrire_tag pour produire le html de l’image.

    Ces contraintes sont nécessaires pour permettre à SPIP de gèrer la suppression automatique des images temporaires intermédiaires.

    A défaut, si vous ne voulez pas respecter cette écriture, il faut nommer la fonction autrement, sans la faire commencer par le prefixe image_

    Reply to this message

Comment on this article

Who are you?
  • [Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom