chore(elasticsearch): api-platform/elasticsearch (api-platform#5526)

Author: Zowac

.github/workflows/ci.yml

@@ -192,6 +192,7 @@ jobs:
           - JsonSchema
           - OpenApi
           - Metadata
+          - Elasticsearch
       fail-fast: false
     steps:
       - name: Checkout

src/Api/FilterLocatorTrait.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Api;
 
 use ApiPlatform\Exception\InvalidArgumentException;
+use ApiPlatform\Metadata\FilterInterface;
 use Psr\Container\ContainerInterface;
 
 /**

src/Api/IriConverterInterface.php

@@ -13,33 +13,6 @@
 
 namespace ApiPlatform\Api;
 
-use ApiPlatform\Exception\InvalidArgumentException;
-use ApiPlatform\Exception\ItemNotFoundException;
-use ApiPlatform\Exception\RuntimeException;
-use ApiPlatform\Metadata\Operation;
-
-/**
- * Converts item and resources to IRI and vice versa.
- *
- * @author Kévin Dunglas <[email protected]>
- */
-interface IriConverterInterface
+interface IriConverterInterface extends \ApiPlatform\Metadata\IriConverterInterface
 {
-    /**
-     * Retrieves an item from its IRI.
-     *
-     * @throws InvalidArgumentException
-     * @throws ItemNotFoundException
-     */
-    public function getResourceFromIri(string $iri, array $context = [], Operation $operation = null): object;
-
-    /**
-     * Gets the IRI associated with the given item.
-     *
-     * @param object|class-string $resource
-     *
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     */
-    public function getIriFromResource(object|string $resource, int $referenceType = UrlGeneratorInterface::ABS_PATH, Operation $operation = null, array $context = []): ?string;
 }

src/Api/UrlGeneratorInterface.php

@@ -13,72 +13,6 @@
 
 namespace ApiPlatform\Api;
 
-use Symfony\Component\Routing\Exception\InvalidParameterException;
-use Symfony\Component\Routing\Exception\MissingMandatoryParametersException;
-use Symfony\Component\Routing\Exception\RouteNotFoundException;
-
-/**
- * UrlGeneratorInterface is the interface that all URL generator classes must implement.
- *
- * This interface has been imported and adapted from the Symfony project.
- *
- * The constants in this interface define the different types of resource references that
- * are declared in RFC 3986: http://tools.ietf.org/html/rfc3986
- * We are using the term "URL" instead of "URI" as this is more common in web applications
- * and we do not need to distinguish them as the difference is mostly semantical and
- * less technical. Generating URIs, i.e. representation-independent resource identifiers,
- * is also possible.
- *
- * @author Fabien Potencier <[email protected]>
- * @author Tobias Schultze <http://tobion.de>
- * @copyright Fabien Potencier
- */
-interface UrlGeneratorInterface
+interface UrlGeneratorInterface extends \ApiPlatform\Metadata\UrlGeneratorInterface
 {
-    /**
-     * Generates an absolute URL, e.g. "http://example.com/dir/file".
-     */
-    public const ABS_URL = 0;
-
-    /**
-     * Generates an absolute path, e.g. "/dir/file".
-     */
-    public const ABS_PATH = 1;
-
-    /**
-     * Generates a relative path based on the current request path, e.g. "../parent-file".
-     *
-     * @see UrlGenerator::getRelativePath()
-     */
-    public const REL_PATH = 2;
-
-    /**
-     * Generates a network path, e.g. "//example.com/dir/file".
-     * Such reference reuses the current scheme but specifies the host.
-     */
-    public const NET_PATH = 3;
-
-    /**
-     * Generates a URL or path for a specific route based on the given parameters.
-     *
-     * Parameters that reference placeholders in the route pattern will substitute them in the
-     * path or host. Extra params are added as query string to the URL.
-     *
-     * When the passed reference type cannot be generated for the route because it requires a different
-     * host or scheme than the current one, the method will return a more comprehensive reference
-     * that includes the required params. For example, when you call this method with $referenceType = ABSOLUTE_PATH
-     * but the route requires the https scheme whereas the current scheme is http, it will instead return an
-     * ABSOLUTE_URL with the https scheme and the current host. This makes sure the generated URL matches
-     * the route in any case.
-     *
-     * If there is no route with the given name, the generator must throw the RouteNotFoundException.
-     *
-     * The special parameter _fragment will be used as the document fragment suffixed to the final URL.
-     *
-     * @throws RouteNotFoundException              If the named route doesn't exist
-     * @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route
-     * @throws InvalidParameterException           When a parameter value for a placeholder is not correct because
-     *                                             it does not match the requirement
-     */
-    public function generate(string $name, array $parameters = [], int $referenceType = self::ABS_PATH): string;
 }

src/Elasticsearch/.gitignore

@@ -0,0 +1,3 @@
+/composer.lock
+/vendor
+/.phpunit.result.cache

src/Elasticsearch/Exception/ExceptionInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Elasticsearch\Exception;
+
+/**
+ * Base exception interface.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+interface ExceptionInterface extends \Throwable
+{
+}

src/Elasticsearch/Exception/IndexNotFoundException.php

@@ -13,8 +13,6 @@
 
 namespace ApiPlatform\Elasticsearch\Exception;
 
-use ApiPlatform\Exception\ExceptionInterface;
-
 /**
  * Index not found exception.
  *

src/Elasticsearch/Exception/NonUniqueIdentifierException.php

@@ -13,8 +13,6 @@
 
 namespace ApiPlatform\Elasticsearch\Exception;
 
-use ApiPlatform\Exception\ExceptionInterface;
-
 /**
  * Non unique identifier exception.
  *

src/Elasticsearch/Extension/SortExtension.php

@@ -13,11 +13,11 @@
 
 namespace ApiPlatform\Elasticsearch\Extension;
 
-use ApiPlatform\Api\ResourceClassResolverInterface;
 use ApiPlatform\Elasticsearch\Util\FieldDatatypeTrait;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
+use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
 /**

src/Elasticsearch/Filter/AbstractFilter.php

@@ -13,12 +13,12 @@
 
 namespace ApiPlatform\Elasticsearch\Filter;
 
-use ApiPlatform\Api\ResourceClassResolverInterface;
 use ApiPlatform\Elasticsearch\Util\FieldDatatypeTrait;
-use ApiPlatform\Exception\PropertyNotFoundException;
-use ApiPlatform\Exception\ResourceClassNotFoundException;
+use ApiPlatform\Metadata\Exception\PropertyNotFoundException;
+use ApiPlatform\Metadata\Exception\ResourceClassNotFoundException;
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
+use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use Symfony\Component\PropertyInfo\Type;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;