[Refactor] More changes for the schema and schema provider

Author: lindyhopchris

src/Api/Api.php

@@ -193,7 +193,7 @@ public function getJobs()
     public function getContainer()
     {
         if (!$this->container) {
-            $this->container = $this->factory->createExtendedContainer($this->resolver);
+            $this->container = $this->factory->createContainer($this->resolver);
         }
 
         return $this->container;

src/Codec/Codec.php

@@ -18,8 +18,8 @@
 namespace CloudCreativity\LaravelJsonApi\Codec;
 
 use CloudCreativity\LaravelJsonApi\Contracts\ContainerInterface;
-use Neomerx\JsonApi\Contracts\Encoder\EncoderInterface;
-use Neomerx\JsonApi\Contracts\Factories\FactoryInterface;
+use CloudCreativity\LaravelJsonApi\Encoder\Encoder;
+use CloudCreativity\LaravelJsonApi\Factories\Factory;
 use Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;
 use Neomerx\JsonApi\Http\Headers\MediaType;
 
@@ -30,37 +30,36 @@
  */
 class Codec
 {
-
     /**
-     * @var FactoryInterface
+     * @var Factory
      */
-    private $factory;
+    private Factory $factory;
 
     /**
      * @var ContainerInterface
      */
-    private $container;
+    private ContainerInterface $container;
 
     /**
      * @var Encoding
      */
-    private $encoding;
+    private Encoding $encoding;
 
     /**
      * @var Decoding|null
      */
-    private $decoding;
+    private ?Decoding $decoding;
 
     /**
      * Codec constructor.
      *
-     * @param FactoryInterface $factory
+     * @param Factory $factory
      * @param ContainerInterface $container
      * @param Encoding $encoding
      * @param Decoding|null $decoding
      */
     public function __construct(
-        FactoryInterface $factory,
+        Factory $factory,
         ContainerInterface $container,
         Encoding $encoding,
         ?Decoding $decoding
@@ -92,15 +91,18 @@ public function willNotEncode(): bool
     }
 
     /**
-     * @return EncoderInterface
+     * @return Encoder
      */
-    public function getEncoder(): EncoderInterface
+    public function getEncoder(): Encoder
     {
         if ($this->willNotEncode()) {
             throw new \RuntimeException('Codec does not support encoding JSON API content.');
         }
 
-        $encoder = $this->factory->createEncoder($this->container);
+        $encoder = $this->factory->createExtendedEncoder(
+            $this->factory->createLaravelSchemaContainer($this->container)
+        );
+
         $options = $this->encoding->getOptions();
 
         if ($options) {

src/Container.php

@@ -25,10 +25,7 @@
 use CloudCreativity\LaravelJsonApi\Contracts\Schema\SchemaProviderInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Validation\ValidatorFactoryInterface;
 use CloudCreativity\LaravelJsonApi\Exceptions\RuntimeException;
-use CloudCreativity\LaravelJsonApi\Schema\Schema;
 use Illuminate\Contracts\Container\Container as IlluminateContainer;
-use Neomerx\JsonApi\Contracts\Factories\FactoryInterface;
-use Neomerx\JsonApi\Contracts\Schema\SchemaInterface;
 
 /**
  * Class Container
@@ -37,36 +34,35 @@
  */
 class Container implements ContainerInterface
 {
-
     /**
      * @var IlluminateContainer
      */
-    private $container;
+    private IlluminateContainer $container;
 
     /**
      * @var ResolverInterface
      */
-    private $resolver;
+    private ResolverInterface $resolver;
 
     /**
      * @var array
      */
-    private $createdSchemas = [];
+    private array $createdSchemas = [];
 
     /**
      * @var array
      */
-    private $createdAdapters = [];
+    private array $createdAdapters = [];
 
     /**
      * @var array
      */
-    private $createdValidators = [];
+    private array $createdValidators = [];
 
     /**
      * @var array
      */
-    private $createdAuthorizers = [];
+    private array $createdAuthorizers = [];
 
     /**
      * Container constructor.
@@ -83,15 +79,15 @@ public function __construct(IlluminateContainer $container, ResolverInterface $r
     /**
      * @inheritDoc
      */
-    public function getSchema($resourceObject): SchemaInterface
+    public function getSchema($resourceObject): SchemaProviderInterface
     {
         return $this->getSchemaByType(get_class($resourceObject));
     }
 
     /**
      * @inheritDoc
      */
-    public function hasSchema($resourceObject): bool
+    public function hasSchema(object $resourceObject): bool
     {
         $type = get_class($resourceObject);
 
@@ -104,9 +100,9 @@ public function hasSchema($resourceObject): bool
      * Get resource by object type.
      *
      * @param string $type
-     * @return SchemaInterface
+     * @return SchemaProviderInterface
      */
-    public function getSchemaByType(string $type): SchemaInterface
+    public function getSchemaByType(string $type): SchemaProviderInterface
     {
         $resourceType = $this->getResourceType($type);
 
@@ -117,9 +113,9 @@ public function getSchemaByType(string $type): SchemaInterface
      * Get resource by JSON:API type.
      *
      * @param string $resourceType
-     * @return SchemaInterface
+     * @return SchemaProviderInterface
      */
-    public function getSchemaByResourceType(string $resourceType): SchemaInterface
+    public function getSchemaByResourceType(string $resourceType): SchemaProviderInterface
     {
         if ($this->hasCreatedSchema($resourceType)) {
             return $this->getCreatedSchema($resourceType);
@@ -326,39 +322,32 @@ protected function hasCreatedSchema($resourceType)
 
     /**
      * @param string $resourceType
-     * @return SchemaInterface
+     * @return SchemaProviderInterface
      */
-    protected function getCreatedSchema($resourceType): SchemaInterface
+    protected function getCreatedSchema($resourceType): SchemaProviderInterface
     {
         return $this->createdSchemas[$resourceType];
     }
 
     /**
      * @param string $resourceType
-     * @param SchemaInterface $schema
+     * @param SchemaProviderInterface $schema
      * @return void
      */
-    protected function setCreatedSchema($resourceType, SchemaInterface $schema): void
+    protected function setCreatedSchema($resourceType, SchemaProviderInterface $schema): void
     {
         $this->createdSchemas[$resourceType] = $schema;
     }
 
     /**
      * @param string $className
-     * @return SchemaInterface
+     * @return SchemaProviderInterface
      */
-    protected function createSchemaFromClassName(string $className): SchemaInterface
+    protected function createSchemaFromClassName(string $className): SchemaProviderInterface
     {
         $schema = $this->create($className);
 
-        if ($schema instanceof SchemaProviderInterface) {
-            return new Schema(
-                $this->container->make(FactoryInterface::class),
-                $schema,
-            );
-        }
-
-        if (!$schema instanceof SchemaInterface) {
+        if (!$schema instanceof SchemaProviderInterface) {
             throw new RuntimeException("Class [$className] is not a schema provider.");
         }
 

src/Contracts/ContainerInterface.php

@@ -20,32 +20,47 @@
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\ResourceAdapterInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Auth\AuthorizerInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Http\ContentNegotiatorInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Schema\SchemaProviderInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Validation\ValidatorFactoryInterface;
-use Neomerx\JsonApi\Contracts\Schema\SchemaContainerInterface;
-use Neomerx\JsonApi\Contracts\Schema\SchemaInterface;
 
 /**
  * Interface ContainerInterface
  *
  * @package CloudCreativity\LaravelJsonApi
  */
-interface ContainerInterface extends SchemaContainerInterface
+interface ContainerInterface
 {
+    /**
+     * Get schema provider for resource object.
+     *
+     * @param object $resourceObject
+     * @return SchemaProviderInterface
+     */
+    public function getSchema(object $resourceObject): SchemaProviderInterface;
+
+    /**
+     * If container has a Schema for a given input.
+     *
+     * @param object $resourceObject
+     * @return bool
+     */
+    public function hasSchema(object $resourceObject): bool;
+
     /**
      * Get schema provider by resource type.
      *
      * @param string $type
-     * @return SchemaInterface
+     * @return SchemaProviderInterface
      */
-    public function getSchemaByType(string $type): SchemaInterface;
+    public function getSchemaByType(string $type): SchemaProviderInterface;
 
     /**
      * Get schema provider by JSON:API type.
      *
      * @param string $resourceType
-     * @return SchemaInterface
+     * @return SchemaProviderInterface
      */
-    public function getSchemaByResourceType(string $resourceType): SchemaInterface;
+    public function getSchemaByResourceType(string $resourceType): SchemaProviderInterface;
 
     /**
      * Get a resource adapter for a domain record.

src/Contracts/Schema/SchemaProviderInterface.php

@@ -20,6 +20,7 @@
 namespace CloudCreativity\LaravelJsonApi\Contracts\Schema;
 
 use Neomerx\JsonApi\Contracts\Schema\ContextInterface;
+use Neomerx\JsonApi\Contracts\Schema\LinkInterface;
 
 interface SchemaProviderInterface
 {
@@ -78,4 +79,30 @@ public function getRelationships(object $resource, bool $isPrimary, array $inclu
      * @return string
      */
     public function getSelfSubUrl(object $resource = null): string;
+
+    /**
+     * Get the resource self sub link.
+     *
+     * @param object $resource
+     * @return LinkInterface
+     */
+    public function getSelfSubLink(object $resource): LinkInterface;
+
+    /**
+     * Get the relationship self link.
+     *
+     * @param object $resource
+     * @param string $field
+     * @return LinkInterface
+     */
+    public function getRelationshipSelfLink(object $resource, string $field): LinkInterface;
+
+    /**
+     * Get the relationship related link.
+     *
+     * @param object $resource
+     * @param string $field
+     * @return LinkInterface
+     */
+    public function getRelationshipRelatedLink(object $resource, string $field): LinkInterface;
 }