add phpstan and update code for level 2

sagautam5 · Apr 7, 2024 · e779ec0 · e779ec0
1 parent 2af2646
commit e779ec0
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 8 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,4 +20,6 @@ jobs:
       run: composer install --prefer-dist --no-progress --no-interaction
 
     - name: Run PHPUnit tests
-      run: vendor/bin/phpunit
+      run: vendor/bin/phpunit
+    - name: Run PhpStan Analyse Code
+      run:  vendor/bin/phpstan analyse --level=2 src tests
diff --git a/composer.json b/composer.json
@@ -13,7 +13,8 @@
         "php": ">=8.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "9.6.*"
+        "phpunit/phpunit": "9.6.*",
+        "phpstan/phpstan": "^1.10"
     },
     "autoload": {
         "psr-4": {

diff --git a/composer.lock b/composer.lock
diff --git a/src/Entities/BaseEntity.php b/src/Entities/BaseEntity.php
@@ -7,12 +7,12 @@
 abstract class BaseEntity
 {
     /**
-     * @var
+     * @var array<object>
      */
     protected $items;
 
     /**
-     * @var
+     * @var array<string>
      */
     protected $keys;
 

diff --git a/src/Entities/Category.php b/src/Entities/Category.php
@@ -58,7 +58,7 @@ public function find($id)
      * Find category by short code
      *
      * @param $short_code
-     * @return |null
+     * @return string|null
      */
     public function findByShortCode($short_code)
     {

diff --git a/src/Entities/District.php b/src/Entities/District.php
@@ -83,7 +83,7 @@ public function getDistrictsByProvince($provinceId)
      * Find district by id
      *
      * @param $id
-     * @return false|int|string
+     * @return object|null
      */
     public function find($id)
     {

diff --git a/src/Entities/Municipality.php b/src/Entities/Municipality.php
@@ -91,7 +91,7 @@ public function getMunicipalityByProvince($provinceId)
      * Find municipality by id
      *
      * @param $id
-     * @return false|int|string
+     * @return object|null
      */
     public function find($id)
     {