Updates documentation comments to English

Translates various documentation comments from Czech to English throughout several classes to improve accessibility for English-speaking developers.

No changes to the code logic or functionality were made; this update focuses solely on enhancing the clarity and understanding of the codebase.

Author: Vítězslav Dvořák

src/AbraFlexi/Adresar.php

@@ -37,7 +37,7 @@ class Adresar extends RW implements Document
     use kod;
 
     /**
-     * Evidence užitá objektem.
+     * Evidence used by object.
      */
     public ?string $evidence = 'adresar';
 

src/AbraFlexi/Banka.php

@@ -40,7 +40,7 @@ class Banka extends RW implements \AbraFlexi\Document
     use lock;
 
     /**
-     * Evidence užitá objektem.
+     * Evidence used by object.
      */
     public ?string $evidence = 'banka';
 

src/AbraFlexi/Cenik.php

@@ -2,7 +2,7 @@
 
 /**
  * AbraFlexi - Pricelist class.
- *              Objekt ceníku.
+ *              Pricelist object.
  *
  * @author     Vítězslav Dvořák <vitex@arachne.cz>
  * @copyright  (C) 2016-2024 Spoje.Net
@@ -23,9 +23,9 @@
 namespace AbraFlexi;
 
 /**
- * Ceník - Pricelist.
+ * Pricelist.
  *
- * @see https://demo.flexibee.eu/c/demo/cenik/properties Vlastnosti evidence
+ * @see https://demo.flexibee.eu/c/demo/cenik/properties Evidence properties
  *
  * @no-named-arguments
  */
@@ -37,7 +37,7 @@ class Cenik extends RW
     use kod;
 
     /**
-     * Evidence užitá objektem.
+     * Evidence used by object.
      */
     public ?string $evidence = 'cenik';
 }

src/AbraFlexi/Changes.php

@@ -15,22 +15,23 @@
 namespace AbraFlexi;
 
 /**
- * Log změn v evidencích.
+ * Changes log in evidence.
  *
- * @see https://www.abraflexi.eu/api/dokumentace/ref/changes-api/ Dokumentace
+ * @see https://www.abraflexi.eu/api/dokumentace/ref/changes-api/ Documentation
  *
  * @no-named-arguments
  */
 class Changes extends RO
 {
     /**
-     * Evidence užitá objektem.
+     * Evidence used by object.
      */
     public ?string $evidence = 'changes';
 
     /**
-     * Povolí oznamování změn
      * Allow changes notification.
+     *
+     * @return bool Success status
      */
     public function enable(): bool
     {
@@ -40,8 +41,9 @@ public function enable(): bool
     }
 
     /**
-     * Zakáže oznamování změn
      * Disallow changes notification.
+     *
+     * @return bool Success status
      */
     public function disable(): bool
     {
@@ -74,7 +76,7 @@ public function recordExists($data): bool
 
     /**
      * Obtain actual GlobalVersion
-     * Vrací aktuální globální verzi změn.
+     * Returns current global version of changes.
      *
      * @see https://www.abraflexi.eu/api/dokumentace/ref/changes-api#globalVersion Globální Verze
      *

src/AbraFlexi/Company.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * AbraFlexi - Objekt Společnosti.
+ * AbraFlexi - Company Object.
  *
  * @author     Vítězslav Dvořák <vitex@arachne.cz>
  * @copyright  (C) 2015-2023 Spoje.Net
@@ -22,19 +22,19 @@
 namespace AbraFlexi;
 
 /**
- * Firmy/účetní jednotky.
+ * Companies/accounting units.
  *
- * @note Tato položka nemá dostupné položky evidence
+ * @note This item has no available evidence items
  *
  * @no-named-arguments
  */
 class Company extends RW
 {
     /**
-     * AbraFlexi Company Class .
+     * AbraFlexi Company Class.
      *
-     * @param array|string $init    company dbNazev or initial data
-     * @param array        $options Connection settings override
+     * @param array<string, mixed>|string|null $init    Company dbNazev or initial data
+     * @param array<string, mixed>             $options Connection settings override
      */
     public function __construct($init = null, $options = [])
     {
@@ -76,7 +76,7 @@ public function processInit($init): void
     }
 
     /**
-     * Vrací základní URL pro užitou evidenci.
+     * Returns base URL for used evidence.
      *
      * @see https://www.abraflexi.eu/api/dokumentace/ref/urls/ Sestavování URL
      *
@@ -110,7 +110,7 @@ public function getApiURL($format = null): string
     }
 
     /**
-     * Vrací název evidence použité v odpovědích z AbraFlexi.
+     * Returns name of evidence used in responses from AbraFlexi.
      */
     public function getResponseEvidence(): string
     {

src/AbraFlexi/DateTime.php

@@ -15,7 +15,7 @@
 namespace AbraFlexi;
 
 /**
- * Description of DateTime.
+ * AbraFlexi DateTime class.
  *
  * @author vitex
  *
@@ -39,7 +39,7 @@ class DateTime extends \DateTime implements \Stringable
      *
      * @param string $flexidatetime 2017-09-26T10:00:53.755+02:00 or older 2017-05-19T00:00:00+02:00
      *
-     * @return \DateTime|false
+     * @throws \Exception Invalid date format
      */
     public function __construct(string $flexidatetime = 'NOW')
     {

src/AbraFlexi/Document.php

@@ -63,7 +63,7 @@ public function unsetLabels();
     public function getFirmaObject($options = ['details' => 'id']);
 
     /**
-     * Vrací z AbraFlexi sumaci i podle podmínek.
+     * Returns summation from AbraFlexi also according to conditions.
      *
      * @param array $conditions pole podmínek nebo ID záznamu
      *

src/AbraFlexi/DodavatelskaSmlouva.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * AbraFlexi - Objekt dodavatelské smlouvy.
+ * AbraFlexi - Supplier contract object.
  *
  * @author     Vítězslav Dvořák <vitex@arachne.cz>
  * @copyright  (C) 2015-2023 Spoje.Net
@@ -22,7 +22,7 @@
 namespace AbraFlexi;
 
 /**
- * Dodavatelská smlouva.
+ * Supplier contract.
  *
  * @see https://demo.flexibee.eu/c/demo/dodavatelska-smlouva/properties
  *
@@ -35,7 +35,7 @@ class DodavatelskaSmlouva extends RW
     use firma;
 
     /**
-     * Evidence užitá objektem.
+     * Evidence used by object.
      */
     public ?string $evidence = 'dodavatelska-smlouva';
 

src/AbraFlexi/EvidenceList.php

@@ -18,17 +18,17 @@
  * Evidencies listing and its properties
  * Seznam Evidencí a jejich vlastnosti.
  *
- * @see https://demo.flexibee.eu/c/demo/evidence-list Přehled evidencí
+ * @see https://demo.flexibee.eu/c/demo/evidence-list Evidence overview
  */
 class EvidenceList extends RO
 {
     /**
-     * Evidence užitá objektem.
+     * Evidence used by object.
      */
     public ?string $evidence = 'evidence-list';
 
     /**
-     * Základní namespace pro komunikaci s FlexiBee.
+     * Base namespace for communication with FlexiBee.
      * Basic namespace for communication with FlexiBee.
      *
      * @var string Jmený prostor datového bloku odpovědi

src/AbraFlexi/Exception.php

@@ -15,7 +15,7 @@
 namespace AbraFlexi;
 
 /**
- * Description of Exception.
+ * AbraFlexi Exception class.
  *
  * @author vitex
  *
@@ -38,8 +38,9 @@ class Exception extends \Ease\Exception
     /**
      * AbraFlexi response as Exception.
      *
-     * @param string $message good to know
-     * @param RO     $caller  AbraFlexi Object
+     * @param string            $message  Exception message
+     * @param RO                $caller   AbraFlexi Object
+     * @param \Ease\Exception|null $previous Previous exception
      */
     public function __construct($message, RO $caller, ?\Ease\Exception $previous = null)
     {