Add projects create/update. Extend BaseMapper.

src/ApiConnectors/ProjectApiConnector.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace PhpTwinfield\ApiConnectors;
+
+use PhpTwinfield\DomDocuments\ProjectDocument;
+use PhpTwinfield\Exception;
+use PhpTwinfield\Project;
+use PhpTwinfield\Response\MappedResponseCollection;
+use PhpTwinfield\Response\Response;
+use Webmozart\Assert\Assert;
+
+/**
+ * A facade to make interaction with the Twinfield service easier when trying to retrieve or set information about
+ * Transactions.
+ *
+ * @author Jelle Roorda <[email protected]>
+ */
+class ProjectApiConnector extends BaseApiConnector
+{
+    /**
+     * @param Project $project
+     * @return Project
+     * @throws Exception
+     */
+    public function send(Project $project): Project
+    {
+        foreach ($this->sendAll([$project]) as $each) {
+            return $each->unwrap();
+        }
+    }
+
+    /**
+     *
+     * @param Project[] $projects
+     * @return MappedResponseCollection
+     * @throws Exception
+     */
+    public function sendAll(array $projects): MappedResponseCollection
+    {
+        Assert::allIsInstanceOf($projects, Project::class);
+
+        /** @var Response[] $responses */
+        $responses = [];
+
+        foreach ($this->getProcessXmlService()->chunk($projects) as $chunk) {
+            $projectDocument = new ProjectDocument;
+
+            foreach ($chunk as $project) {
+                $projectDocument->addProject($project);
+            }
+
+            $responses[] = $this->sendXmlDocument($projectDocument);
+        }
+
+        return $this->getProcessXmlService()->mapAll(
+            $responses,
+            "project",
+            function (Response $subresponse): Project {
+                return ProjectMapper::map(Project::class, $subresponse);
+            }
+        );
+    }
+}

src/DomDocuments/ProjectDocument.php

@@ -0,0 +1,114 @@
+<?php
+
+namespace PhpTwinfield\DomDocuments;
+
+use PhpTwinfield\Project;
+
+class ProjectDocument extends BaseDocument
+{
+    /**
+     * The root tag, e.g.
+     *
+     * @return string
+     */
+    protected function getRootTagName(): string
+    {
+        return 'dimension';
+    }
+
+    /**
+     * Turns a passed Project class into the required markup for interacting
+     * with Twinfield.
+     *
+     * This method doesn't return anything, instead just adds the transaction
+     * to this DOMDocument instance for submission usage.
+     *
+     * @param Project $project
+     */
+    public function addProject(Project $project)
+    {
+        $office = $project->getOffice();
+
+        // Transaction->status
+        $this->rootElement->setAttribute('status', $project->getStatus());
+
+        // Transaction > Office
+        $officeElement = $this->createNodeWithTextContent('office', $office->getName());
+        $this->rootElement->appendChild($officeElement);
+
+        // Transaction > Type
+        $typeElement = $this->createNodeWithTextContent('type', 'PRJ');
+        $this->rootElement->appendChild($typeElement);
+
+        // Transaction > Code
+        $codeElement = $this->createNodeWithTextContent('code', $office->getCode());
+        $this->rootElement->appendChild($codeElement);
+
+        // Transaction > Name
+        $nameElement = $this->createNodeWithTextContent('name', $project->getName());
+        $this->rootElement->appendChild($nameElement);
+
+        // Transaction > Short name
+        $shortNameElement = $this->createNodeWithTextContent('shortname', $project->getShortName());
+        $this->rootElement->appendChild($shortNameElement);
+
+        // Transaction > Projects
+        $projectsElement = $this->createElement('projects');
+
+        // Transaction > Projects > Invoice description
+        $invoiceDescriptionElement = $this->createNodeWithTextContent('invoicedescription',
+            $project->getInvoiceDescription());
+        $projectsElement->appendChild($invoiceDescriptionElement);
+
+        // Transaction > Projects > authoriser
+        // Todo: set the attributes on the authoriser element
+        $authoriserElement = $this->createNodeWithTextContent('authoriser', $project->getAuthoriser());
+        $projectsElement->appendChild($authoriserElement);
+
+        // Transaction > Projects > customer
+        // Todo: set the attributes on the customer element
+        $customerElement = $this->createNodeWithTextContent('customer', $project->getCustomer());
+        $projectsElement->appendChild($customerElement);
+
+        // Transaction > Projects > billable
+        // Todo: set the attributes on the billable element
+        $billableElement = $this->createNodeWithTextContent('billable', $project->getBillable());
+        $projectsElement->appendChild($billableElement);
+
+        // Transaction > Projects > rate
+        // Todo: set the attributes on the rate element
+        $rateElement = $this->createNodeWithTextContent('rate', $project->getRate());
+        $projectsElement->appendChild($rateElement);
+
+        // Transaction > Projects > Quantities
+        $projectsElement->appendChild($this->createQuantityElement($project));
+    }
+
+    /**
+     * @param Project $project
+     * @return \DOMElement
+     */
+    private function createQuantityElement(Project $project): \DOMElement
+    {
+        $quantityTags = [
+            'label',
+            'rate',
+            'billable',
+            'mandatory',
+        ];
+
+        $quantitiesElement = $this->createElement('quantities');
+
+        foreach ($project->getQuantities() as $quantity) {
+            // Create quantity tags
+            foreach ($quantityTags as $tag) {
+                $getter = 'get' . ucfirst($tag);
+                $tagElement = $this->createNodeWithTextContent($tag, $quantity->{$getter}());
+                $quantitiesElement->appendChild($tagElement);
+            }
+        }
+
+        return $quantitiesElement;
+    }
+
+}

src/Enums/ProjectStatus.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace PhpTwinfield\Enums;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * @method static ProjectStatus ACTIVE()
+ * @method static ProjectStatus DELETED()
+ * @method static ProjectStatus HIDE()
+ */
+class ProjectStatus extends Enum
+{
+    protected const ACTIVE = "active";
+    protected const DELETED = "deleted";
+    protected const HIDE = "hide";
+}

src/Fields/BehaviourField.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace PhpTwinfield\Fields;
+
+trait BehaviourField
+{
+    use BehaviourField;
+
+    private $behaviour;
+
+    /**
+     * READONLY attribute
+     * Get the behaviour attribute
+     * @return mixed
+     */
+    public function getBehaviour()
+    {
+        return $this->behaviour;
+    }
+
+    /**
+     * READONLY attribute
+     * Set the behaviour attribute
+     * @param mixed $behaviour
+     */
+    public function setBehaviour($behaviour): void
+    {
+        $this->behaviour = $behaviour;
+    }
+}

src/Fields/InUseField.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace PhpTwinfield\Fields;
+
+trait InUseField
+{
+    private $inuse;
+
+    /**
+     * READONLY attribute
+     * Get the inuse attribute
+     * @return mixed
+     */
+    public function getInuse()
+    {
+        return $this->inuse;
+    }
+
+    /**
+     * READONLY attribute
+     * Set the inuse attribute
+     * @param mixed $inuse
+     */
+    public function setInuse($inuse): void
+    {
+        $this->inuse = $inuse;
+    }
+}

src/Fields/TouchedField.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace PhpTwinfield\Fields;
+
+trait TouchedField
+{
+    private $touched;
+
+    /**
+     * READONLY attribute
+     * Get the touched attribute
+     * @return mixed
+     */
+    public function getTouched()
+    {
+        return $this->touched;
+    }
+
+    /**
+     * READONLY attribute
+     * Set the touched attribute
+     * @param int $touched
+     */
+    public function setTouched(int $touched): void
+    {
+        $this->touched = $touched;
+    }
+}

src/Fields/UIDField.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace PhpTwinfield\Fields;
+
+trait UIDField
+{
+    private $UID;
+
+    /**
+     * READONLY attribute
+     * Get the UID attribute
+     * @return mixed
+     */
+    public function getUID()
+    {
+        return $this->UID;
+    }
+
+    /**
+     * READONLY attribute
+     * Set the UID attribute
+     * @param mixed $UID
+     */
+    public function setUID($UID): void
+    {
+        $this->UID = $UID;
+    }
+}