Added support for queryFilter (SQL) in ListRequest and PrintRequest (riesenia#50)

* added support for queryFilter (SQL) in ListRequest and PrintRequest

* Record - filter/queryFilter are optional

* QueryFilter - fixed normalizer for "filter" and set as required

* Tests - it_creates_correct_xml_for_invoice_with_query_filter

Author: Mapiiik

spec/Pohoda/ListRequestSpec.php

@@ -105,6 +105,18 @@ public function it_creates_correct_xml_for_invoice_with_user_filter_name()
         $this->addUserFilterName('CustomFilter')->getXML()->asXML()->shouldReturn('<lst:listInvoiceRequest version="2.0" invoiceVersion="2.0" invoiceType="issuedInvoice"><lst:requestInvoice><ftr:userFilterName>CustomFilter</ftr:userFilterName></lst:requestInvoice></lst:listInvoiceRequest>');
     }
 
+    public function it_creates_correct_xml_for_invoice_with_query_filter()
+    {
+        $this->beConstructedWith([
+            'type' => 'Invoice'
+        ], '123');
+
+        $this->addQueryFilter([
+            'filter' => '(FA.DatSave>=CONVERT(DATETIME, \'01/31/2025 16:30:00\', 101) OR FA.DatLikv>=CONVERT(DATETIME, \'01/31/2025\', 101))',
+            'textName' => '(Uloženo >= 2025-01-31 16:30:00; Likv. >= 2025-01-31)',
+        ])->getXML()->asXML()->shouldReturn('<lst:listInvoiceRequest version="2.0" invoiceVersion="2.0" invoiceType="issuedInvoice"><lst:requestInvoice><ftr:queryFilter><ftr:filter>(FA.DatSave&gt;=CONVERT(DATETIME, \'01/31/2025 16:30:00\', 101) OR FA.DatLikv&gt;=CONVERT(DATETIME, \'01/31/2025\', 101))</ftr:filter><ftr:textName>(Uloženo &gt;= 2025-01-31 16:30:00; Likv. &gt;= 2025-01-31)</ftr:textName></ftr:queryFilter></lst:requestInvoice></lst:listInvoiceRequest>');
+    }
+
     public function it_creates_correct_xml_for_stock_with_complex_filter()
     {
         $this->beConstructedWith([

src/Pohoda/Filter/QueryFilter.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * This file is part of riesenia/pohoda package.
+ *
+ * Licensed under the MIT License
+ * (c) RIESENIA.com
+ */
+
+declare(strict_types=1);
+
+namespace Riesenia\Pohoda\Filter;
+
+use Riesenia\Pohoda\Agenda;
+use Riesenia\Pohoda\Common\OptionsResolver;
+
+class QueryFilter extends Agenda
+{
+    /** @var string[] */
+    protected $_elements = ['filter', 'textName'];
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getXML(): \SimpleXMLElement
+    {
+        $xml = $this->_createXML()->addChild('ftr:queryFilter', '', $this->_namespace('ftr'));
+
+        $this->_addElements($xml, $this->_elements, 'ftr');
+
+        return $xml;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function _configureOptions(OptionsResolver $resolver)
+    {
+        // available options
+        $resolver->setDefined($this->_elements);
+
+        // validate / format options
+        $resolver->setRequired('filter');
+        $resolver->setNormalizer('filter', $resolver->getNormalizer('string255'));
+        $resolver->setNormalizer('textName', $resolver->getNormalizer('string200'));
+    }
+}

src/Pohoda/ListRequest.php

@@ -11,6 +11,7 @@
 namespace Riesenia\Pohoda;
 
 use Riesenia\Pohoda\Common\OptionsResolver;
+use Riesenia\Pohoda\Filter\QueryFilter;
 use Riesenia\Pohoda\ListRequest\Filter;
 use Riesenia\Pohoda\ListRequest\Limit;
 use Riesenia\Pohoda\ListRequest\RestrictionData;
@@ -34,6 +35,20 @@ public function addFilter(array $data): self
         return $this;
     }
 
+    /**
+     * Add query filter (SQL).
+     *
+     * @param array<string,mixed> $data
+     *
+     * @return $this
+     */
+    public function addQueryFilter(array $data): self
+    {
+        $this->_data['queryFilter'] = new QueryFilter($data, $this->_ico);
+
+        return $this;
+    }
+
     /**
      * Add restriction data.
      *
@@ -118,7 +133,7 @@ public function getXML(): \SimpleXMLElement
                 $this->_addElements($xml, ['restrictionData'], 'lst');
             }
 
-            $this->_addElements($request, ['filter', 'userFilterName'], 'ftr');
+            $this->_addElements($request, ['filter', 'queryFilter', 'userFilterName'], 'ftr');
         }
 
         return $xml;

src/Pohoda/PrintRequest/Record.php

@@ -12,6 +12,7 @@
 
 use Riesenia\Pohoda\Agenda;
 use Riesenia\Pohoda\Common\OptionsResolver;
+use Riesenia\Pohoda\Filter\QueryFilter;
 
 class Record extends Agenda
 {
@@ -21,7 +22,14 @@ class Record extends Agenda
     public function __construct(array $data, string $ico, bool $resolveOptions = true)
     {
         // process filter
-        $data['filter'] = new Filter($data['filter'], $ico, $resolveOptions);
+        if (isset($data['filter'])) {
+            $data['filter'] = new Filter($data['filter'], $ico, $resolveOptions);
+        }
+
+        // process query filter (SQL)
+        if (isset($data['queryFilter'])) {
+            $data['queryFilter'] = new QueryFilter($data['queryFilter'], $ico, $resolveOptions);
+        }
 
         parent::__construct($data, $ico, $resolveOptions);
     }
@@ -34,7 +42,7 @@ public function getXML(): \SimpleXMLElement
         $xml = $this->_createXML()->addChild('prn:record', '', $this->_namespace('prn'));
         $xml->addAttribute('agenda', $this->_data['agenda']);
 
-        $this->_addElements($xml, ['filter'], 'prn');
+        $this->_addElements($xml, ['filter', 'queryFilter'], 'prn');
 
         return $xml;
     }
@@ -45,9 +53,8 @@ public function getXML(): \SimpleXMLElement
     protected function _configureOptions(OptionsResolver $resolver)
     {
         // available options
-        $resolver->setDefined(['agenda', 'filter']);
+        $resolver->setDefined(['agenda', 'filter', 'queryFilter']);
 
         $resolver->setRequired('agenda');
-        $resolver->setRequired('filter');
     }
 }