API Documentation
Table of Contents
Functions
- couleur_extraire() : mixed
- Toutes les fonctions couleur_xx de ce fichier : - prennent une couleur hexa sur 6 caracteres en entree (les couleurs web nommees sont admises aussi) - fournissent une couleur hexa en sortie - sont chainables les unes derrieres les autres dans toutes les combinaisons possibles
- couleur_web() : mixed
- couleur_4096() : mixed
- couleur_luminance_relative() : mixed
- couleur_extreme() : mixed
- couleur_inverser() : mixed
- couleur_foncer_si_claire() : mixed
- couleur_eclaircir_si_foncee() : mixed
- couleur_saturation() : string
- Modifie la saturation et parfois la luminosité de la couleur transmise
- couleur_luminance() : string
- Modifie la luminance de la couleur transmise
- multiple_de_trois() : mixed
- _couleur_rgb2hsv() : array<string|int, mixed>
- Transformation d'une couleur vectorielle RGB en HSV RGB entiers entre 0 et 255 HSV float entre 0 et 1
- _couleur_hsv2rgb() : array<string|int, mixed>
- Transformation d'une couleur vectorielle HSV en RGB HSV float entre 0 et 1 RGB entiers entre 0 et 255
- _couleur_rgb2hsl() : array<string|int, mixed>
- Transformation d'une couleur RGB en HSL
- _couleur_hsl2rgb() : array<string|int, mixed>
- Transformation d'une couleur HSL en RGB
- _image_couleur_extraire() : mixed
- _image_distance_pixel() : mixed
- _image_decale_composante() : int
- Decale une composante de couleur entier de 0 a 255
- _image_decale_composante_127() : int
- Decalage d'une composante de couleur en sepia entier de 0 a 255
- image_aplatir() : mixed
- image_format() : mixed
- image_alpha() : mixed
- image_recadre() : string
- Recadre (rogne) une image en indiquant la taille de la découpe souhaitée
- image_recadre_mini() : string
- Recadrer une image dans le rectangle le plus petit possible sans perte de pixels non transparent Le recadrage se fait en conservant le centre de l'image : on recadre symétriquement gauche vs droite et haut vs bas TODO : proposer une option pour vraiment recadrer au plus juste, meme si ca decentre l'image
- image_flip_vertical() : mixed
- image_flip_horizontal() : mixed
- image_masque() : mixed
- image_nb() : mixed
- image_flou() : mixed
- dimensions_rotation_image() : array<string|int, mixed>
- Determiner les nouvelles dimensions de l'image apres rotation
- image_RotateBicubic() : mixed
- image_rotation() : mixed
- image_imagick() : mixed
- _image_imagick_write() : bool
- Affiche ou sauvegarde une image au format WEBP
- image_gamma() : mixed
- image_sepia() : mixed
- image_renforcement() : string
- Renforcer la netteté d'une image
- image_fond_transparent() : mixed|null|string
- Transforme la couleur de fond de l'image en transparence Le filtre ne gere pas la notion de contiguite aux bords, et affectera tous les pixels de l'image dans la couleur visee $background_color : couleur cible $tolerance : distance L1 dans l'espace RGB des couleur autour de la couleur $background_color pour lequel la transparence sera appliquee $alpha : transparence a appliquer pour les pixels de la couleur cibles avec la tolerance ci-dessus $coeff_lissage : coeff applique a la tolerance pour determiner la decroissance de la transparence fonction de la distance L1 entre la couleur du pixel et la couleur cible
- rtl_mb_ord() : mixed
- rtl_reverse() : mixed
- rtl_visuel() : mixed
- printWordWrapped() : mixed
- produire_image_typo() : mixed
- image_typo() : string
- Créer une image typo
Functions
couleur_extraire()
Toutes les fonctions couleur_xx de ce fichier : - prennent une couleur hexa sur 6 caracteres en entree (les couleurs web nommees sont admises aussi) - fournissent une couleur hexa en sortie - sont chainables les unes derrieres les autres dans toutes les combinaisons possibles
couleur_extraire(mixed $img[, mixed $x = 10 ][, mixed $y = 6 ]) : mixed
Parameters
- $img : mixed
- $x : mixed = 10
- $y : mixed = 6
couleur_web()
couleur_web(mixed $couleur) : mixed
Parameters
- $couleur : mixed
couleur_4096()
couleur_4096(mixed $couleur) : mixed
Parameters
- $couleur : mixed
couleur_luminance_relative()
couleur_luminance_relative(mixed $couleur) : mixed
Parameters
- $couleur : mixed
couleur_extreme()
couleur_extreme(mixed $couleur[, mixed $limite = 0.5 ]) : mixed
Parameters
- $couleur : mixed
- $limite : mixed = 0.5
couleur_inverser()
couleur_inverser(mixed $couleur) : mixed
Parameters
- $couleur : mixed
couleur_foncer_si_claire()
couleur_foncer_si_claire(mixed $couleur[, mixed $seuil = 122 ]) : mixed
Parameters
- $couleur : mixed
- $seuil : mixed = 122
couleur_eclaircir_si_foncee()
couleur_eclaircir_si_foncee(mixed $couleur[, mixed $seuil = 123 ]) : mixed
Parameters
- $couleur : mixed
- $seuil : mixed = 123
couleur_saturation()
Modifie la saturation et parfois la luminosité de la couleur transmise
couleur_saturation(string $couleur, float $val[, bool|string $strict = false ]) : string
Opère sur une échelle absolue.
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 que la saturation, sans toucher à la luminosité
Tags
Return values
string —Couleur en écriture hexadécimale.
couleur_luminance()
Modifie la luminance de la couleur transmise
couleur_luminance(string $couleur, float $val) : string
Change la luminance en forçant le résultat sur une échelle absolue.
Parameters
- $couleur : string
-
Couleur en écriture hexadécimale, tel que
ff3300
- $val : float
-
Pourcentage désiré (entre 0 et 1)
Tags
Return values
string —Couleur en écriture hexadécimale.
multiple_de_trois()
multiple_de_trois(mixed $val) : mixed
Parameters
- $val : mixed
_couleur_rgb2hsv()
Transformation d'une couleur vectorielle RGB en HSV RGB entiers entre 0 et 255 HSV float entre 0 et 1
_couleur_rgb2hsv(int $R, int $G, int $B) : array<string|int, mixed>
Parameters
- $R : int
- $G : int
- $B : int
Return values
array<string|int, mixed>_couleur_hsv2rgb()
Transformation d'une couleur vectorielle HSV en RGB HSV float entre 0 et 1 RGB entiers entre 0 et 255
_couleur_hsv2rgb(float $H, float $S, float $V) : array<string|int, mixed>
Parameters
- $H : float
- $S : float
- $V : float
Return values
array<string|int, mixed>_couleur_rgb2hsl()
Transformation d'une couleur RGB en HSL
_couleur_rgb2hsl(int $R, int $G, int $B) : array<string|int, mixed>
HSL float entre 0 et 1 RGB entiers entre 0 et 255
Parameters
- $R : int
- $G : int
- $B : int
Tags
Return values
array<string|int, mixed>_couleur_hsl2rgb()
Transformation d'une couleur HSL en RGB
_couleur_hsl2rgb(float $H, float $S, float $L) : array<string|int, mixed>
HSL float entre 0 et 1 RGB entiers entre 0 et 255
Parameters
- $H : float
- $S : float
- $L : float
Tags
Return values
array<string|int, mixed>_image_couleur_extraire()
_image_couleur_extraire(mixed $img[, mixed $x = 10 ][, mixed $y = 6 ]) : mixed
Parameters
- $img : mixed
- $x : mixed = 10
- $y : mixed = 6
_image_distance_pixel()
_image_distance_pixel(mixed $xo, mixed $yo, mixed $x0, mixed $y0) : mixed
Parameters
- $xo : mixed
- $yo : mixed
- $x0 : mixed
- $y0 : mixed
_image_decale_composante()
Decale une composante de couleur entier de 0 a 255
_image_decale_composante(int $coul, int $gamma) : int
Parameters
- $coul : int
- $gamma : int
Return values
int_image_decale_composante_127()
Decalage d'une composante de couleur en sepia entier de 0 a 255
_image_decale_composante_127(int $coul, int $val) : int
Parameters
- $coul : int
- $val : int
Return values
intimage_aplatir()
image_aplatir(mixed $im[, mixed $format = 'jpg' ][, mixed $coul = '000000' ][, mixed $qualite = null ][, mixed $transparence = false ]) : mixed
Parameters
- $im : mixed
- $format : mixed = 'jpg'
- $coul : mixed = '000000'
- $qualite : mixed = null
- $transparence : mixed = false
image_format()
image_format(mixed $img[, mixed $format = 'png' ]) : mixed
Parameters
- $img : mixed
- $format : mixed = 'png'
image_alpha()
image_alpha(mixed $im[, mixed $alpha = 63 ]) : mixed
Parameters
- $im : mixed
- $alpha : mixed = 63
image_recadre()
Recadre (rogne) une image en indiquant la taille de la découpe souhaitée
image_recadre(string $im, string|int $width[, string|int $height = '-' ][, string $position = 'center' ][, string $background_color = 'white' ]) : string
On peut indiquer une proportion ou une taille spécifique, une position de rognage et une couleur de fond, si le rognage est de taille plus grande que l'image d'origine.
Parameters
- $im : string
-
Chemin de l'image ou balise html
<img src=... />
- $width : string|int
-
Largeur du recadrage ou ratio sous la forme "16:9"
- $height : string|int = '-'
-
Hauteur du recadrage ou "+" (agrandir) ou "-" (reduire) si un ratio est fourni pour width
- $position : string = 'center'
-
Indication de position de la découpe :
-
center
,left
,right
,top
,bottom
, - ou combinaisons de plusiers
top left
- ou indication en pixels depuis une position
top=50
ou composéetop=40 left=50
- ou nom d'une fonction spéciale qui calculera et retournera la position souhaitée
-
- $background_color : string = 'white'
-
Couleur de fond si on agrandit l'image
Tags
Return values
string —balise image recadrée
image_recadre_mini()
Recadrer une image dans le rectangle le plus petit possible sans perte de pixels non transparent Le recadrage se fait en conservant le centre de l'image : on recadre symétriquement gauche vs droite et haut vs bas TODO : proposer une option pour vraiment recadrer au plus juste, meme si ca decentre l'image
image_recadre_mini(string $im) : string
Parameters
- $im : string
Return values
stringimage_flip_vertical()
image_flip_vertical(mixed $im) : mixed
Parameters
- $im : mixed
image_flip_horizontal()
image_flip_horizontal(mixed $im) : mixed
Parameters
- $im : mixed
image_masque()
image_masque(mixed $im, mixed $masque[, mixed $pos = '' ]) : mixed
Parameters
- $im : mixed
- $masque : mixed
- $pos : mixed = ''
image_nb()
image_nb(mixed $im[, mixed $val_r = 299 ][, mixed $val_g = 587 ][, mixed $val_b = 114 ]) : mixed
Parameters
- $im : mixed
- $val_r : mixed = 299
- $val_g : mixed = 587
- $val_b : mixed = 114
image_flou()
image_flou(mixed $im[, mixed $niveau = 3 ]) : mixed
Parameters
- $im : mixed
- $niveau : mixed = 3
dimensions_rotation_image()
Determiner les nouvelles dimensions de l'image apres rotation
dimensions_rotation_image(int|float $angle, int $width, int $height[, int $center_x = null ][, int $center_y = null ]) : array<string|int, mixed>
Parameters
- $angle : int|float
-
en degres
- $width : int
- $height : int
- $center_x : int = null
- $center_y : int = null
Return values
array<string|int, mixed> —[int, int]
image_RotateBicubic()
image_RotateBicubic(mixed $src_img, mixed $angle[, mixed $bicubic = false ]) : mixed
Parameters
- $src_img : mixed
- $angle : mixed
- $bicubic : mixed = false
image_rotation()
image_rotation(mixed $im, mixed $angle[, mixed $crop = false ]) : mixed
Parameters
- $im : mixed
- $angle : mixed
- $crop : mixed = false
image_imagick()
image_imagick() : mixed
_image_imagick_write()
Affiche ou sauvegarde une image au format WEBP
_image_imagick_write(mixed $imagick, string $fichier[, mixed $qualite = _IMG_GD_QUALITE ]) : bool
Utilise les fonctions spécifiques GD.
Parameters
- $imagick : mixed
- $fichier : string
-
Le path vers l'image (ex : local/cache-vignettes/L180xH51/image.png).
- $qualite : mixed = _IMG_GD_QUALITE
Return values
bool —- false si l'image créée a une largeur nulle ou n'existe pas ;
- true si une image est bien retournée.
image_gamma()
image_gamma(mixed $im[, mixed $gamma = 0 ]) : mixed
Parameters
- $im : mixed
- $gamma : mixed = 0
image_sepia()
image_sepia(mixed $im[, mixed $rgb = '896f5e' ]) : mixed
Parameters
- $im : mixed
- $rgb : mixed = '896f5e'
image_renforcement()
Renforcer la netteté d'une image
image_renforcement(string $im[, float $k = 0.5 ]) : string
Parameters
- $im : string
-
Code HTML de l'image
- $k : float = 0.5
-
Niveau de renforcement (entre 0 et 1)
Return values
string —Code HTML de l'image
image_fond_transparent()
Transforme la couleur de fond de l'image en transparence Le filtre ne gere pas la notion de contiguite aux bords, et affectera tous les pixels de l'image dans la couleur visee $background_color : couleur cible $tolerance : distance L1 dans l'espace RGB des couleur autour de la couleur $background_color pour lequel la transparence sera appliquee $alpha : transparence a appliquer pour les pixels de la couleur cibles avec la tolerance ci-dessus $coeff_lissage : coeff applique a la tolerance pour determiner la decroissance de la transparence fonction de la distance L1 entre la couleur du pixel et la couleur cible
image_fond_transparent(string $im, string $background_color[, int $tolerance = 12 ][, int $alpha = 127 ][, int $coeff_lissage = 7 ]) : mixed|null|string
Parameters
- $im : string
- $background_color : string
- $tolerance : int = 12
- $alpha : int = 127
-
alpha = 0: aucune transparence alpha = 127: completement transparent
- $coeff_lissage : int = 7
Return values
mixed|null|stringrtl_mb_ord()
rtl_mb_ord(mixed $char) : mixed
Parameters
- $char : mixed
rtl_reverse()
rtl_reverse(mixed $mot, mixed $rtl_global) : mixed
Parameters
- $mot : mixed
- $rtl_global : mixed
rtl_visuel()
rtl_visuel(mixed $texte, mixed $rtl_global) : mixed
Parameters
- $texte : mixed
- $rtl_global : mixed
printWordWrapped()
printWordWrapped(mixed $image, mixed $top, mixed $left, mixed $maxWidth, mixed $font, mixed $couleur, mixed $text, mixed $textSize[, mixed $align = 'left' ][, mixed $hauteur_ligne = 0 ]) : mixed
Parameters
- $image : mixed
- $top : mixed
- $left : mixed
- $maxWidth : mixed
- $font : mixed
- $couleur : mixed
- $text : mixed
- $textSize : mixed
- $align : mixed = 'left'
- $hauteur_ligne : mixed = 0
produire_image_typo()
produire_image_typo() : mixed
image_typo()
Créer une image typo
image_typo() : string