SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

filtres_images_mini.php

Ce fichier contient les fonctions simples de traitement d'image.

Table of Contents

Functions

couleur_html_to_hex()  : string
Transforme un code couleur textuel (black, white, green...) et code hexadécimal
couleur_hex_to_hsl()  : string
Retourne une couleur hsl a partir d'une couleur hex
couleur_hex_to_rgb()  : string
Retourne une couleur rgb a partir d'une couleur hex
couleur_foncer()  : string
Rend une couleur (code hexadécimal) plus foncée
couleur_eclaircir()  : string
Eclaircit une couleur (code hexadécimal)
image_select()  : Le
Selectionne les images qui vont subir une transformation sur un critere de taille
image_passe_partout()  : string
Réduit les images à une taille maximale (chevauchant un rectangle)
image_reduire()  : string
Réduit les images à une taille maximale (inscrite dans un rectangle)
image_recadre_avec_fallback()  : mixed
Usage espace privé: recadre une image uniquement si GD2 et image_recadre (plugin activé) existe sinon retourne le image_passe_partout usuel
image_reduire_par()  : string
Réduit les images d'un certain facteur
filtre_couleur_saturation_dist()  : string
Modifie la saturation de la couleur transmise
filtre_couleur_luminance_dist()  : string
Modifie la luminance de la couleur transmise

Functions

couleur_html_to_hex()

Transforme un code couleur textuel (black, white, green...) et code hexadécimal

couleur_html_to_hex(string $couleur) : string
Parameters
$couleur : string

Le code couleur textuel

Return values
string —

Le code hexadécimal de la couleur (sans le #) ou le code couleur textuel si non trouvé

couleur_hex_to_hsl()

Retourne une couleur hsl a partir d'une couleur hex

couleur_hex_to_hsl(string $couleur[, string|null $format = null ]) : string
Parameters
$couleur : string
$format : string|null = null

Si précisé, remplace h, s ou l par sa valeur dans la chaine passée.

Tags
example

couleur_hex_to_hsl("#ffccaa");

example

couleur_hex_to_hsl("#ffccaa", "h");

example

couleur_hex_to_hsl("#ffccaa", "h, s, l");

filtre
Return values
string —

Couleur tel que "hsl(200, 40%, 34%)" ou valeur formattée

couleur_hex_to_rgb()

Retourne une couleur rgb a partir d'une couleur hex

couleur_hex_to_rgb(string $couleur[, string|null $format = null ]) : string
Parameters
$couleur : string
$format : string|null = null

Si précisé, remplace r, g ou b par sa valeur dans la chaine passée.

Tags
example

couleur_hex_to_rgb("#ffccaa");

example

couleur_hex_to_rgb("#ffccaa", "r");

example

couleur_hex_to_rgb("#ffccaa", "r, g, b");

filtre
Return values
string —

Couleur tel que "rgb(200, 40, 84)" ou valeur formattée

couleur_foncer()

Rend une couleur (code hexadécimal) plus foncée

couleur_foncer(string $couleur[, float $coeff = 0.5 ]) : string
Parameters
$couleur : string

Code hexadécimal d'une couleur

$coeff : float = 0.5

Coefficient (de 0 à 1)

Tags
uses
_couleur_hex_to_dec()

Pour transformer le code hexadécimal en décimal

Return values
string —

Code hexadécimal de la couleur plus foncée

couleur_eclaircir()

Eclaircit une couleur (code hexadécimal)

couleur_eclaircir(string $couleur[, float $coeff = 0.5 ]) : string
Parameters
$couleur : string

Code hexadécimal d'une couleur

$coeff : float = 0.5

Coefficient (de 0 à 1)

Tags
uses
_couleur_hex_to_dec()

Pour transformer le code hexadécimal en décimal

Return values
string —

Code hexadécimal de la couleur éclaircie

image_select()

Selectionne les images qui vont subir une transformation sur un critere de taille

image_select(string $img[, int $width_min = 0 ][, int $height_min = 0 ][, int $width_max = 10000 ][, int $height_max = 1000 ]) : Le

Les images exclues sont marquees d'une class filtre_inactif qui bloque les filtres suivants dans la fonction image_filtrer

Parameters
$img : string

Un tag html <img src=... />.

$width_min : int = 0

Largeur minimale de l'image à traiter (0 par défaut)

$height_min : int = 0

Hauteur minimale de l'image à traiter (0 par défaut)

$width_max : int = 10000

Largeur minimale de l'image à traiter (10000 par défaut)

$height_max : int = 1000

Hauteur minimale de l'image à traiter (10000 par défaut)

Return values
Le —

tag html <img src=... /> avec une class filtre_inactif ou pas

image_passe_partout()

Réduit les images à une taille maximale (chevauchant un rectangle)

image_passe_partout(string $img[, int $taille_x = -1 ][, int $taille_y = -1 ][, bool $force = false ][, bool $cherche_image = false ][, string $process = 'AUTO' ]) : string

L'image possède un côté réduit dans les dimensions indiquées et l'autre côté (hauteur ou largeur) de l'image peut être plus grand que les dimensions du rectangle.

Alors que image_reduire produit la plus petite image tenant dans un rectangle, image_passe_partout produit la plus grande image qui remplit ce rectangle.

Parameters
$img : string

Chemin de l'image ou code html d'une balise img

$taille_x : int = -1
  • Largeur maximale en pixels désirée
  • -1 prend la taille de réduction des vignettes par défaut
  • 0 la taille s'adapte à la largeur
$taille_y : int = -1
  • Hauteur maximale en pixels désirée
  • -1 pour prendre pareil que la largeur
  • 0 la taille s'adapte à la hauteur
$force : bool = false
$cherche_image : bool = false

Inutilisé

$process : string = 'AUTO'

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

Tags
example 
[(#FICHIER
  |image_passe_partout{70,70}
  |image_recadre{70,70,center})]
filtre
link
https://www.spip.net/4562
see
image_reduire()
uses
taille_image()
uses
ratio_passe_partout()
uses
process_image_reduire()
Return values
string —

Code HTML de l'image ou du texte.

image_reduire()

Réduit les images à une taille maximale (inscrite dans un rectangle)

image_reduire(string $img[, int $taille = -1 ][, int $taille_y = -1 ][, bool $force = false ][, bool $cherche_image = false ][, string $process = 'AUTO' ]) : string

L'image possède un côté dans les dimensions indiquées et l'autre côté (hauteur ou largeur) de l'image peut être plus petit que les dimensions du rectangle.

Peut être utilisé pour réduire toutes les images d'un texte.

Parameters
$img : string

Chemin de l'image ou code html d'une balise img

$taille : int = -1
  • Largeur maximale en pixels désirée
  • -1 prend la taille de réduction des vignettes par défaut
  • 0 la taille s'adapte à la largeur
$taille_y : int = -1
  • Hauteur maximale en pixels désirée
  • -1 pour prendre pareil que la largeur
  • 0 la taille s'adapte à la hauteur
$force : bool = false
$cherche_image : bool = false

Inutilisé

$process : string = 'AUTO'

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

Tags
example 
[(#LOGO_ARTICLE|image_reduire{130})]
[(#TEXTE|image_reduire{600,0})]
filtre
see
image_reduire_par()
see
image_passe_partout()
uses
process_image_reduire()
used-by
image_reduire_par()
Return values
string —

Code HTML de l'image ou du texte.

image_recadre_avec_fallback()

Usage espace privé: recadre une image uniquement si GD2 et image_recadre (plugin activé) existe sinon retourne le image_passe_partout usuel

image_recadre_avec_fallback(mixed $im, mixed $width[, mixed $height = '-' ][, mixed $position = 'focus' ][, mixed $background_color = 'white' ]) : mixed
Parameters
$im : mixed
$width : mixed
$height : mixed = '-'
$position : mixed = 'focus'
$background_color : mixed = 'white'

image_reduire_par()

Réduit les images d'un certain facteur

image_reduire_par(string $img[, int $val = 1 ][, bool $force = false ]) : string
Parameters
$img : string

Chemin de l'image ou code html d'une balise img

$val : int = 1

Facteur de réduction

$force : bool = false
Tags
filtre
uses
image_reduire()
Return values
string —

Code HTML de l'image ou du texte.

filtre_couleur_saturation_dist()

Modifie la saturation de la couleur transmise

filtre_couleur_saturation_dist(string $couleur, float $val[, bool|string $strict = false ]) : string
Parameters
$couleur : string

Couleur en écriture hexadécimale, tel que ff3300

$val : float

Pourcentage désiré (entre 0 et 1)

$strict : bool|string = false

Si true, ne change vraiment que la saturation, sans toucher à la luminosité

Tags
note

Nécessite le plugin filtres_images pour fonctionner. La couleur d’entrée est retournée tel quelle en cas d'absence.

see
couleur_saturation()

du plugin filtres_images

uses
couleur_saturation()
Return values
string —

Couleur en écriture hexadécimale.

filtre_couleur_luminance_dist()

Modifie la luminance de la couleur transmise

filtre_couleur_luminance_dist(string $couleur, float $val) : string
Parameters
$couleur : string

Couleur en écriture hexadécimale, tel que ff3300

$val : float

Pourcentage désiré (entre 0 et 1)

Tags
note

Nécessite le plugin filtres_images pour fonctionner. La couleur d’entrée est retournée tel quelle en cas d'absence.

see
couleur_luminance()

du plugin filtres_images

uses
couleur_luminance()
Return values
string —

Couleur en écriture hexadécimale.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results