Merge remote-tracking branch 'origin/4.1' into revamp-admin-docs

Author: slax57

core/filters.md

@@ -78,27 +78,14 @@ services:
       - name: 'api_platform.parameter_provider'
         key: 'ApiPlatform\Tests\Fixtures\TestBundle\Parameter\CustomGroupParameterProvider'
 ```
-or if you are using Laravel tag your provider with:
 
-```php
-<?php
+With Laravel the services are automatically tagged.
 
-namespace App\Providers;
+### Declare a filter with Laravel
 
-use ApiPlatform\State\Provider\ParameterProvider;
-use ApiPlatform\Tests\Fixtures\TestBundle\Parameter\CustomGroupParameterProvider;
-use Illuminate\Support\ServiceProvider;
+Filters are classes implementing our `ApiPlatform\Laravel\Eloquent\Filter\FilterInterface`, use [our code](https://github.com/api-platform/core/tree/main/src/Laravel/Eloquent/Filter) as examples. Filters are automatically registered and tagged by our `ServiceProvider`.
 
-class AppServiceProvider extends ServiceProvider
-{
-    public function register(): void
-    {
-        $this->app->tag([CustomGroupParameterProvider::class], ParameterProvider::class);
-    }
-}
-```
-
-### Call a filter with Symfony
+### Declare a filter with Symfony
 
 A Parameter can also call a filter and works on filters that impact the data persistence layer (Doctrine ORM, ODM and Eloquent filters are supported). Let's assume, that we have an Order filter declared:
 
@@ -132,51 +119,6 @@ class Offer {
 }
 ```
 
-### Call a filter with Laravel
-
-A Parameter can also call a filter and works on filters that impact the data persistence layer (Doctrine ORM, ODM and Eloquent filters are supported). Let's assume, that we have an Order filter declared:
-
-```php
-<?php
-
-namespace App\Providers;
-
-use ApiPlatform\Laravel\Eloquent\Filter\OrderFilter;
-use ApiPlatform\Metadata\ApiFilter;
-use Illuminate\Support\ServiceProvider;
-
-class AppServiceProvider extends ServiceProvider
-{
-    $public function register(): void
-    {
-        $this->app->singleton(OrderFilter::class, function ($app) {
-            return new OrderFilter(['id' => null, 'name' => null], 'order');
-        });
-
-        $this->app->tag([OrderFilter::class], ApiFilter::class);
-    }
-}
-```
-
-We can use this filter specifying we want a query parameter with the `:property` placeholder:
-
-```php
-namespace App\ApiResource;
-
-use ApiPlatform\Metadata\QueryParameter;
-
-#[GetCollection(
-    uriTemplate: 'orders',
-    parameters: [
-        'order[:property]' => new QueryParameter(filter: 'offer.order_filter'),
-    ]
-)
-class Offer {
-    public string $id;
-    public string $name;
-}
-```
-
 ### Header parameters
 
 The `HeaderParameter` attribute allows to create a parameter that's using HTTP Headers instead of query parameters:

core/identifiers.md

@@ -5,6 +5,9 @@ To help with your development experience, we introduced an identifier normalizat
 
 ## Custom Identifier Normalizer
 
+> [!WARNING]
+> This feature is not yet available with Laravel, if you need it please open a Feature Request issue!
+
 > In the following chapter, we're assuming that `App\Uuid` is a project-owned class that manages a time-based UUID.
 
 Let's say you have the following class, which is identified by a `UUID` type. In this example, `UUID` is not a simple string but an object with many attributes.
@@ -13,7 +16,7 @@ Let's say you have the following class, which is identified by a `UUID` type. In
 
 ```php
 <?php
-// api/src/ApiResource/Person.php with Symfony or app/ApiResource/Person.php with Laravel
+// api/src/ApiResource/Person.php with Symfony
 namespace App\ApiResource;
 
 use ApiPlatform\Metadata\ApiProperty;
@@ -62,7 +65,7 @@ Let's create a `Provider` for the `Person` resource:
 
 ```php
 <?php
-// api/src/State/PersonProvider.php with Symfony or app/State/PersonProvider.php with Laravel
+// api/src/State/PersonProvider.php with Symfony
 
 namespace App\State;
 
@@ -91,7 +94,7 @@ This case is covered by an URI variable transformer:
 
 ```php
 <?php
-// api/src/Identifier/UuidUriVariableTransformer.php with Symfony or app/Identifier/UuidUriVariableTransformer.php with Laravel 
+// api/src/Identifier/UuidUriVariableTransformer.php with Symfony
 namespace App\Identifier;
 
 use ApiPlatform\Api\UriVariableTransformerInterface;
@@ -166,28 +169,6 @@ services:
 
 Your `PersonProvider` will now work as expected!
 
-### Tag the Service using Laravel
-
-```php
-<?php
-
-namespace App\Providers;
-
-use App\Identifier\UuidUriVariableTransformer;
-use ApiPlatform\Metadata\UriVariableTransformerInterface;
-use Illuminate\Support\ServiceProvider;
-
-class AppServiceProvider extends ServiceProvider
-{
-    public function register(): void
-    {
-        $this->app->tag([UuidUriVariableTransformer::class], UriVariableTransformerInterface::class);
-    }
-}
-```
-
-Your `PersonProvider` will now work as expected!
-
 ## Changing Identifier in a Doctrine Entity
 
 If your resource is also a Doctrine entity and you want to use another identifier other than the Doctrine one, you have to unmark it:

core/openapi.md

@@ -15,9 +15,6 @@ API documentation in a user friendly way.
 
 ## Using the OpenAPI Command
 
-> [!WARNING]
-> These commands are not yet available with Laravel, you're welcome to contribute [on GitHub](https://github.com/api-platform/core)
-
 You can also dump an OpenAPI specification for your API.
 
 OpenAPI, JSON format:
@@ -26,7 +23,7 @@ OpenAPI, JSON format:
 bin/console api:openapi:export
 ```
 
-OpenAPI, YAML format:
+OpenAPI, YAML format (you need to install `symfony/yaml` for this to work):
 
 ```console
 bin/console api:openapi:export --yaml
@@ -64,7 +61,7 @@ class Book {}
 
 Then, either use the query parameter for the web version such as `/docs?filter_tags[]=customer` or through the command line:
 
-```bash
+```console
 bin/console api:openapi:export --filter-tags=customer
 ```
 

core/state-processors.md

@@ -264,32 +264,6 @@ final class UserProcessor implements ProcessorInterface
 }
 ```
 
-Don't forget to tag the service with the `PersistProcessor` and the `RemoveProcessor` state classes.
-
-```php
-<?php
-
-namespace App\Providers;
-
-use ApiPlatform\Laravel\Eloquent\State\PersistProcessor;
-use ApiPlatform\Laravel\Eloquent\State\RemoveProcessor;
-use App\State\UserProcessor;
-use Illuminate\Support\ServiceProvider;
-
-class AppServiceProvider extends ServiceProvider
-{
-    public function register(): void
-    {
-        $this->app->tag([UserProcessor::class], [PersistProcessor::class, RemoveProcessor::class,]);
-    }
-
-    public function boot(): void
-    {
-    }
-}
-```
-If you're using Laravel MongoDB ODM instead of Eloquent ORM, make sure you're using the right services.
-
 Finally, configure that you want to use this processor on the User resource:
 
 ```php

core/state-providers.md

@@ -309,42 +309,18 @@ class Book {}
 
 #### Laravel State Provider mechanism
 
-First, don't forget to tag the service with the `ProviderInterface`
+Declare a class that implements our `ProviderInterface`
 
 ```php
 <?php
-
-namespace App\Providers;
-
-use ApiPlatform\State\ProviderInterface;
-use App\State\BookStateProvider;
-use Illuminate\Support\ServiceProvider;
-
-class AppServiceProvider extends ServiceProvider
-{
-    public function register(): void
-    {
-        $this->app->tag([BookRepresentationProvider::class], ProviderInterface::class);
-    }
-
-    public function boot(): void
-    {
-    }
-}
-```
-
-After that, you can inject the `ProviderInterface`
-```php
-<?php
-// api/src/State/BlogPostProvider.php
+// api/app/State/BlogPostProvider.php
 
 namespace App\State;
 
 use App\Dto\AnotherRepresentation;
 use App\Models\Book;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ProviderInterface;
-use Symfony\Component\DependencyInjection\Attribute\Autowire;
 
 /**
  * @implements ProviderInterface<AnotherRepresentation>

laravel/index.md

@@ -235,31 +235,6 @@ final class BookProvider implements ProviderInterface
 }
 ```
 
-Register the state provider:
-
-```php
-<?php
-
-namespace App\Providers;
-
-use App\State\BookProvider;
-use ApiPlatform\State\ProviderInterface;
-use Illuminate\Contracts\Foundation\Application;
-use Illuminate\Support\ServiceProvider;
-
-class ApiServiceProvider extends ServiceProvider
-{
-    public function register(): void
-    {
-        $this->app->singleton(BookProvider::class, function (Application $app) {
-            return new BookProvider();
-        });
-
-        $this->app->tag([BookProvider::class], ProviderInterface::class);
-    }
-}
-```
-
 Apply the provider to your operation:
 
 ```php