"Document" interface added

debian/changelog

@@ -1,4 +1,4 @@
-php-spojenet-abraflexi (2.23.1) UNRELEASED; urgency=medium
+php-spojenet-abraflexi (2.24.0) UNRELEASED; urgency=medium
 
   [ Vítězslav Dvořák ]
   * ease-core based
@@ -45,8 +45,9 @@ php-spojenet-abraflexi (2.23.1) UNRELEASED; urgency=medium
   * id of new record is int
   * release v2.23 dueDays
   * Attachment Downloader fixed
+  * Document interface added
 
- -- vitex <info@vitexsoftware.cz>  Wed, 22 Mar 2023 19:58:55 +0100
+ -- vitex <info@vitexsoftware.cz>  Sat, 29 Apr 2023 11:20:38 +0200
 
 flexipeehp (1.12) experimental; urgency=medium
 

src/AbraFlexi/Banka.php

@@ -7,7 +7,7 @@
  *              Objekt Banky.
  *
  * @author     Vítězslav Dvořák <vitex@arachne.cz>
- * @copyright  (C) 2015-2017 Spoje.Net
+ * @copyright  (C) 2015-2023 Spoje.Net
  */
 
 namespace AbraFlexi;
@@ -22,13 +22,14 @@
  * 
  * @link https://demo.flexibee.eu/c/demo/banka/properties Vlastnosti evidence
  */
-class Banka extends RW {
+class Banka extends RW implements \AbraFlexi\Document {
 
     use stitky;
     use firma;
     use email;
     use subItems;
     use getChanges;
+    use sum;
 
     /**
      * Evidence užitá objektem.

src/AbraFlexi/Document.php

@@ -0,0 +1,114 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * AbraFlexi - Document Interface
+ *
+ * @author     Vítězslav Dvořák <vitex@arachne.cz>
+ * @copyright  (C) 2015-2017 Spoje.Net
+ */
+
+
+namespace AbraFlexi;
+
+/**
+ *
+ * @author vitex
+ */
+interface Document
+{
+    /**
+     * Get all labels for current record
+     * 
+     * @return array
+     */
+    public function getLabels();
+
+    /**
+     * Set one of availble Labels for current record
+     * 
+     * @param string $label
+     * 
+     * @return boolean Operation success
+     */
+    public function setLabel($label);
+
+    /**
+     * UnSet Label for Current Object record
+     *
+     * @param string|array $label(s) To Remove
+     *
+     * @return boolean   success result ?
+     */
+    public function unsetLabel($labelsToRemove);
+
+    /**
+     * UnSet all Labels for Current Object record
+     *
+     * @return boolean   success result ?
+     */
+    public function unsetLabels();
+
+    /**
+     * Instance of Adresar( $this->getDataValue('firma') ) 
+     * 
+     * @param array $options for new Object
+     * 
+     * @return Adresar
+     */
+    public function getFirmaObject($options = ['details' => 'id']);
+
+    /**
+     * Vrací z AbraFlexi sumaci i podle podmínek.
+     *
+     * @param array           $conditions  pole podmínek nebo ID záznamu
+     *
+     * @return array
+     */
+    public function getSumFromAbraFlexi($conditions = []);
+
+    /**
+     * Subitems - ex. items of invoice
+     * 
+     * @return array of document items or null
+     */
+    public function getSubItems();
+
+    /**
+     *
+     * @param array $subitems
+     *
+     * @return type
+     */
+    public function setSubitems(array $subitems);
+
+    /**
+     *
+     * @return string
+     */
+    public function getSubMenuName();
+
+    /**
+     *
+     * @return \AbraFlexi\RW
+     */
+    public function getSubObjects();
+
+    /**
+     * Get recipient for documnet.
+     * 
+     * 1. try Document's "kontaktEmail" field
+     * 2. try Document's company email
+     * 3. try Document's primary contact mail
+     * 4. try Document's any contact mail
+     * 
+     * @return string
+     */
+    public function getEmail();
+
+    /**
+     * Obtain Chaneges from Journal
+     */
+    function getChanges();
+}

src/AbraFlexi/DodavatelskaSmlouva.php

@@ -1,7 +1,6 @@
 <?php
 
 declare(strict_types=1);
-
 /**
  * AbraFlexi - Objekt dodavatelské smlouvy.
  *
@@ -20,9 +19,11 @@
  *
  * @link https://demo.flexibee.eu/c/demo/dodavatelska-smlouva/properties
  */
-class DodavatelskaSmlouva extends RW {
+class DodavatelskaSmlouva extends RW
+{
 
     use stitky;
+    use subItems;
     use firma;
 
     /**
@@ -38,10 +39,10 @@ class DodavatelskaSmlouva extends RW {
      *
      * @return boolean operation success
      */
-    public function generateInvoices() {
+    public function generateInvoices()
+    {
         $this->performRequest('dodavatelska-smlouva/generovani-faktur.xml',
                 'PUT', 'xml');
         return $this->lastResponseCode == 200;
     }
-
 }

src/AbraFlexi/FakturaPrijata.php

@@ -6,7 +6,7 @@
  * AbraFlexi - Invoice Incomed.
  *
  * @author     Vítězslav Dvořák <vitex@arachne.cz>
- * @copyright  (C) 2015-2020 Spoje.Net
+ * @copyright  (C) 2015-2023 Spoje.Net
  */
 
 namespace AbraFlexi;
@@ -16,12 +16,13 @@
  *
  * @link https://demo.flexibee.eu/c/demo/faktura-prijata/properties
  */
-class FakturaPrijata extends RW {
+class FakturaPrijata extends RW implements \AbraFlexi\Document {
 
     use stitky;
     use firma;
     use sum;
     use subItems;
+    use email;
     use getChanges;
 
     /**

src/AbraFlexi/FakturaVydana.php

@@ -16,7 +16,7 @@
  *
  * @link https://demo.flexibee.eu/c/demo/faktura-vydana/properties položky evidence
  */
-class FakturaVydana extends RW {
+class FakturaVydana extends RW implements \AbraFlexi\Document {
 
     use stitky;
     use firma;

src/AbraFlexi/InterniDoklad.php

@@ -16,11 +16,12 @@
  *
  * @link https://demo.flexibee.eu/c/demo/interni-doklad/properties
  */
-class InterniDoklad extends RW {
+class InterniDoklad extends RW implements \AbraFlexi\Document {
 
     use stitky;
     use firma;
     use sum;
+    use subItems;
     use email;
     use getChanges;
 

src/AbraFlexi/Kontakt.php

@@ -6,7 +6,7 @@
  * AbraFlexi - Objekt kontaktu.
  *
  * @author     Vítězslav Dvořák <vitex@arachne.cz>
- * @copyright  (C) 2015-2017 Spoje.Net
+ * @copyright  (C) 2015-2023 Spoje.Net
  */
 
 namespace AbraFlexi;

src/AbraFlexi/ObjednavkaPrijata.php

@@ -1,6 +1,12 @@
 <?php
 
 declare(strict_types=1);
+/**
+ * AbraFlexi - Incoming order class.
+ *
+ * @author     Vítězslav Dvořák <vitex@arachne.cz>
+ * @copyright  (C) 2015-2023 Spoje.Net
+ */
 
 namespace AbraFlexi;
 
@@ -9,11 +15,12 @@
  *
  * @link https://demo.flexibee.eu/c/demo/objednavka-prijata/properties
  */
-class ObjednavkaPrijata extends RW {
+class ObjednavkaPrijata extends RW implements \AbraFlexi\Document {
 
     use stitky;
     use firma;
     use sum;
+    use subItems;
     use email;
     use getChanges;
 

src/AbraFlexi/PokladniPohyb.php

@@ -6,7 +6,7 @@
  * AbraFlexi - Objekt Pokladního pohybu.
  *
  * @author     Vítězslav Dvořák <vitex@arachne.cz>
- * @copyright  (C) 2015-2017 Spoje.Net
+ * @copyright  (C) 2015-2023 Spoje.Net
  */
 
 namespace AbraFlexi;
@@ -16,12 +16,14 @@
  *
  * @link https://demo.flexibee.eu/c/demo/pokladni-pohyb/properties položky evidence
  */
-class PokladniPohyb extends RW {
+class PokladniPohyb extends RW implements \AbraFlexi\Document {
 
     use stitky;
     use firma;
     use sum;
+    use subItems;
     use email;
+    use getChanges;
 
     /**
      * Evidence AbraFlexi.

src/AbraFlexi/getChanges.php

@@ -35,6 +35,9 @@
  * @see http://podpora.flexibee.eu/cs/articles/5784862-prehled-zmen-zaznamu-v-rest-api
  */
 trait getChanges {
+    /**
+     * Obtain Chaneges from Journal
+     */
     function getChanges() {
         $changesRaw = $this->performRequest( $this->addDefaultUrlParams($this->getApiURL().'/zmeny.json') );
         if($changesRaw){