Add a bunch of new structs to support new workflow methods

Author: usox

src/Struct/Workflow/WorkflowConfigVersion.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Scn\EvalancheSoapStruct\Struct\Workflow;
+
+/**
+ * Represents a config version item
+ */
+class WorkflowConfigVersion implements WorkflowConfigVersionInterface
+{
+    /** @var string */
+    private $configVersion;
+    
+    /** @var int */
+    private $createDate;
+    
+    /** @var bool */
+    private $latest;
+    
+    public function __construct(
+        string $configVersion = null,
+        int $createDate = null,
+        bool $latest = null
+    ) {
+        $this->configVersion = $configVersion;
+        $this->createDate = $createDate;
+        $this->latest = $latest;
+    }
+    
+    public function getConfigVersion(): string
+    {
+        return $this->configVersion;
+    }
+    
+    public function getCreateDate(): int
+    {
+        return $this->createDate;
+    }
+    
+    public function getLatest(): bool
+    {
+        return $this->latest;
+    }
+}

src/Struct/Workflow/WorkflowConfigVersionInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Scn\EvalancheSoapStruct\Struct\Workflow;
+
+use Scn\EvalancheSoapStruct\Struct\StructInterface;
+
+/**
+ * Represents a config version item
+ */
+interface WorkflowConfigVersionInterface extends StructInterface
+{
+    public function getConfigVersion(): string;
+
+    public function getCreateDate(): int;
+
+    public function getLatest(): bool;
+}

src/Struct/Workflow/WorkflowConfiguration.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Scn\EvalancheSoapStruct\Struct\Workflow;
+
+/**
+ * Represents the result of a workflows getConfiguration call
+ */
+class WorkflowConfiguration implements WorkflowConfigurationInterface
+{
+    /** @var string The current config version id */
+    private $configVersion;
+    
+    /** @var string The configuration as json encoded string */
+    private $configuration;
+
+    public function __construct(
+        string $configVersion = null,
+        string $configuration = null
+    ) {
+        $this->configVersion = $configVersion;
+        $this->configuration = $configuration;
+    }
+    
+    public function getConfigVersion(): string
+    {
+        return $this->configVersion;
+    }
+    
+    public function getConfiguration(): string
+    {
+        return $this->configuration;
+    }
+}

src/Struct/Workflow/WorkflowConfigurationInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Scn\EvalancheSoapStruct\Struct\Workflow;
+
+use Scn\EvalancheSoapStruct\Struct\StructInterface;
+
+/**
+ * Represents the result of a workflows getConfiguration call
+ */
+interface WorkflowConfigurationInterface extends StructInterface
+{
+    public function getConfigVersion(): string;
+
+    public function getConfiguration(): string;
+}

src/Struct/Workflow/WorkflowStateChangeResult.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Scn\EvalancheSoapStruct\Struct\Workflow;
+
+/**
+ * Represents a state change result
+ */
+class WorkflowStateChangeResult implements WorkflowStateChangeResultInterface
+{
+    /** @var bool|null */
+    private $stateChangeSuccessful;
+    
+    /** @var WorkflowStateChangeResultErrorInterface[]|null */
+    private $errorList;
+
+    /**
+     * @param WorkflowStateChangeResultErrorInterface[]|null $errorList
+     */
+    public function __construct(
+        bool $stateChangeSuccessful = null,
+        array $errorList = null
+    ) {
+        $this->stateChangeSuccessful = $stateChangeSuccessful;
+        $this->errorList = $errorList;
+    }
+    
+    public function getStateChangeResultSuccessful(): bool
+    {
+        return $this->stateChangeSuccessful;
+    }
+
+    /**
+     * @return WorkflowStateChangeResultErrorInterface[]
+     */
+    public function getErrorList(): array
+    {
+        return $this->errorList;
+    }
+}

src/Struct/Workflow/WorkflowStateChangeResultError.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Scn\EvalancheSoapStruct\Struct\Workflow;
+
+/**
+ * Represents an error item which can occur in state change requests
+ */
+class WorkflowStateChangeResultError implements WorkflowStateChangeResultErrorInterface
+{
+    /** @var string */
+    private $type;
+
+    /** @var string */
+    private $node;
+
+    /** @var string */
+    private $param;
+    
+    public function __construct(
+        string $type = null,
+        string $node = null,
+        string $param = null
+    ) {
+        $this->type = $type;
+        $this->node = $node;
+        $this->param = $param;
+    }
+    
+    public function getType(): string
+    {
+        return $this->type;
+    }
+    
+    public function getNode(): string
+    {
+        return $this->node;
+    }
+    
+    public function getParam(): string
+    {
+        return $this->param;
+    }
+}

src/Struct/Workflow/WorkflowStateChangeResultErrorInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Scn\EvalancheSoapStruct\Struct\Workflow;
+
+
+use Scn\EvalancheSoapStruct\Struct\StructInterface;
+
+/**
+ * Represents an error item which can occur in state change requests
+ */
+interface WorkflowStateChangeResultErrorInterface extends StructInterface
+{
+    public function getType(): string;
+
+    public function getNode(): string;
+
+    public function getParam(): string;
+}

src/Struct/Workflow/WorkflowStateChangeResultInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Scn\EvalancheSoapStruct\Struct\Workflow;
+
+use Scn\EvalancheSoapStruct\Struct\StructInterface;
+
+/**
+ * Represents a state change result
+ */
+interface WorkflowStateChangeResultInterface extends StructInterface
+{
+    public function getStateChangeResultSuccessful(): bool;
+
+    /**
+     * @return WorkflowStateChangeResultErrorInterface[]
+     */
+    public function getErrorList(): array;
+}

tests/Struct/Workflow/WorkflowConfigVersionTest.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Scn\EvalancheSoapStruct\Struct\Workflow;
+
+use Scn\EvalancheSoapStruct\StructTestCase;
+
+class WorkflowConfigVersionTest extends StructTestCase
+{
+    /** @var string */
+    private $configVersion = 'some-config-version';
+    
+    /** @var int */
+    private $createDate = 1234567;
+    
+    /** @var bool */
+    private $latest = true;
+    
+    /** @var WorkflowConfigVersion */
+    private $subject;
+
+    public function setUp(): void
+    {
+        $this->subject = new WorkflowConfigVersion(
+            $this->configVersion,
+            $this->createDate,
+            $this->latest
+        );
+    }
+    
+    public function testGetConfigVersionReturnsValue(): void
+    {
+        $this->assertSame(
+            $this->configVersion,
+            $this->subject->getConfigVersion()
+        );
+    }
+    
+    public function testGetCreateDateReturnsValue(): void
+    {
+        $this->assertSame(
+            $this->createDate,
+            $this->subject->getCreateDate()
+        );
+    }
+    
+    public function testGetLatestReturnsTrue(): void
+    {
+        $this->assertTrue(
+            $this->subject->getLatest()
+        );
+    }
+}

tests/Struct/Workflow/WorkflowConfigurationTest.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Scn\EvalancheSoapStruct\Struct\Workflow;
+
+use Scn\EvalancheSoapStruct\StructTestCase;
+
+class WorkflowConfigurationTest extends StructTestCase 
+{
+    private $configVersion = 'some-config-version';
+    
+    private $configuration = 'some-configuration';
+    
+    /** @var WorkflowConfiguration */
+    private $subject;
+    
+    public function setUp(): void
+    {
+        $this->subject = new WorkflowConfiguration(
+            $this->configVersion,
+            $this->configuration
+        );
+    }
+    
+    public function testGetConfigVersionReturnsValue(): void
+    {
+        $this->assertSame(
+            $this->configVersion,
+            $this->subject->getConfigVersion()
+        );
+    }
+
+    public function testGetConfigurationReturnsValus(): void
+    {
+        $this->assertSame(
+            $this->configuration,
+            $this->subject->getConfiguration()
+        );
+    }
+}