fix PHPCS config, add Slevomat rules

Author: codemasher

.github/workflows/ci.yml

@@ -47,11 +47,12 @@ jobs:
       - name: "Install dependencies with composer"
         uses: ramsey/composer-install@v3
 
-      - name: "Run phan"
-        run: php vendor/bin/phan --target-php-version=${{ matrix.php-version }}
       - name: "Run PHPStan"
         run: php vendor/bin/phpstan
 
+      - name: "Run PHP_CodeSniffer"
+        run: php vendor/bin/phpstan
+
 
   tests:
     name: "Unit Tests"

composer.json

@@ -60,6 +60,7 @@
 		"phpstan/phpstan": "^1.11",
 		"phpstan/phpstan-deprecation-rules": "^1.2",
 		"setasign/fpdf": "^1.8.2",
+		"slevomat/coding-standard": "^8.15",
 		"squizlabs/php_codesniffer": "^3.10"
 	},
 	"suggest": {
@@ -92,6 +93,9 @@
 	"config": {
 		"lock": false,
 		"sort-packages": true,
-		"platform-check": true
+		"platform-check": true,
+		"allow-plugins": {
+			"dealerdirect/phpcodesniffer-composer-installer": true
+		}
 	}
 }

examples/custom_output.php

@@ -21,33 +21,21 @@
 
 class MyCustomOutput extends QROutputAbstract{
 
-	/**
-	 * @inheritDoc
-	 */
 	public static function moduleValueIsValid(mixed $value):bool{
 		// TODO: Implement moduleValueIsValid() method. (interface)
 		return false;
 	}
 
-	/**
-	 * @inheritDoc
-	 */
 	protected function prepareModuleValue(mixed $value):mixed{
 		// TODO: Implement prepareModuleValue() method. (abstract)
 		return null;
 	}
 
-	/**
-	 * @inheritDoc
-	 */
 	protected function getDefaultModuleValue(bool $isDark):mixed{
 		// TODO: Implement getDefaultModuleValue() method. (abstract)
 		return null;
 	}
 
-	/**
-	 * @inheritDoc
-	 */
 	public function dump(string|null $file = null):string{
 		$output = '';
 

examples/eps.php

@@ -55,7 +55,7 @@
 
 $out = (new QRCode($options))->render('https://www.youtube.com/watch?v=dQw4w9WgXcQ', __DIR__.'/qrcode.eps');
 
-if(php_sapi_name() !== 'cli'){
+if(PHP_SAPI !== 'cli'){
 	// if viewed in the browser, we should push it as file download as EPS isn't usually supported
 	header('Content-type: application/postscript');
 	header('Content-Disposition: filename="qrcode.eps"');

examples/fpdf.php

@@ -11,7 +11,7 @@
 use chillerlan\QRCode\Data\QRMatrix;
 use chillerlan\QRCode\Output\QRFpdf;
 
-require_once __DIR__ . '/../vendor/autoload.php';
+require_once __DIR__.'/../vendor/autoload.php';
 
 $options = new QROptions;
 
@@ -53,7 +53,7 @@
 
 $out = (new QRCode($options))->render('https://www.youtube.com/watch?v=dQw4w9WgXcQ');
 
-if(php_sapi_name() !== 'cli'){
+if(PHP_SAPI !== 'cli'){
 	header('Content-type: application/pdf');
 }
 

examples/imageWithLogo.php

@@ -24,13 +24,11 @@
 class QRImageWithLogo extends QRGdImagePNG{
 
 	/**
-	 * @param string|null $file
-	 * @param string|null $logo
-	 *
-	 * @return string
 	 * @throws \chillerlan\QRCode\Output\QRCodeOutputException
 	 */
 	public function dump(string|null $file = null, string|null $logo = null):string{
+		$logo ??= '';
+
 		// set returnResource to true to skip further processing for now
 		$this->options->returnResource = true;
 
@@ -45,6 +43,10 @@ public function dump(string|null $file = null, string|null $logo = null):string{
 
 		$im = imagecreatefrompng($logo);
 
+		if($im === false){
+			throw new QRCodeOutputException('imagecreatefrompng() error');
+		}
+
 		// get logo image size
 		$w = imagesx($im);
 		$h = imagesy($im);

examples/imageWithRoundedShapes.php

@@ -19,23 +19,21 @@
 use chillerlan\QRCode\Output\QRGdImagePNG;
 use chillerlan\Settings\SettingsContainerInterface;
 
-require_once __DIR__ . '/../vendor/autoload.php';
+require_once __DIR__.'/../vendor/autoload.php';
 
 // --------------------
 // Class definition
 // --------------------
 
 class QRGdRounded extends QRGdImagePNG{
 
-	/** @inheritDoc */
 	public function __construct(SettingsContainerInterface|QROptions $options, QRMatrix $matrix){
 		// enable the internal scaling for better rounding results at scale < 20
 		$options->drawCircularModules = true;
 
 		parent::__construct($options, $matrix);
 	}
 
-	/** @inheritDoc */
 	protected function module(int $x, int $y, int $M_TYPE):void{
 
 		/**
@@ -121,7 +119,7 @@ protected function module(int $x, int $y, int $M_TYPE):void{
 			(int)($y * $this->scale + $this->scale / 2),
 			($this->scale - 1),
 			($this->scale - 1),
-			$light
+			$light,
 		);
 	}
 
@@ -133,14 +131,14 @@ protected function module(int $x, int $y, int $M_TYPE):void{
 // --------------------
 
 $options = new QROptions([
-    'version'         => 7,
-    'eccLevel'        => EccLevel::H,
-    'outputInterface' => QRGdRounded::class,
-    'outputBase64'    => false,
-    'scale'           => 30,
-    'addLogoSpace'    => true,
-    'logoSpaceWidth'  => 13,
-    'logoSpaceHeight' => 13,
+	'version'         => 7,
+	'eccLevel'        => EccLevel::H,
+	'outputInterface' => QRGdRounded::class,
+	'outputBase64'    => false,
+	'scale'           => 30,
+	'addLogoSpace'    => true,
+	'logoSpaceWidth'  => 13,
+	'logoSpaceHeight' => 13,
 ]);
 
 

examples/imageWithText.php

@@ -23,9 +23,6 @@
 
 class QRImageWithText extends QRGdImagePNG{
 
-	/**
-	 * @inheritDoc
-	 */
 	public function dump(string|null $file = null, string|null $text = null):string{
 		// set returnResource to true to skip further processing for now
 		$this->options->returnResource = true;

examples/imagickConvertSVGtoPNG.php

@@ -14,17 +14,18 @@
  * @author       smiley <[email protected]>
  * @copyright    2023 smiley
  * @license      MIT
+ *
+ * @noinspection PhpComposerExtensionStubsInspection
  */
 
 use chillerlan\QRCode\{QRCode, QROptions};
 use chillerlan\QRCode\Data\QRMatrix;
-use chillerlan\QRCode\Output\QRMarkupSVG;
+use chillerlan\QRCode\Output\{QRCodeOutputException, QRMarkupSVG};
 
 require_once __DIR__.'/../vendor/autoload.php';
 
 class SVGConvert extends QRMarkupSVG{
 
-	/** @inheritDoc */
 	protected function header():string{
 		[$width, $height] = $this->getOutputDimensions();
 
@@ -36,7 +37,7 @@ protected function header():string{
 			$this->options->svgPreserveAspectRatio,
 			$this->options->eol,
 			($width * $this->scale), // use the scale option to modify the size
-			($height * $this->scale)
+			($height * $this->scale),
 		);
 
 		if($this->options->svgAddXmlHeader){
@@ -46,7 +47,6 @@ protected function header():string{
 		return $header;
 	}
 
-	/** @inheritDoc */
 	public function dump(string|null $file = null):string{
 		$base64 = $this->options->outputBase64;
 		// we don't want the SVG in base64
@@ -70,7 +70,13 @@ public function dump(string|null $file = null):string{
 
 		if($base64){
 			// use finfo to guess the mime type
-			$imageData = $this->toBase64DataURI($imageData, (new finfo(FILEINFO_MIME_TYPE))->buffer($imageData));
+			$mime = (new finfo(FILEINFO_MIME_TYPE))->buffer($imageData);
+
+			if($mime === false){
+				throw new QRCodeOutputException('unable to detect mime type');
+			}
+
+			$imageData = $this->toBase64DataURI($imageData);
 		}
 
 		return $imageData;

examples/imagickImageAsBackground.php

@@ -16,17 +16,11 @@
 
 class QRImagickImageAsBackground extends QRImagick{
 
-	/**
-	 * @inheritDoc
-	 */
 	protected function getDefaultModuleValue(bool $isDark):ImagickPixel{
 		// RGBA, adjust opacity to increase contrast
 		return $this->prepareModuleValue(($isDark) ? '#00000040' : '#ffffffa0');
 	}
 
-	/**
-	 * @inheritDoc
-	 */
 	protected function createImage():Imagick{
 		$imagick = new Imagick($this->options->background);
 		$width   = $imagick->getImageWidth();