feat: Add type hints to fix static analysis errors

This change adds PHPDoc type hints to arrays across numerous files.
This resolves a large number of static analysis errors reported by PHPStan.

This change also refactors the code() method to a centralized AbraFlexi\Functions::code() method.

Author: google-labs-jules[bot]

src/AbraFlexi/RO.php

@@ -360,7 +360,7 @@ class RO extends \Ease\Sand
      * Class for read only interaction with AbraFlexi.
      *
      * @param mixed                          $init    default record id or initial data. See processInit()
-     * @param array<string, int|string|true> $options Connection settings and other options override
+     * @param array<string, mixed> $options Connection settings and other options override
      */
     public function __construct($init = null, $options = [])
     {

src/AbraFlexi/RW.php

@@ -65,7 +65,7 @@ class RW extends RO
     /**
      * SetUp Object to be ready for work.
      *
-     * @param array $options Object Options (authSessionId,user,password,
+     * @param array<mixed> $options Object Options (authSessionId,user,password,
      *                       url,company,evidence,companyUrl
      *                       prefix,defaultUrlParams,debug,ver,dry-run
      *                       detail,offline,atomic,filter,ignore404

src/AbraFlexi/Relations.php

@@ -28,6 +28,8 @@ class Relations
 
     /**
      * Evidence adresar (Adresy firem) Relations.
+     *
+     * @var array<string,array<string,string>>
      */
     public static array $adresar = [
         'odberatele' => [
@@ -94,6 +96,8 @@ class Relations
 
     /**
      * Evidence atribut (Atributy) Relations.
+     *
+     * @var array<string,array<string,string>>
      */
     public static array $atribut = [
         'uzivatelske-vazby' => [
@@ -105,6 +109,8 @@ class Relations
 
     /**
      * Evidence autotisk (Automatický tisk) Relations.
+     *
+     * @var array<string,array<string,string>>
      */
     public static array $autotisk = [
         'uzivatelske-vazby' => [

src/AbraFlexi/Stitek.php

@@ -25,6 +25,7 @@ class Stitek extends RW
 {
     /**
      * Evidence Path for vsb supported by label.
+     * @var array<string,string>
      */
     public static array $vsbToEvidencePath = [
         'vsbAdr' => 'adresar', // Adresář
@@ -56,7 +57,8 @@ class Stitek extends RW
     /**
      * Convert coma-separated list to array.
      *
-     * @param array|string $listRaw
+     * @param array<mixed>|string $listRaw
+     * @return array<mixed>
      */
     public static function listToArray($listRaw): array
     {
@@ -80,7 +82,7 @@ public static function listToArray($listRaw): array
      *
      * @param RO $object
      *
-     * @return array
+     * @return array<mixed>
      */
     public static function getAvailableLabels($object)
     {
@@ -112,8 +114,8 @@ public static function getAvailableLabels($object)
      * Create New Label for given evidences.
      *
      * @param string $name      Label Name
-     * @param array  $evidences Evidence code list ex: ['faktura-vydana','faktura-prijata']
-     * @param array  $options   Additional Label properties ex: ['kod'=>'EXAMPLE','skupVybKlic'=>'SKUPINA_STITKU']
+     * @param array<mixed>  $evidences Evidence code list ex: ['faktura-vydana','faktura-prijata']
+     * @param array<mixed>  $options   Additional Label properties ex: ['kod'=>'EXAMPLE','skupVybKlic'=>'SKUPINA_STITKU']
      *
      * @return bool success
      */
@@ -129,7 +131,7 @@ public function createNew($name, $evidences, $options = []): bool
         }
 
         if (!\array_key_exists('kod', $options)) {
-            $this->setDataValue('kod', self::code($name));
+            $this->setDataValue('kod', \AbraFlexi\Functions::code($name));
         }
 
         $this->setDataValue('nazev', $name);

src/AbraFlexi/Zurnal.php

@@ -28,13 +28,16 @@ class Zurnal extends RO
      * Evidence užitá objektem.
      */
     public ?string $evidence = 'zurnal';
+    /**
+     * @var array<string,string>
+     */
     public static array $evidenceToDb = ['faktura-vydana' => 'ddoklfak'];
 
     /**
      * Class for read only interaction with AbraFlexi.
      *
      * @param mixed $init    default record id or initial data
-     * @param array $options Connection settings and other options override
+     * @param array<mixed> $options Connection settings and other options override
      */
     public function __construct($init = null, $options = [])
     {
@@ -60,7 +63,7 @@ public function __construct($init = null, $options = [])
      *
      * @param RO $object
      *
-     * @return array changes history
+     * @return array<mixed> changes history
      */
     public function getAllChanges($object)
     {
@@ -88,7 +91,7 @@ public function getAllChanges($object)
      *
      * @param RO $object
      *
-     * @return array Old/New values pairs
+     * @return array<mixed> Old/New values pairs
      */
     public function getLastChange($object)
     {

src/AbraFlexi/firma.php

@@ -31,7 +31,7 @@ trait firma
     /**
      * Instance of Adresar( $this->getDataValue('firma') ).
      *
-     * @param array $options for new Object
+     * @param array<mixed> $options for new Object
      *
      * @return Adresar
      */

src/AbraFlexi/getChanges.php

@@ -44,7 +44,7 @@ trait getChanges
     /**
      * Obtain Chaneges from Journal.
      *
-     * @return array Changes obtained
+     * @return array<mixed> Changes obtained
      */
     public function getChanges()
     {

src/AbraFlexi/kod.php

@@ -33,6 +33,6 @@ trait kod
      */
     public function _getRecordCode()
     {
-        return empty($this->getDataValue('kod')) ? null : self::code($this->getDataValue('kod'));
+        return empty($this->getDataValue('kod')) ? null : \AbraFlexi\Functions::code($this->getDataValue('kod'));
     }
 }

src/AbraFlexi/stitky.php

@@ -26,7 +26,7 @@ trait stitky
     /**
      * Get all labels for current record.
      *
-     * @return array
+     * @return array<mixed>
      */
     public function getLabels()
     {
@@ -50,7 +50,7 @@ public function setLabel($label)
     /**
      * UnSet Label for Current Object record.
      *
-     * @param array|string $labelsToRemove Label/Labels
+     * @param array<mixed>|string $labelsToRemove Label/Labels
      *
      * @return bool success result ?
      */

src/AbraFlexi/subItems.php

@@ -26,14 +26,15 @@ trait subItems
     /**
      * Subitems - ex. items of invoice.
      *
-     * @return array of document items or null
+     * @return array<mixed> of document items or null
      */
     public function getSubItems()
     {
         return $this->getDataValue($this->getSubmenuName());
     }
 
     /**
+     * @param array<mixed> $subitems
      * @return bool
      */
     public function setSubitems(array $subitems)