Fichier ecrire/inc/filtres_images_lib_mini.php

Ce fichier contient les fonctions utilisées par les fonctions-filtres de traitement d'image.

Source

Liste des constantes

_CONVERT_COMMAND

Valeur

  • 'convert'

Package

Source

_PNMSCALE_COMMAND

Valeur

  • 'pnmscale'

Package

Source

_RESIZE_COMMAND

Valeur

  • _CONVERT_COMMAND . ' -quality ' . _IMG_CONVERT_QUALITE . ' -resize %xx%y! %src %dest'

Package

Source

_SVG_SUPPORTED

Valeur

  • true

Package

Source

Liste des fonctions

_couleur_dec_to_hex()

Transforme une couleur vectorielle R,G,B en hexa (par exemple pour usage css)
string _couleur_dec_to_hex( integer $red , integer $green , integer $blue )

Paramètres

  1. integer $red

    Valeur du rouge de 0 à 255.

  2. integer $green

    Valeur du vert de 0 à 255.

  3. integer $blue

    Valeur du bleu de 0 à 255.

Retour

  • string

    Le code de la couleur en hexadécimal.

Utilisé par

Package

Source

_couleur_hex_to_dec()

Transforme une couleur hexa en vectorielle R,G,B
array _couleur_hex_to_dec( string $couleur )

Paramètres

  1. string $couleur

    Code couleur en hexa (#000000 à #FFFFFF).

Retour

  • array

    Un tableau des 3 éléments : rouge, vert, bleu.

Utilisé par

Package

Source

_couleur_hex_to_hsl()

Transforme une couleur vectorielle H,S,L en hexa (par exemple pour usage css)
array _couleur_hex_to_hsl( string $couleur )

Paramètres

  1. string $couleur

    Code couleur en hexa (#000000 à #FFFFFF).

Retour

  • array

    Un tableau des 3 éléments : teinte, saturation, luminosité.

Package

Source

_couleur_hsl_to_hex()

Transforme une couleur vectorielle H,S,L en hexa (par exemple pour usage css)
string _couleur_hsl_to_hex( integer $hue , integer $saturation , integer $lightness )

Paramètres

  1. integer $hue

    Valeur de teinte de 0 à 1.

  2. integer $saturation

    Valeur de saturation de 0 à 1.

  3. integer $lightness

    Valeur de luminosité de 0 à 1.

Retour

  • string

    Le code de la couleur en hexadécimal.

Package

Source

_couleur_hsl_to_rgb()

Transformation d'une couleur HSL en RGB

HSL float entre 0 et 1 RGB entiers entre 0 et 255

array _couleur_hsl_to_rgb( float $H , float $S , float $L )

Paramètres

  1. float $H
  2. float $S
  3. float $L

Retour

  • array

Utilisé par

Package

Source

_couleur_rgb_to_hsl()

Transformation d'une couleur RGB en HSL

HSL float entre 0 et 1 RGB entiers entre 0 et 255

array _couleur_rgb_to_hsl( integer $R , integer $G , integer $B )

Paramètres

  1. integer $R
  2. integer $G
  3. integer $B

Retour

  • array

Utilisé par

Package

Source

_image_creer_vignette()

Crée si possible une miniature d'une image
array | null _image_creer_vignette( array $valeurs , integer $maxWidth , integer $maxHeight , string $process = 'AUTO' , boolean $force = false )

Paramètres

  1. array $valeurs

    Description de l'image, telle que retournée par _image_valeurs_trans()

  2. integer $maxWidth

    Largeur maximum en px de la miniature à réaliser

  3. integer $maxHeight

    Hauteur maximum en px de la miniateure à réaliser

  4. string $process = 'AUTO'

    Librairie graphique à utiliser (gd1, gd2, netpbm, convert, imagick). AUTO utilise la librairie sélectionnée dans la configuration.

  5. boolean $force = false

Retour

  • array | null

    Description de l'image, sinon null.

Voir également

Utilise

Utilisé par

Package

Source

_image_ecrire_tag()

Écriture de la balise img en sortie de filtre image

Reprend le tag initial et surcharge les attributs modifiés

string _image_ecrire_tag( array $valeurs , array $surcharge = array() )

Paramètres

  1. array $valeurs

    Description de l'image tel que retourné par _image_valeurs_trans()

  2. array $surcharge = array()

    Permet de surcharger certaines descriptions présentes dans $valeurs tel que 'style', 'width', 'height'

Retour

  • string

    Retourne le code HTML de l'image

Voir également

Utilise

Utilisé par

Appelle le pipeline

Package

Source

_image_extension_normalisee()
void _image_extension_normalisee( $extension )

Paramètres

  1. $extension

Package

Source

_image_extensions_acceptees_en_entree()
array _image_extensions_acceptees_en_entree( )

Retour

  • array

Package

Source

_image_extensions_acceptees_en_sortie()
array | array<mixed,string> | null _image_extensions_acceptees_en_sortie( )

Retour

  • array | array<mixed,string> | null

Package

Source

_image_extensions_conservent_transparence()
void _image_extensions_conservent_transparence( )

Package

Source

_image_gd_output()

Finalise le traitement GD

Crée un fichier_image temporaire .src ou vérifie que le fichier_image définitif a bien été créé.

boolean _image_gd_output( resource | string $img , array $valeurs , integer $qualite = _IMG_GD_QUALITE , $fonction = null )

Paramètres

  1. resource | string $img

    Une ressource de type Image GD (ou une string pour un SVG)

  2. array $valeurs

    Un tableau des informations (tailles, traitement, path...) accompagnant l'image.

  3. integer $qualite = _IMG_GD_QUALITE

    N'est utilisé que pour les images jpg. Le niveau de qualité du fichier résultant : de 0 (pire qualité, petit fichier) à 100 (meilleure qualité, gros fichier). Par défaut, prend la valeur (85) de la constante _IMG_GD_QUALITE (modifiable depuis mes_options.php).

  4. $fonction = null

Retour

  • boolean
    • true si le traitement GD s'est bien finalisé ;
    • false sinon.

Utilise

Package

Source

_image_imagegif()

Affiche ou sauvegarde une image au format GIF

Utilise les fonctions spécifiques GD.

boolean _image_imagegif( resource $img , string $fichier )

Paramètres

  1. resource $img

    Une ressource de type Image GD.

  2. string $fichier

    Le path vers l'image (ex : local/cache-vignettes/L180xH51/image.gif).

Retour

  • boolean
    • false si l'image créée a une largeur nulle ou n'existe pas ;
    • true si une image est bien retournée.

Package

Source

_image_imageico()

Crée un fichier-image au format ICO

Utilise les fonctions de la classe phpthumb_functions.

boolean _image_imageico( resource $img , string $fichier )

Paramètres

  1. resource $img

    Une ressource de type Image GD.

  2. string $fichier

    Le path vers l'image (ex : local/cache-vignettes/L180xH51/image.jpg).

Retour

  • boolean

    true si le fichier a bien été créé ; false sinon.

Utilise

Package

Source

_image_imagejpg()

Affiche ou sauvegarde une image au format JPG

Utilise les fonctions spécifiques GD.

boolean _image_imagejpg( resource $img , string $fichier , integer $qualite = _IMG_GD_QUALITE )

Paramètres

  1. resource $img

    Une ressource de type Image GD.

  2. string $fichier

    Le path vers l'image (ex : local/cache-vignettes/L180xH51/image.jpg).

  3. integer $qualite = _IMG_GD_QUALITE

    Le niveau de qualité du fichier résultant : de 0 (pire qualité, petit fichier) à 100 (meilleure qualité, gros fichier). Par défaut, prend la valeur (85) de la constante _IMG_GD_QUALITE (modifiable depuis mes_options.php).

Retour

  • boolean
    • false si l'image créée a une largeur nulle ou n'existe pas ;
    • true si une image est bien retournée.

Package

Source

_image_imagepng()

Affiche ou sauvegarde une image au format PNG

Utilise les fonctions spécifiques GD.

boolean _image_imagepng( \ressource $img , string $fichier )

Paramètres

  1. \ressource $img

    Une ressource de type Image GD.

  2. string $fichier

    Le path vers l'image (ex : local/cache-vignettes/L180xH51/image.png).

Retour

  • boolean
    • false si l'image créée a une largeur nulle ou n'existe pas ;
    • true si une image est bien retournée.

Package

Source

_image_imagesvg()

Sauvegarde une image au format SVG
  • N'UTILISE PAS GD - C'est une fonction derogatoire pour faciliter le traitement des SVG
boolean _image_imagesvg( string $img , string $fichier )

Paramètres

  1. string $img

    contenu du SVG ou chemin vers le SVG source (et c'est alors une copie)

  2. string $fichier

    Le path vers l'image (ex : local/cache-vignettes/L180xH51/image.png).

Retour

  • boolean
    • false si l'image créée a une largeur nulle ou n'existe pas ;
    • true si une image est bien retournée.

Package

Source

_image_imagewebp()

Affiche ou sauvegarde une image au format WEBP

Utilise les fonctions spécifiques GD.

boolean _image_imagewebp( resource $img , string $fichier , $qualite = _IMG_GD_QUALITE )

Paramètres

  1. resource $img

    Une ressource de type Image GD.

  2. string $fichier

    Le path vers l'image (ex : local/cache-vignettes/L180xH51/image.png).

  3. $qualite = _IMG_GD_QUALITE

Retour

  • boolean
    • false si l'image créée a une largeur nulle ou n'existe pas ;
    • true si une image est bien retournée.

Package

Source

_image_ratio()

Réduire des dimensions en respectant un ratio

Réduit des dimensions (hauteur, largeur) pour qu'elles soient incluses dans une hauteur et largeur maximum fournies en respectant la proportion d'origine

array _image_ratio( integer $srcWidth , integer $srcHeight , integer $maxWidth , integer $maxHeight )

Paramètres

  1. integer $srcWidth

    Largeur de l'image source

  2. integer $srcHeight

    Hauteur de l'image source

  3. integer $maxWidth

    Largeur maximum souhaitée

  4. integer $maxHeight

    Hauteur maximum souhaitée

Retour

  • array

    Liste [ largeur, hauteur, ratio de réduction ]

Exemples

  • image_ratio(1000, 1000 , 100, 10) donne array(10, 10, 100)

Voir également

Utilisé par

Package

Source

_image_tag_changer_taille()

Applique des attributs de taille (width, height) à une balise HTML

Utilisé avec des balises <img> tout particulièrement.

Modifie l'attribut style s'il était renseigné, en enlevant les informations éventuelles width / height dedans.

string _image_tag_changer_taille( string $tag , integer $width , integer $height , boolean | string $style = false )

Paramètres

  1. string $tag

    Code html de la balise

  2. integer $width

    Hauteur

  3. integer $height

    Largeur

  4. boolean | string $style = false

    Attribut html style à appliquer. False extrait celui présent dans la balise

Retour

  • string

    Code html modifié de la balise.

Utilise

  • extraire_attribut()
  • inserer_attribut()

Utilisé par

Package

Source

_image_trouver_extension()

Retourne la terminaison d’un fichier image
string _image_trouver_extension( string $path )

Paramètres

  1. string $path

Retour

  • string

Package

Source

_image_trouver_extension_depuis_mime()
string _image_trouver_extension_depuis_mime( string $mime )

Paramètres

  1. string $mime

Retour

  • string

Package

Source

_image_trouver_extension_pertinente()

Tente de trouver le véritable type d’une image, même si une image est d’extension .jpg alors que son contenu est autre chose (gif ou png)
string _image_trouver_extension_pertinente( string $path )

Paramètres

  1. string $path

Retour

  • string

    Extension, dans le format attendu par les fonctions 'gd' ('jpeg' pour les .jpg par exemple)

Package

Source

_image_valeurs_trans()

Fonctions de preparation aux filtres de traitement d'image les fonctions de lecture et d'ecriture renseignees traitent uniquement le cas GD2 qui est le cas general des filtres images

mais image_reduire utilise aussi cette fonction en adaptant le traitement en fonction de la librairie graphique choisie dans la configuration de SPIP

boolean | string | array _image_valeurs_trans( string $img , string $effet , boolean | string $forcer_format = false , array $fonction_creation = null , boolean $find_in_path = false , boolean $support_svg = false )

Paramètres

  1. string $img

    Chemin de l'image ou balise html <img src=... />.

  2. string $effet

    Les nom et paramètres de l'effet à apporter sur l'image (par exemple : reduire-300-200).

  3. boolean | string $forcer_format = false

    Un nom d'extension spécifique demandé (par exemple : jpg, png, txt...). Par défaut false : GD se débrouille seule).

  4. array $fonction_creation = null

    Un tableau à 2 éléments : 1) string : indique le nom du filtre de traitement demandé (par exemple : image_reduire) ; 2) array : tableau reprenant la valeur de $img et chacun des arguments passés au filtre utilisé.

  5. boolean $find_in_path = false

    false (par défaut) indique que l'on travaille sur un fichier temporaire (.src) ; true, sur un fichier définitif déjà existant.

  6. boolean $support_svg = false

    false (par defaut) indique que le filtre ne sait pas traiter le cas particulier du SVG on lui substitue un filtre generique qui ne fait rien pour ne pas briser la chaine des filtres images true si le filtre appelant sait traiter les SVG

Retour

  • boolean | string | array

    • false si pas de tag <img,

      • si l'extension n'existe pas,
      • si le fichier source n'existe pas,
      • si les dimensions de la source ne sont pas accessibles,
      • si le fichier temporaire n'existe pas,
      • si la fonction _imagecreatefrom{extension} n'existe pas ;

    • "" (chaîne vide) si le fichier source est distant et n'a pas réussi à être copié sur le serveur ;

    • array : tableau décrivant de l'image

Utilise

Utilisé par

Appelle le pipeline

Package

Source

_imagecreatefrom_func()

Crée une image depuis un fichier ou une URL (en indiquant la fonction GD à utiliser)

Utilise les fonctions spécifiques GD.

  • Si la fonction GD n'existe pas (GD non actif?), génère une erreur, mais ne retourne rien
  • Si l'image est impossible à créer avec la fonction indiquée, génère une erreur, et une image vide
resource | null _imagecreatefrom_func( string $func , string $filename )

Paramètres

  1. string $func

    Fonction GD à utiliser tel que 'imagecreatefromjpeg'

  2. string $filename

    Le path vers l'image à traiter (par exemple : IMG/distant/jpg/image.jpg ou local/cache-vignettes/L180xH51/image.jpg).

Retour

  • resource | null

    Une ressource de type Image GD.

Utilisé par

Package

Source

_imagecreatefromgif()

Crée une image depuis un fichier ou une URL (au format gif)

Utilise les fonctions spécifiques GD.

resource | null _imagecreatefromgif( string $filename )

Paramètres

  1. string $filename

    Le path vers l'image à traiter (par exemple : IMG/distant/gif/image.gif ou local/cache-vignettes/L180xH51/image.gif).

Retour

  • resource | null

    Une ressource de type Image GD.

Utilise

Package

Source

_imagecreatefromjpeg()

Crée une image depuis un fichier ou une URL (au format jpeg)

Utilise les fonctions spécifiques GD.

resource | null _imagecreatefromjpeg( string $filename )

Paramètres

  1. string $filename

    Le path vers l'image à traiter (par exemple : IMG/distant/jpg/image.jpg ou local/cache-vignettes/L180xH51/image.jpg).

Retour

  • resource | null

    Une ressource de type Image GD.

Utilise

Package

Source

_imagecreatefrompng()

Crée une image depuis un fichier ou une URL (au format png)

Utilise les fonctions spécifiques GD.

resource | null _imagecreatefrompng( string $filename )

Paramètres

  1. string $filename

    Le path vers l'image à traiter (par exemple : IMG/distant/png/image.png ou local/cache-vignettes/L180xH51/image.png).

Retour

  • resource | null

    Une ressource de type Image GD.

Utilise

Package

Source

_imagecreatefromwebp()

Crée une image depuis un fichier ou une URL (au format webp)

Utilise les fonctions spécifiques GD.

resource | null _imagecreatefromwebp( string $filename )

Paramètres

  1. string $filename

    Le path vers l'image à traiter (par exemple : IMG/distant/png/image.png ou local/cache-vignettes/L180xH51/image.png).

Retour

  • resource | null

    Une ressource de type Image GD.

Utilise

Package

Source

image_graver()

Clôture une série de filtres d'images

Ce filtre est automatiquement appelé à la fin d'une série de filtres d'images dans un squelette.

string image_graver( string $img )

Paramètres

  1. string $img

    Code HTML de l'image

Retour

  • string

    Code HTML de l'image

Utilise

Appelle le pipeline

Package

Filtre

  • image_graver

Source

imagepalettetotruecolor()

Transforme une image à palette indexée (256 couleurs max) en "vraies" couleurs RGB
boolean imagepalettetotruecolor( \ressource & $img )

Paramètres

  1. \ressource & $img

Retour

  • boolean
    • true si l'image est déjà en vrai RGB ou peut être transformée
    • false si la transformation ne peut être faite.

Documentation externe

Package

Note

  • Pour compatibilité avec PHP < 5.5

Source

process_image_reduire()

Réduit une image
string process_image_reduire( array $fonction , string $img , integer $taille , integer $taille_y , boolean $force , string $process = 'AUTO' )

Paramètres

  1. array $fonction

    Un tableau à 2 éléments : 1) string : indique le nom du filtre de traitement demandé (par exemple : image_reduire) ; 2) array : tableau reprenant la valeur de $img et chacun des arguments passés au filtre utilisé.

  2. string $img

    Chemin de l'image ou texte contenant une balise img

  3. integer $taille

    Largeur désirée

  4. integer $taille_y

    Hauteur désirée

  5. boolean $force
  6. string $process = 'AUTO'

    Librairie graphique à utiliser (gd1, gd2, netpbm, convert, imagick). AUTO utilise la librairie sélectionnée dans la configuration.

Retour

  • string

    Code HTML de la balise img produite

Utilise

Utilisé par

Package

Source

process_image_svg_identite()

Fonction identite de traitement par defaut des images SVG (quand un filtre n'annonce pas qu'il sait traiter un SVG on applique cette fonction a la place)
string process_image_svg_identite( array $image )

Paramètres

  1. array $image

    tableau des valeurs crees par _image_valeurs_trans

Retour

  • string

Package

Source

ramasse_miettes()

Indique qu'un fichier d'image calculé est à conserver

Permet de rendre une image définitive et de supprimer les images intermédiaires à son calcul.

Supprime le fichier de contrôle de l’image cible (le $fichier.src) ce qui indique que l'image est définitive.

Remonte ensuite la chaîne des fichiers de contrôle pour supprimer les images temporaires (mais laisse les fichiers de contrôle permettant de les reconstruire).

void ramasse_miettes( string $fichier )

Paramètres

  1. string $fichier

    Chemin du fichier d'image calculé

Utilisé par

Package

Source

ratio_passe_partout()

Réduire des dimensions en respectant un ratio sur la plus petite dimension

Réduit des dimensions (hauteur, largeur) pour qu'elles soient incluses dans la plus grande hauteur ou largeur maximum fournie en respectant la proportion d'origine

array ratio_passe_partout( integer $srcWidth , integer $srcHeight , integer $maxWidth , integer $maxHeight )

Paramètres

  1. integer $srcWidth

    Largeur de l'image source

  2. integer $srcHeight

    Hauteur de l'image source

  3. integer $maxWidth

    Largeur maximum souhaitée

  4. integer $maxHeight

    Hauteur maximum souhaitée

Retour

  • array

    Liste [ largeur, hauteur, ratio de réduction ]

Exemples

  • ratio_passe_partout(1000, 1000 , 100, 10) donne array(100, 100, 10)

Voir également

Utilisé par

Package

Source

reconstruire_image_intermediaire()

Reconstruit une image à partir des sources de contrôle de son ancienne construction
void reconstruire_image_intermediaire( string $fichier_manquant )

Paramètres

  1. string $fichier_manquant

    Chemin vers le fichier manquant

Utilise

Utilisé par

Package

Source

statut_effacer_images_temporaires()

Donne un statut au fichier-image intermédiaire servant au traitement d'image selon qu'il doit être gravé (fichier .src) ou pas.

Un appel PHP direct aux fonctions de filtre d'image produira ainsi une image permanente (gravée) ; un appel généré par le compilateur via filtrer('image_xx, ...) effacera automatiquement le fichier-image temporaire.

boolean statut_effacer_images_temporaires( boolean | string $stat )

Paramètres

  1. boolean | string $stat

    true, false ou le statut déjà défini si traitements enchaînés.

Retour

  • boolean

    true si il faut supprimer le fichier temporaire ; false sinon.

Utilisé par

Package

Source

Liste des classes

NomDescription
phpthumb_functions

Produire des fichiers au format .ico

Liste des erreurs

GravitéLigneDescription
Notice 309
  • Référence de @uses introuvable dans _image_valeurs_trans : \extraire_attribut()
  • Référence de @uses introuvable dans _image_valeurs_trans : \inserer_attribut()
  • Référence de @uses introuvable dans _image_valeurs_trans : \taille_image()
Erreur 535
  • No summary for function \_image_extensions_acceptees_en_entree()
Erreur 556
  • No summary for function \_image_extensions_acceptees_en_sortie()
Erreur 572
  • Argument $extension is missing from the Docblock of _image_extension_normalisee
  • No summary for function \_image_extension_normalisee()
Erreur 580
  • No summary for function \_image_extensions_conservent_transparence()
Erreur 640
  • No summary for function \_image_trouver_extension_depuis_mime()
Erreur 919
  • Argument $qualite is missing from the Docblock of _image_imagewebp
  • Name of argument $qualite does not match with the DocBlock's name $fichier in \_image_imagewebp()
Erreur 1012
  • Argument $fonction is missing from the Docblock of _image_gd_output
  • Name of argument $fonction does not match with the DocBlock's name $qualite in \_image_gd_output()
Notice 1220
  • Référence de @uses introuvable dans _image_tag_changer_taille : \extraire_attribut()
  • Référence de @uses introuvable dans _image_tag_changer_taille : \inserer_attribut()
Notice 1271
  • Référence de @uses introuvable dans _image_ecrire_tag : \extraire_attribut()
  • Référence de @uses introuvable dans _image_ecrire_tag : \inserer_attribut()
Notice 1731
  • Référence de @uses introuvable dans process_image_reduire : \extraire_attribut()
  • Référence de @uses introuvable dans process_image_reduire : \inserer_attribut()