Initial engine design

Author: veewee

.gitignore

@@ -0,0 +1 @@
+/vendor/

composer.json

@@ -0,0 +1,20 @@
+{
+    "name": "php-soap/engine",
+    "description": "SOAP engine design",
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Soap\\Engine\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Toon Verwerft",
+            "email": "toonverwerft@gmail.com"
+        }
+    ],
+    "require": {
+        "php": "^7.4 || ^8.0"
+    }
+}

src/Decoder.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Soap\Engine;
+
+use Soap\Engine\HttpBinding\SoapResponse;
+
+interface Decoder
+{
+    /**
+     * @return mixed
+     */
+    public function decode(string $method, SoapResponse $response);
+}

src/Driver.php

@@ -0,0 +1,11 @@
+<?php
+
+declare( strict_types=1 );
+
+namespace Soap\Engine;
+
+use Soap\Engine\Metadata\MetadataProvider;
+
+interface Driver extends Encoder, Decoder, MetadataProvider
+{
+}

src/Encoder.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Soap\Engine;
+
+use Soap\Engine\HttpBinding\SoapRequest;
+
+interface Encoder
+{
+    public function encode(string $method, array $arguments): SoapRequest;
+}

src/Engine.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Soap\Engine;
+
+use Soap\Engine\Metadata\MetadataProvider;
+
+interface Engine extends MetadataProvider
+{
+    /**
+     * @return mixed
+     */
+    public function request(string $method, array $arguments);
+}

src/Exception/MetadataException.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Soap\Engine\Exception;
+
+class MetadataException extends RuntimeException
+{
+    public static function typeNotFound(string $name): self
+    {
+        return new self('No SOAP type found with name '.$name.'.');
+    }
+
+    public static function methodNotFound(string $name): self
+    {
+        return new self('No SOAP method found with name '.$name.'.');
+    }
+}

src/Exception/RuntimeException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Soap\Engine\Exception;
+
+use Throwable;
+
+abstract class RuntimeException extends \RuntimeException
+{
+    protected function __construct($message = "", $code = 0, Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+    }
+}

src/HttpBinding/SoapRequest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Soap\Engine\HttpBinding;
+
+class SoapRequest
+{
+    private string $request;
+    private string $location;
+    private string $action;
+    private int $version;
+    private int $oneWay;
+
+    public function __construct(string $request, string $location, string $action, int $version, int $oneWay = 0)
+    {
+        $this->request = $request;
+        $this->location = $location;
+        $this->action = $action;
+        $this->version = $version;
+        $this->oneWay = $oneWay;
+    }
+
+    public function getRequest(): string
+    {
+        return $this->request;
+    }
+
+    public function getLocation(): string
+    {
+        return $this->location;
+    }
+
+    public function getAction(): string
+    {
+        return $this->action;
+    }
+
+    public function getVersion(): int
+    {
+        return $this->version;
+    }
+
+    public function isSOAP11(): bool
+    {
+        return $this->getVersion() === SOAP_1_1;
+    }
+
+    public function isSOAP12(): bool
+    {
+        return $this->getVersion() === SOAP_1_2;
+    }
+
+    public function getOneWay(): int
+    {
+        return $this->oneWay;
+    }
+}

src/HttpBinding/SoapResponse.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Soap\Engine\HttpBinding;
+
+class SoapResponse
+{
+    private string $payload;
+
+    public function __construct(string $payload)
+    {
+        $this->payload = $payload;
+    }
+
+    public function getPayload(): string
+    {
+        return $this->payload;
+    }
+}

src/Metadata/Collection/MethodCollection.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Soap\Engine\Metadata\Collection;
+
+use ArrayIterator;
+use Countable;
+use IteratorAggregate;
+use Soap\Engine\Exception\MetadataException;
+use Soap\Engine\Metadata\Model\Method;
+
+final class MethodCollection implements IteratorAggregate, Countable
+{
+    /**
+     * @var Method[]
+     */
+    private array $methods;
+
+    public function __construct(Method ...$methods)
+    {
+        $this->methods = $methods;
+    }
+
+    public function getIterator(): ArrayIterator
+    {
+        return new ArrayIterator($this->methods);
+    }
+
+    public function count(): int
+    {
+        return count($this->methods);
+    }
+
+    public function map(callable  $callback): array
+    {
+        return array_map($callback, $this->methods);
+    }
+
+    public function fetchByName(string $name): Method
+    {
+        foreach ($this->methods as $method) {
+            if ($name === $method->getName()) {
+                return $method;
+            }
+        }
+
+        throw MetadataException::methodNotFound($name);
+    }
+}

src/Metadata/Collection/ParameterCollection.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Soap\Engine\Metadata\Collection;
+
+use ArrayIterator;
+use Countable;
+use IteratorAggregate;
+use Soap\Engine\Metadata\Model\Parameter;
+
+final class ParameterCollection implements IteratorAggregate, Countable
+{
+    /**
+     * @var Parameter[]
+     */
+    private array $parameters;
+
+    public function __construct(Parameter ...$parameters)
+    {
+        $this->parameters = $parameters;
+    }
+
+    /**
+     * @return ArrayIterator|Parameter[]
+     */
+    public function getIterator(): ArrayIterator
+    {
+        return new ArrayIterator($this->parameters);
+    }
+
+    public function count(): int
+    {
+        return count($this->parameters);
+    }
+
+    public function map(callable  $callback): array
+    {
+        return array_map($callback, $this->parameters);
+    }
+}

src/Metadata/Collection/PropertyCollection.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Soap\Engine\Metadata\Collection;
+
+use ArrayIterator;
+use Countable;
+use IteratorAggregate;
+use Soap\Engine\Metadata\Model\Property;
+
+final class PropertyCollection implements IteratorAggregate, Countable
+{
+    /**
+     * @var Property[]
+     */
+    private array $properties;
+
+    public function __construct(Property ...$properties)
+    {
+        $this->properties = $properties;
+    }
+
+    /**
+     * @return ArrayIterator|Property[]
+     */
+    public function getIterator(): ArrayIterator
+    {
+        return new ArrayIterator($this->properties);
+    }
+
+    public function count(): int
+    {
+        return count($this->properties);
+    }
+
+    public function map(callable  $callback): array
+    {
+        return array_map($callback, $this->properties);
+    }
+}

src/Metadata/Collection/TypeCollection.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Soap\Engine\Metadata\Collection;
+
+use ArrayIterator;
+use Countable;
+use IteratorAggregate;
+use Soap\Engine\Exception\MetadataException;
+use Soap\Engine\Metadata\Model\Type;
+
+final class TypeCollection implements IteratorAggregate, Countable
+{
+    /**
+     * @var Type[]
+     */
+    private array $types;
+
+    public function __construct(Type ...$types)
+    {
+        $this->types = $types;
+    }
+
+    /**
+     * @return ArrayIterator|Type[]
+     */
+    public function getIterator(): ArrayIterator
+    {
+        return new ArrayIterator($this->types);
+    }
+
+    public function count(): int
+    {
+        return count($this->types);
+    }
+
+    public function map(callable $callback): array
+    {
+        return array_map($callback, $this->types);
+    }
+
+    public function filter(callable $filter): self
+    {
+        return new self(...array_filter(
+            $this->types,
+            $filter
+        ));
+    }
+
+    public function reduce(callable $reducer, $initial = null)
+    {
+        return array_reduce(
+            $this->types,
+            $reducer,
+            $initial
+        );
+    }
+
+    public function fetchFirstByName(string $name): Type
+    {
+        foreach ($this->types as $type) {
+            if ($name === $type->getName()) {
+                return $type;
+            }
+        }
+
+        throw MetadataException::typeNotFound($name);
+    }
+}