Merge branch 'develop'

* develop:
  Code cleanup: Remove unused import
  New functionality: CamundaProcessInstanceService::getList() and ::delete(). Move CamundaRestRequest::responseToJson() to CamundaResponse::restResponseToJson().

Author: tistre

src/CamundaProcessInstance.php

@@ -0,0 +1,115 @@
+<?php
+
+namespace StrehleDe\CamundaClient;
+
+
+class CamundaProcessInstance
+{
+    protected string $businessKey;
+    protected string $caseInstanceId;
+    protected string $definitionId;
+    protected bool $ended;
+    protected string $id;
+    protected bool $suspended;
+    protected string $tenantId;
+
+
+    /**
+     * @param array $json
+     * @return self
+     */
+    public function fromJson(array $json): self
+    {
+        $propertyValues = CamundaUtils::jsonToPropertyValues(
+            $json,
+            get_class($this),
+            $this->getPropertiesToCopyFromRestResponse()
+        );
+
+        foreach ($propertyValues as $propertyName => $value) {
+            $this->{$propertyName} = $value;
+        }
+
+        return $this;
+    }
+
+
+    /**
+     * @return array
+     */
+    protected function getPropertiesToCopyFromRestResponse(): array
+    {
+        return [
+            'businessKey',
+            'caseInstanceId',
+            'definitionId',
+            'ended',
+            'id',
+            'suspended',
+            'tenantId'
+        ];
+    }
+
+
+    /**
+     * @return string|null
+     */
+    public function getBusinessKey(): ?string
+    {
+        return $this->businessKey ?? null;
+    }
+
+
+    /**
+     * @return string|null
+     */
+    public function getCaseInstanceId(): ?string
+    {
+        return $this->caseInstanceId ?? null;
+    }
+
+
+    /**
+     * @return string|null
+     */
+    public function getDefinitionId(): ?string
+    {
+        return $this->definitionId ?? null;
+    }
+
+
+    /**
+     * @return bool|null
+     */
+    public function isEnded(): ?bool
+    {
+        return $this->ended ?? null;
+    }
+
+
+    /**
+     * @return string|null
+     */
+    public function getId(): ?string
+    {
+        return $this->id ?? null;
+    }
+
+
+    /**
+     * @return bool|null
+     */
+    public function isSuspended(): ?bool
+    {
+        return $this->suspended ?? null;
+    }
+
+
+    /**
+     * @return string|null
+     */
+    public function getTenantId(): ?string
+    {
+        return $this->tenantId ?? null;
+    }
+}

src/CamundaProcessInstanceBag.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace StrehleDe\CamundaClient;
+
+use ArrayIterator;
+
+
+/**
+ * Class CamundaProcessInstanceBag
+ * @package StrehleDe\CamundaClient
+ */
+class CamundaProcessInstanceBag extends ArrayIterator
+{
+    public function __construct(CamundaProcessInstance ...$instances)
+    {
+        parent::__construct($instances);
+    }
+
+
+    public function current(): CamundaProcessInstance
+    {
+        return parent::current();
+    }
+
+
+    public function offsetGet($offset): CamundaProcessInstance
+    {
+        return parent::offsetGet($offset);
+    }
+}

src/CamundaResponse.php

@@ -3,6 +3,8 @@
 namespace StrehleDe\CamundaClient;
 
 
+use Psr\Http\Message\ResponseInterface;
+
 abstract class CamundaResponse
 {
     /**
@@ -32,4 +34,20 @@ protected function getPropertiesToCopyFromJson(): array
     {
         return [];
     }
+
+
+    /**
+     * Parse JSON response string into array, throw exception on error response
+     *
+     * @param ResponseInterface $response
+     * @return array
+     */
+    public static function restResponseToJson(ResponseInterface $response): array
+    {
+        if (!in_array('application/json', $response->getHeader('Content-Type'))) {
+            return [];
+        }
+
+        return json_decode($response->getBody(), true, 512, JSON_THROW_ON_ERROR);
+    }
 }

src/CamundaRestRequest.php

@@ -146,20 +146,4 @@ public function send(): ResponseInterface
              throw new CamundaRequestException($restResponse->message ?? json_encode($restResponse));
          */
     }
-
-
-    /**
-     * Parse JSON response string into array, throw exception on error response
-     *
-     * @param ResponseInterface $response
-     * @return array
-     */
-    public static function responseToJson(ResponseInterface $response): array
-    {
-        if (!in_array('application/json', $response->getHeader('Content-Type'))) {
-            return [];
-        }
-
-        return json_decode($response->getBody(), true, 512, JSON_THROW_ON_ERROR);
-    }
 }

src/Service/ExternalTask/CamundaExternalTaskFetchAndLockResponse.php

@@ -6,7 +6,6 @@
 use StrehleDe\CamundaClient\CamundaExternalTask;
 use StrehleDe\CamundaClient\CamundaExternalTaskBag;
 use StrehleDe\CamundaClient\CamundaResponse;
-use StrehleDe\CamundaClient\CamundaRestRequest;
 use StrehleDe\CamundaClient\Exception\CamundaRequestException;
 
 
@@ -35,7 +34,7 @@ public function __construct()
      */
     public function fromRestResponse(ResponseInterface $restResponse): self
     {
-        $json = CamundaRestRequest::responseToJson($restResponse);
+        $json = CamundaResponse::restResponseToJson($restResponse);
 
         if (!is_array($json)) {
             throw new CamundaRequestException(sprintf('%s: Response is not an array', __METHOD__));

src/Service/ProcessDefinition/CamundaProcessDefinitionStartInstanceResponse.php

@@ -4,7 +4,6 @@
 
 use Psr\Http\Message\ResponseInterface;
 use StrehleDe\CamundaClient\CamundaResponse;
-use StrehleDe\CamundaClient\CamundaRestRequest;
 use StrehleDe\CamundaClient\Variable\CamundaVariableBag;
 
 
@@ -40,7 +39,7 @@ public function __construct()
      */
     public function fromRestResponse(ResponseInterface $restResponse): self
     {
-        $json = CamundaRestRequest::responseToJson($restResponse);
+        $json = CamundaResponse::restResponseToJson($restResponse);
 
         parent::jsonToProperties($json);
 

src/Service/ProcessInstance/CamundaProcessInstanceDeleteRequest.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace StrehleDe\CamundaClient\Service\ProcessInstance;
+
+use GuzzleHttp\RequestOptions;
+use StrehleDe\CamundaClient\CamundaRequest;
+use StrehleDe\CamundaClient\CamundaRestRequest;
+
+
+class CamundaProcessInstanceDeleteRequest extends CamundaRequest
+{
+    protected bool $failIfNotExists;
+    protected string $id;
+
+
+    /**
+     * @return CamundaRestRequest
+     */
+    public function toRestRequest(): CamundaRestRequest
+    {
+        $query = [];
+
+        if ($this->isFailIfNotExists() !== null) {
+            $query['failIfNotExists'] = $this->isFailIfNotExists();
+        }
+
+        return (new CamundaRestRequest($this->camundaClient))
+            ->setRequestUrl('/process-instance/' . urlencode($this->getId()))
+            ->setRequestMethod('DELETE')
+            ->setRequestOption(RequestOptions::QUERY, $query);
+    }
+
+
+    /**
+     * @return string[]
+     */
+    protected function getRequiredProperties(): array
+    {
+        return ['id'];
+    }
+
+
+    /**
+     * @return string|null
+     */
+    public function getId(): ?string
+    {
+        return $this->id ?? null;
+    }
+
+
+    /**
+     * @param string $id
+     * @return self
+     */
+    public function setId(string $id): self
+    {
+        $this->id = $id;
+        return $this;
+    }
+
+
+    /**
+     * @return bool|null
+     */
+    public function isFailIfNotExists(): ?bool
+    {
+        return $this->failIfNotExists ?? null;
+    }
+
+
+    /**
+     * @param bool $failIfNotExists
+     * @return self
+     */
+    public function setFailIfNotExists(bool $failIfNotExists): self
+    {
+        $this->failIfNotExists = $failIfNotExists;
+        return $this;
+    }
+}