Merge pull request #2 from artemeon/phpstan

feat: PHPStan

Author: marcreichel

.github/workflows/ci.yml

@@ -1,33 +1,41 @@
 name: CI
 on:
-  - pull_request
-  - push
+  pull_request:
+  push:
+    branches:
+      - master
 jobs:
-  psalm:
-    name: Psalm
+  phpstan:
+    name: PHPStan
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.0
+          php-version: 8.2
           coverage: none
       - name: Composer install
         run: composer install --no-interaction --no-ansi --no-progress
-      - name: Run Psalm
-        run: vendor/bin/psalm --no-progress --show-info=false
+      - name: Run PHPStan
+        run: composer run phpstan
   phpunit:
-    name: PHPUnit
-    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ ubuntu-latest ]
+        php: [ 8.3, 8.2, 8.1, 8.0 ]
+        stability: [ prefer-stable ]
+    name: PHPUnit - PHP ${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.0
+          php-version: ${{ matrix.php }}
           coverage: none
       - name: Composer install
         run: composer install --no-interaction --no-ansi --no-progress

.gitignore

@@ -0,0 +1,3 @@
+.idea
+vendor
+composer.lock

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 ARTEMEON
+Copyright (c) 2024 ARTEMEON Management Partner GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

composer.json

@@ -5,13 +5,18 @@
   "keywords": ["pdf"],
   "homepage": "https://github.com/artemeon/pdf",
   "license": "MIT",
+  "scripts": {
+    "phpstan": "php ./vendor/bin/phpstan analyse --memory-limit=4G"
+  },
   "require": {
     "php": ">=8.0",
     "tecnickcom/tcpdf": "^6.4"
   },
   "require-dev": {
     "phpunit/phpunit": "^8.0",
-    "vimeo/psalm": "^4.22"
+    "phpstan/phpstan": "^1.10",
+    "phpstan/extension-installer": "^1.3",
+    "phpstan/phpstan-phpunit": "^1.3"
   },
   "autoload": {
     "psr-4": {
@@ -22,5 +27,10 @@
     "psr-4": {
       "Artemeon\\Pdf\\Tests\\": "tests"
     }
+  },
+  "config": {
+    "allow-plugins": {
+      "phpstan/extension-installer": true
+    }
   }
 }

phpstan.neon

@@ -0,0 +1,8 @@
+includes:
+    - phar://phpstan.phar/conf/bleedingEdge.neon
+
+parameters:
+    level: 5
+    paths:
+        - src
+        - tests

psalm.xml

@@ -107,11 +107,7 @@ public function setStrKeywords($strKeywords)
         $this->objPdf->SetKeywords($strKeywords);
     }
 
-    /**
-     * @return bool
-     * @return void
-     */
-    public function getBitHeader()
+    public function getBitHeader(): bool
     {
         return $this->objPdf->getBitHeader();
     }
@@ -256,7 +252,7 @@ public function addCell($strContent = '', $intWidth = 0, $intHeight = 0, $bitBor
             $strBorders = 0;
         }
 
-        $this->objPdf->Cell($intWidth, $intHeight, $strContent, $strBorders, 1, $strAlign, $bitFill);
+        $this->objPdf->Cell($intWidth, $intHeight, $strContent, $strBorders, 1, $strAlign, (bool) $bitFill);
     }
 
     /**

src/Pdf.php

@@ -33,14 +33,12 @@ class PdfTcpdf extends TCPDF
     protected $bitFooter = true;
 
     /**
-     *
-     * @var PdfHeaderInterface
+     * @var ?PdfHeaderInterface
      */
     protected $objHeader = null;
 
     /**
-     *
-     * @var PdfFooterInterface
+     * @var ?PdfFooterInterface
      */
     protected $objFooter = null;
 
@@ -65,7 +63,7 @@ public function Header()
         $intStyle = $this->FontStyle;
 
 
-        if ($this->objHeader != null && $this->objHeader instanceof PdfHeaderInterface) {
+        if ($this->objHeader instanceof PdfHeaderInterface) {
             $this->objHeader->writeHeader($this);
         }
 
@@ -86,7 +84,7 @@ public function Footer()
         $intSize = $this->FontSize;
         $intStyle = $this->FontStyle;
 
-        if ($this->objFooter != null && $this->objFooter instanceof PdfFooterInterface) {
+        if ($this->objFooter instanceof PdfFooterInterface) {
             $this->objFooter->writeFooter($this);
         }