feat(dev-tools): Mise en place phpcs+phpstan (#4684)

Co-authored-by: JamesRezo <james@rezo.net>
Reviewed-on: https://git.spip.net/spip/filtres_images/pulls/4684


Co-authored-by: JamesRezo <jamesrezo@noreply.git.spip.net>
Co-committed-by: JamesRezo <jamesrezo@noreply.git.spip.net>

.gitignore

+/vendor/
+/composer.phar
+/composer.lock
+/phpcs.xml
+/phpstan.neon
+/.php_cs.cache
+/.php_cs.txt

composer.json

+{
+    "require-dev": {
+        "dealerdirect/phpcodesniffer-composer-installer": "^0.7.1",
+        "spip/coding-standards": "^1.2",
+        "phpstan/phpstan": "^0.12.98"
+    }
+}

filtres/couleurs.php

 <?php
+
 /***************************************************************************\
  *  SPIP, Système de publication pour l'internet                           *
  *                                                                         *
@@ -67,9 +68,9 @@ function couleur_extreme($couleur, $limite = 0.5) {
 	// -> la limite est une valeur de 0 a 255, permettant de regler le point limite entre le passage noir ou blanc
 
 	if (couleur_luminance_relative($couleur) > $limite) {
-		$couleur_texte = "ffffff";
+		$couleur_texte = 'ffffff';
 	} else {
-		$couleur_texte = "000000";
+		$couleur_texte = '000000';
 	}
 
 	return $couleur_texte;
@@ -78,9 +79,9 @@ function couleur_extreme($couleur, $limite = 0.5) {
 // https://code.spip.net/@couleur_inverser
 function couleur_inverser($couleur) {
 	$couleurs = _couleur_hex_to_dec($couleur);
-	$red = 255 - $couleurs["red"];
-	$green = 255 - $couleurs["green"];
-	$blue = 255 - $couleurs["blue"];
+	$red = 255 - $couleurs['red'];
+	$green = 255 - $couleurs['green'];
+	$blue = 255 - $couleurs['blue'];
 
 	$couleur = _couleur_dec_to_hex($red, $green, $blue);
 
@@ -90,10 +91,10 @@ function couleur_inverser($couleur) {
 // https://code.spip.net/@couleur_foncer_si_claire
 function couleur_foncer_si_claire($couleur, $seuil = 122) {
 	// ne foncer que les couleurs claires
-	// utile pour ecrire sur fond blanc, 
+	// utile pour ecrire sur fond blanc,
 	// mais sans changer quand la couleur est deja foncee
 	if (couleur_luminance_relative($couleur) > $seuil / 255) {
-		include_spip("inc/filtres_images_mini");
+		include_spip('inc/filtres_images_mini');
 		return couleur_foncer($couleur);
 	} else {
 		return $couleur;
@@ -103,7 +104,7 @@ function couleur_foncer_si_claire($couleur, $seuil = 122) {
 // https://code.spip.net/@couleur_eclaircir_si_foncee
 function couleur_eclaircir_si_foncee($couleur, $seuil = 123) {
 	if (couleur_luminance_relative($couleur) < $seuil / 255) {
-		include_spip("inc/filtres_images_mini");
+		include_spip('inc/filtres_images_mini');
 		return couleur_eclaircir($couleur);
 	} else {
 		return $couleur;
@@ -120,10 +121,10 @@ function couleur_eclaircir_si_foncee($couleur, $seuil = 123) {
  *     - `[(#VAL{fc3924}|couleur_saturation{0})]` retourne blanc (ffffff),
  *     - `[(#VAL{fc3924}|couleur_saturation{1})]` retourne la couleur avec sa saturation au maximum (fb1800)
  *     - `[(#VAL{fc3924}|couleur_saturation{0.2})]` retourne la couleur avec 20% de saturation (fed0cc)
- * 
+ *
  * @uses _couleur_hex_to_dec()
  * @uses _couleur_dec_to_hex()
- * 
+ *
  * @param string $couleur
  *      Couleur en écriture hexadécimale, tel que `ff3300`
  * @param float $val
@@ -147,12 +148,12 @@ function couleur_saturation($couleur, $val, $strict = false) {
 	// Soit on joue sur la saturation et la luminosité
 	} else {
 		$couleurs = _couleur_hex_to_dec($couleur);
-		$r = 255 - $couleurs["red"];
-		$g = 255 - $couleurs["green"];
-		$b = 255 - $couleurs["blue"];
-	
+		$r = 255 - $couleurs['red'];
+		$g = 255 - $couleurs['green'];
+		$b = 255 - $couleurs['blue'];
+
 		$max = max($r, $g, $b, 1);
-	
+
 		$r = 255 - $r / $max * 255 * $val;
 		$g = 255 - $g / $max * 255 * $val;
 		$b = 255 - $b / $max * 255 * $val;
@@ -167,20 +168,20 @@ function couleur_saturation($couleur, $val, $strict = false) {
  * Modifie la luminance de la couleur transmise
  *
  * Change la luminance en forçant le résultat sur une échelle absolue.
- * 
+ *
  * @link https://www.spip.net/3326
  * @example
  *     - `[(#VAL{fc3924}|couleur_luminance{0})]` retourne blanc (ffffff),
  *     - `[(#VAL{fc3924}|couleur_luminance{1})]` retourne noir (000000)
  *     - `[(#VAL{fc3924}|couleur_luminance{0.5})]` retourne une luminance moyenne (fb1b03)
  *     - `[(#VAL{fc3924}|couleur_luminance{0.2})]` retourne la couleur avec 20% de luminance (fda49a)
- * 
+ *
  * @uses _couleur_hex_to_dec()
  * @uses couleur_saturation()
  * @uses _couleur_rgb2hsl()
  * @uses _couleur_hsl2rgb()
  * @uses _couleur_dec_to_hex()
- * 
+ *
  * @param string $couleur
  *      Couleur en écriture hexadécimale, tel que `ff3300`
  * @param float $val
@@ -192,9 +193,9 @@ function couleur_luminance($couleur, $val) {
 	include_spip('filtres/images_lib');
 
 	$couleurs = _couleur_hex_to_dec($couleur);
-	$r = $couleurs["red"];
-	$g = $couleurs["green"];
-	$b = $couleurs["blue"];
+	$r = $couleurs['red'];
+	$g = $couleurs['green'];
+	$b = $couleurs['blue'];
 
 	// Cas etonnant: quand gris parfait, la correction de HSL ne fonctionne pas
 	// en revanche, couleur_saturation retourne exactement la bonne valeur
@@ -204,14 +205,14 @@ function couleur_luminance($couleur, $val) {
 
 
 	$couleur = _couleur_rgb2hsl($r, $g, $b);
-	$h = $couleur["h"];
-	$s = $couleur["s"];
-	$l = $couleur["l"];
+	$h = $couleur['h'];
+	$s = $couleur['s'];
+	$l = $couleur['l'];
 
 	$rgb = _couleur_hsl2rgb($h, $s, 1 - $val);
-	$r = $rgb["r"];
-	$g = $rgb["g"];
-	$b = $rgb["b"];
+	$r = $rgb['r'];
+	$g = $rgb['g'];
+	$b = $rgb['b'];
 
 	$retour = _couleur_dec_to_hex($r, $g, $b);
 

filtres/images_lib.php

 <?php
+
 /***************************************************************************\
  *  SPIP, Système de publication pour l'internet                           *
  *                                                                         *
@@ -42,11 +43,10 @@ function _couleur_rgb2hsv($R, $G, $B) {
 	$V = $var_Max;
 	$L = ($var_Max + $var_Min) / 2;
 
-	if ($del_Max == 0)                     //This is a gray, no chroma...
-	{
-		$H = 0;                            //HSL results = 0 ÷ 1
+	if ($del_Max == 0) {                     //This is a gray, no chroma...
+	$H = 0;                            //HSL results = 0 ÷ 1
 		$S = 0;
-	} else                                    //Chromatic data...
+	} else //Chromatic data...
 	{
 		$S = $del_Max / $var_Max;
 
@@ -74,9 +74,9 @@ function _couleur_rgb2hsv($R, $G, $B) {
 		}
 	}
 
-	$ret["h"] = $H;
-	$ret["s"] = $S;
-	$ret["v"] = $V;
+	$ret['h'] = $H;
+	$ret['s'] = $S;
+	$ret['v'] = $V;
 
 	return $ret;
 }
@@ -93,9 +93,8 @@ function _couleur_rgb2hsv($R, $G, $B) {
  */
 function _couleur_hsv2rgb($H, $S, $V) {
 
-	if ($S == 0)                       //HSV values = 0 ÷ 1
-	{
-		$R = $V * 255;
+	if ($S == 0) {                       //HSV values = 0 ÷ 1
+	$R = $V * 255;
 		$G = $V * 255;
 		$B = $V * 255;
 	} else {
@@ -147,9 +146,9 @@ function _couleur_hsv2rgb($H, $S, $V) {
 		$G = $var_g * 255;
 		$B = $var_b * 255;
 	}
-	$ret["r"] = floor($R);
-	$ret["g"] = floor($G);
-	$ret["b"] = floor($B);
+	$ret['r'] = floor($R);
+	$ret['g'] = floor($G);
+	$ret['b'] = floor($B);
 
 	return $ret;
 }
@@ -157,7 +156,7 @@ function _couleur_hsv2rgb($H, $S, $V) {
 
 /**
  * Transformation d'une couleur RGB en HSL
- * 
+ *
  * HSL float entre 0 et 1
  * RGB entiers entre 0 et 255
  *
@@ -174,7 +173,7 @@ function _couleur_rgb2hsl($R, $G, $B) {
 
 /**
  * Transformation d'une couleur HSL en RGB
- * 
+ *
  * HSL float entre 0 et 1
  * RGB entiers entre 0 et 255
  *
@@ -198,34 +197,34 @@ function _couleur_hsl2rgb($H, $S, $L) {
 // https://code.spip.net/@image_couleur_extraire
 
 function _image_couleur_extraire($img, $x = 10, $y = 6) {
-	static $couleur_extraite = array();
+	static $couleur_extraite = [];
 
 	if (isset($couleur_extraite["$img-$x-$y"])) {
 		return $couleur_extraite["$img-$x-$y"];
 	}
 
 	// valeur par defaut si l'image ne peut etre lue
-	$defaut = "F26C4E";
+	$defaut = 'F26C4E';
 
-	$image = _image_valeurs_trans($img, "coul-$x-$y", "txt",null,false,_SVG_SUPPORTED);
+	$image = _image_valeurs_trans($img, "coul-$x-$y", 'txt', null, false, _SVG_SUPPORTED);
 	if (!$image) {
 		return $couleur_extraite["$img-$x-$y"] = $defaut;
 	}
 
 
-	$fichier = $image["fichier"];
-	$dest = $image["fichier_dest"];
+	$fichier = $image['fichier'];
+	$dest = $image['fichier_dest'];
 
 	if (isset($couleur_extraite["$fichier-$x-$y"])) {
 		return $couleur_extraite["$fichier-$x-$y"];
 	}
 
-	$creer = $image["creer"];
+	$creer = $image['creer'];
 
 	if ($creer) {
 		if (@file_exists($fichier)) {
-			if ($image['format_source'] === 'svg'){
-				$couleur="eeddcc";
+			if ($image['format_source'] === 'svg') {
+				$couleur = 'eeddcc';
 				$couleurs = svg_extract_couleurs($fichier);
 				if ($couleurs) {
 					$couleurs = array_map('svg_couleur_to_rgb', $couleurs);
@@ -238,15 +237,15 @@ function _image_couleur_extraire($img, $x = 10, $y = 6) {
 				}
 			}
 			else {
-				$width = $image["largeur"];
-				$height = $image["hauteur"];
+				$width = $image['largeur'];
+				$height = $image['hauteur'];
 
 				$newwidth = 20;
 				$newheight = 20;
 
 				$thumb = imagecreate($newwidth, $newheight);
 
-				$source = $image["fonction_imagecreatefrom"]($fichier);
+				$source = $image['fonction_imagecreatefrom']($fichier);
 
 				imagepalettetotruecolor($source);
 
@@ -255,8 +254,8 @@ function _image_couleur_extraire($img, $x = 10, $y = 6) {
 				if ($x === 'moyenne') {
 					$moyenne = null;
 					$nb_points = 0;
-					for ($x=0;$x<$newwidth;$x++) {
-						for ($y=0;$y<$newheight;$y++) {
+					for ($x = 0; $x < $newwidth; $x++) {
+						for ($y = 0; $y < $newheight; $y++) {
 							// get a color
 							$color_index = imagecolorat($thumb, $x, $y);
 							// make it human readable
@@ -284,7 +283,7 @@ function _image_couleur_extraire($img, $x = 10, $y = 6) {
 							$moyenne['blue'] = round($moyenne['blue'] / $nb_points);
 						}
 
-						$couleur = _couleur_dec_to_hex($moyenne["red"], $moyenne["green"], $moyenne["blue"]);
+						$couleur = _couleur_dec_to_hex($moyenne['red'], $moyenne['green'], $moyenne['blue']);
 					}
 				}
 				else {
@@ -298,7 +297,7 @@ function _image_couleur_extraire($img, $x = 10, $y = 6) {
 						$y++;
 					} while ($color_tran['alpha'] == 127 and $x < $newwidth and $y < $newheight);
 
-					$couleur = _couleur_dec_to_hex($color_tran["red"], $color_tran["green"], $color_tran["blue"]);
+					$couleur = _couleur_dec_to_hex($color_tran['red'], $color_tran['green'], $color_tran['blue']);
 				}
 			}
 		} else {

images_fonctions.php

@@ -68,9 +68,9 @@ $GLOBALS['spip_matrice']['_image_decale_composante_127'] = 'filtres/images_lib.p
 /**
  * Créer une image typo
  *
- * @note 
- *    Cas particulier historique : son nom commence par "image_" 
- *    mais s'applique sur un texte… 
+ * @note
+ *    Cas particulier historique : son nom commence par "image_"
+ *    mais s'applique sur un texte…
  * @return string
  */
 function image_typo() {

phpcs.xml.dist

+<?xml version="1.0"?>
+<ruleset>
+    <file>.</file>
+    <exclude-pattern>vendor/*</exclude-pattern>
+    <exclude-pattern>lang/*</exclude-pattern>
+    <exclude-pattern>tests/*</exclude-pattern>
+
+    <rule ref="SPIP41"/>
+
+    <config name="ignore_warnings_on_exit" value="1"/>
+    <arg name="cache" value=".php_cs.cache"/>
+    <arg name="report-full" value=".php_cs.txt"/>
+    <arg name="report-summary"/>
+    <arg value="s"/>
+</ruleset>

phpstan-baseline.neon

+parameters:
+	ignoreErrors:
+		-
+			message: "#^Function _couleur_dec_to_hex not found\\.$#"
+			count: 4
+			path: filtres/couleurs.php
+
+		-
+			message: "#^Function _couleur_hex_to_dec not found\\.$#"
+			count: 6
+			path: filtres/couleurs.php
+
+		-
+			message: "#^Function couleur_eclaircir not found\\.$#"
+			count: 1
+			path: filtres/couleurs.php
+
+		-
+			message: "#^Function couleur_foncer not found\\.$#"
+			count: 1
+			path: filtres/couleurs.php
+
+		-
+			message: "#^Function include_spip not found\\.$#"
+			count: 7
+			path: filtres/couleurs.php
+
+		-
+			message: "#^Function _couleur_dec_to_hex not found\\.$#"
+			count: 3
+			path: filtres/images_lib.php
+
+		-
+			message: "#^Function _couleur_hsl_to_rgb not found\\.$#"
+			count: 1
+			path: filtres/images_lib.php
+
+		-
+			message: "#^Function _couleur_rgb_to_hsl not found\\.$#"
+			count: 1
+			path: filtres/images_lib.php
+
+		-
+			message: "#^Function _image_valeurs_trans not found\\.$#"
+			count: 1
+			path: filtres/images_lib.php
+
+		-
+			message: "#^Function ecrire_fichier not found\\.$#"
+			count: 1
+			path: filtres/images_lib.php
+
+		-
+			message: "#^Function include_spip not found\\.$#"
+			count: 1
+			path: filtres/images_lib.php
+
+		-
+			message: "#^Function lire_fichier not found\\.$#"
+			count: 1
+			path: filtres/images_lib.php
+
+		-
+			message: "#^Function svg_extract_couleurs not found\\.$#"
+			count: 1
+			path: filtres/images_lib.php
+
+		-
+			message: "#^Function _couleur_hex_to_dec not found\\.$#"
+			count: 4
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function _image_ecrire_tag not found\\.$#"
+			count: 15
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function _image_gd_output not found\\.$#"
+			count: 27
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function _image_tag_changer_taille not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function _image_valeurs_trans not found\\.$#"
+			count: 22
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function charger_fonction not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function hauteur not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function image_reduire not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function imagick_isopaqueimage not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function imagick_readimage not found\\.$#"
+			count: 2
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function imagick_rotate not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function imagick_setfillcolor not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function imagick_writeimage not found\\.$#"
+			count: 2
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function include_spip not found\\.$#"
+			count: 6
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function largeur not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function spip_log not found\\.$#"
+			count: 2
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function spip_unlink not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function svg_ajouter_background not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function svg_ajouter_voile not found\\.$#"
+			count: 2
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function svg_filter_blur not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function svg_filter_grayscale not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function svg_filter_sepia not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function svg_flip not found\\.$#"
+			count: 2
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function svg_recadrer not found\\.$#"
+			count: 3
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function svg_rotate not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function svg_transformer not found\\.$#"
+			count: 1
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function taille_image not found\\.$#"
+			count: 3
+			path: filtres/images_transforme.php
+
+		-
+			message: "#^Function _T not found\\.$#"
+			count: 1
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function _image_gd_output not found\\.$#"
+			count: 1
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function couleur_html_to_hex not found\\.$#"
+			count: 1
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function find_in_path not found\\.$#"
+			count: 2
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function html2unicode not found\\.$#"
+			count: 1
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function include_spip not found\\.$#"
+			count: 2
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function init_mb_string not found\\.$#"
+			count: 1
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function inserer_attribut not found\\.$#"
+			count: 1
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function sous_repertoire not found\\.$#"
+			count: 1
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function spip_getimagesize not found\\.$#"
+			count: 1
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function spip_log not found\\.$#"
+			count: 1
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function spip_strlen not found\\.$#"
+			count: 2
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function spip_substr not found\\.$#"
+			count: 2
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Undefined variable\\: \\$line$#"
+			count: 1
+			path: filtres/images_typo.php
+
+		-
+			message: "#^Function include_spip not found\\.$#"
+			count: 1
+			path: images_fonctions.php
+

phpstan.neon.dist

+includes:
+	- phpstan-baseline.neon
+
+parameters:
+    paths:
+        - .
+    excludePaths:
+        analyseAndScan:
+            - vendor
+            - lang
+            - tests
+    level: 0