Base modifications

src/ApiConnectors/BaseApiConnector.php

@@ -47,6 +47,17 @@ public function __construct(AuthenticatedConnection $connection)
         $this->connection = $connection;
     }
 
+    /**
+     * Will return the current connection
+     *
+     * @return \PhpTwinfield\Secure\AuthenticatedConnection
+     * @throws Exception
+     */
+    public function getConnection(): AuthenticatedConnection
+    {
+        return $this->connection;
+    }
+
     /**
      * @see sendXmlDocument()
      * @throws Exception
@@ -161,4 +172,69 @@ protected function getFinderService(): FinderService
     {
         return $this->connection->getAuthenticatedClient(Services::FINDER());
     }
-}
+
+    /**
+     * Convert options array to an ArrayOfString which is accepted by Twinfield.
+     * 
+     * In some cases you are not allowed to change certain options (such as the dimtype, which should always be DEB when using CustomerApiConnector->ListAll()),
+     * in which case the $forcedOptions parameter will be set by the ApiConnector for this option, which will override any user settings in $options
+     *
+     * @param array $options
+     * @param array $forcedOptions
+     * @return array
+     * @throws Exception
+     */
+    public function convertOptionsToArrayOfString(array $options, array $forcedOptions = []): array {
+        if (isset($options['ArrayOfString'])) {
+            return $options;
+        }
+
+        $optionsArrayOfString = ['ArrayOfString' => []];
+
+        foreach ($forcedOptions as $key => $value) {
+            unset($options[$key]);
+            $optionsArrayOfString['ArrayOfString'][] = array($key, $value);
+        }
+
+        foreach ($options as $key => $value) {
+            $optionsArrayOfString['ArrayOfString'][] = array($key, $value);
+        }
+
+        return $optionsArrayOfString;
+    }
+
+    /**
+     * Map the response of a listAll to an array of the requested class
+     *
+     * @param string $objectClass
+     * @param $data
+     * @param array $objectListAllTags
+     * @return array
+     * @throws Exception
+     */
+    public function mapListAll(string $objectClass, $data, array $objectListAllTags): array {
+        if ($data->TotalRows == 0) {
+            return [];
+        }
+
+        $objects = [];
+
+        foreach ($data->Items->ArrayOfString as $responseArrayElement) {
+            $object = new $objectClass();
+
+            if (isset($responseArrayElement->string[0])) {
+                $elementArray = $responseArrayElement->string;
+            } else {
+                $elementArray = $responseArrayElement;
+            }
+
+            foreach ($objectListAllTags as $key => $method) {
+                $object->$method($elementArray[$key]);
+            }
+
+            $objects[] = $object;
+        }
+
+        return $objects;
+    }
+}

src/DomDocuments/BaseDocument.php

@@ -156,13 +156,24 @@ protected function appendPerformanceTypeFields(\DOMElement $element, $object): v
      * Use this instead of createElement().
      *
      * @param string $tag
-     * @param string $textContent
+     * @param string|null $textContent
+     * @param $object
+     * @param array $methodToAttributeMap
      * @return \DOMElement
      */
-    final protected function createNodeWithTextContent(string $tag, string $textContent): \DOMElement
+    final protected function createNodeWithTextContent(string $tag, ?string $textContent, $object = null, array $methodToAttributeMap = []): \DOMElement
     {
         $element = $this->createElement($tag);
-        $element->textContent = $textContent;
+
+        if ($textContent != null) {
+            $element->textContent = $textContent;
+        }
+
+        if (isset($object)) {
+            foreach ($methodToAttributeMap as $attributeName => $method) {
+                $element->setAttribute($attributeName, $object->$method());
+            }
+        }
 
         return $element;
     }

src/Mappers/BaseMapper.php

@@ -3,6 +3,8 @@
 namespace PhpTwinfield\Mappers;
 
 use Money\Currency;
+use Money\Money;
+use PhpTwinfield\Message\Message;
 use PhpTwinfield\Office;
 use PhpTwinfield\Util;
 use Webmozart\Assert\Assert;
@@ -62,17 +64,153 @@ protected static function getValueFromTag(\DOMDocument $document, string $tag):
         return $element->textContent;
     }
 
-    protected static function getField(\DOMElement $element, string $fieldTagName): ?string
+    protected static function checkForMessage($object, \DOMElement $element): void
+    {
+        if ($element->hasAttribute('msg')) {
+            $message = new Message();
+            $message->setType($element->getAttribute('msgtype'));
+            $message->setMessage($element->getAttribute('msg'));
+            $message->setField($element->nodeName);
+
+            $object->addMessage($message);
+        }
+    }
+
+    protected static function getAttribute(\DOMElement $element, string $fieldTagName, string $attributeName): ?string
+    {
+        $fieldElement = $element->getElementsByTagName($fieldTagName)->item(0);
+
+        if (!isset($fieldElement)) {
+            return null;
+        }
+
+        if ($fieldElement->getAttribute($attributeName) === "") {
+            return null;
+        }
+
+        return $fieldElement->getAttribute($attributeName);
+    }
+
+    protected static function getField(\DOMElement $element, string $fieldTagName, $object = null): ?string
     {
         $fieldElement = $element->getElementsByTagName($fieldTagName)->item(0);
+
         if (!isset($fieldElement)) {
             return null;
         }
 
+        if (isset($object)) {
+            self::checkForMessage($object, $fieldElement);
+        }
+
         if ($fieldElement->textContent === "") {
             return null;
         }
 
         return $fieldElement->textContent;
     }
+
+    protected static function parseBooleanAttribute(?string $value): ?bool
+    {
+        return filter_var($value, FILTER_VALIDATE_BOOLEAN);
+    }
+
+    protected static function parseDateAttribute(?string $value): ?\DateTimeImmutable
+    {
+        if (false !== strtotime($value)) {
+            return Util::parseDate($value);
+        }
+
+        return null;
+    }
+
+    protected static function parseDateTimeAttribute(?string $value): ?\DateTimeImmutable
+    {
+        if (false !== strtotime($value)) {
+            return Util::parseDateTime($value);
+        }
+
+        return null;
+    }
+
+    protected static function parseEnumAttribute(string $enumClass, ?string $value)
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        try {
+            $classReflex = new \ReflectionClass($enumClass);
+            $classConstants = $classReflex->getConstants();
+
+            foreach ($classConstants as $classConstant) {
+                if ($value == $classConstant) {
+                    return new $enumClass($value);
+                }
+            }
+        } catch (\ReflectionException $e) {
+            throw new \Exception("Non existant Enum, got \"{$enumClass}\".");
+        }
+
+        return null;
+    }
+
+    protected static function parseMoneyAttribute(?float $value): ?Money
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        return Util::parseMoney($value, new Currency('EUR'));
+    }
+
+    /** @var SomeClassWithMethodsetCode $object2 */
+    protected static function parseObjectAttribute(string $objectClass, $object, \DOMElement $element, string $fieldTagName, array $attributes = [])
+    {
+        if ($objectClass == "DimensionGroupDimension" || $objectClass == "UnknownDimension") {
+            if ($objectClass == "DimensionGroupDimension") {
+                $type = self::getField($element, "type", $object);
+            } elseif ($objectClass == "UnknownDimension") {
+                $type = self::getAttribute($element, $fieldTagName, "dimensiontype");
+            }
+
+            switch ($type) {
+                case "ACT":
+                    $objectClass = \PhpTwinfield\Activity::class;
+                    break;
+                case "AST":
+                    $objectClass = \PhpTwinfield\FixedAsset::class;
+                    break;
+                case "BAS":
+                    $objectClass = \PhpTwinfield\GeneralLedger::class;
+                    break;
+                case "CRD":
+                    $objectClass = \PhpTwinfield\Supplier::class;
+                    break;
+                case "DEB":
+                    $objectClass = \PhpTwinfield\Customer::class;
+                    break;
+                case "KPL":
+                    $objectClass = \PhpTwinfield\CostCenter::class;
+                    break;
+                case "PNL":
+                    $objectClass = \PhpTwinfield\GeneralLedger::class;
+                    break;
+                case "PRJ":
+                    $objectClass = \PhpTwinfield\Project::class;
+                    break;
+                default:
+                    throw new \InvalidArgumentException("parseObjectAttribute function does not accept \"{$objectClass}\" as valid input for the \$object argument");
+            }
+        }
+
+        $object2 = new $objectClass();
+        $object2->setCode(self::getField($element, $fieldTagName, $object));
+
+        foreach ($attributes as $attributeName => $method) {
+            $object2->$method(self::getAttribute($element, $fieldTagName, $attributeName));
+        }
+
+        return $object2;
+    }
 }

src/Request/Catalog/Catalog.php

@@ -5,13 +5,13 @@
  * Abstract parent class Catalog. Catalog is the name of the request
  * for LIST. List is a protected term in PHP so all instances of the word
  * catalog are just a replacement.
- * 
+ *
  * All aspects of LIST request require a parent element called 'list'
- * 
+ *
  * The constructor makes this element, appends to the itself.  All requirements
  * to add new elements to this <list> dom element are done through
  * the add() method.
- * 
+ *
  * @package PhpTwinfield
  * @subpackage Request\Catalog
  * @author Leon Rowland <[email protected]>
@@ -23,7 +23,7 @@ abstract class Catalog extends \DOMDocument
     /**
      * Holds the <list> element that all
      * additional elements should be a child of.
-     * 
+     *
      * @access private
      * @var \DOMElement
      */
@@ -32,7 +32,7 @@ abstract class Catalog extends \DOMDocument
     /**
      * Creates the <list> element and adds it to the property
      * listElement
-     * 
+     *
      * @access public
      */
     public function __construct()
@@ -45,10 +45,10 @@ public function __construct()
 
     /**
      * Adds additional elements to the <list> dom element.
-     * 
+     *
      * See the documentation over what <list> requires to know
      * what additional elements you need.
-     * 
+     *
      * @access protected
      * @param string $element
      * @param mixed $value

src/Request/Catalog/Office.php

@@ -3,7 +3,7 @@
 
 /**
  * Used to request a list offices
- * 
+ *
  * @package PhpTwinfield
  * @subpackage Request\Catalog
  * @author Leon Rowland <[email protected]>
@@ -14,14 +14,14 @@ class Office extends Catalog
 {
     /**
      * Adds the only required element for this request.
-     * 
+     *
      * No other methods exist or are required,
-     * 
+     *
      * @access public
      */
     public function __construct()
     {
         parent::__construct();
         $this->add('type', 'offices');
     }
-}
+}