Skip to content

Commit 861829a

Browse files
docs: describe the types listed by Symfony's debug:autowiring command
1 parent b10e80f commit 861829a

11 files changed

Lines changed: 31 additions & 1 deletion

File tree

‎src/Doctrine/Common/State/PersistProcessor.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@
2222
use Doctrine\Persistence\ManagerRegistry;
2323
use Doctrine\Persistence\ObjectManager as DoctrineObjectManager;
2424

25+
/**
26+
* Persists and flushes the data of write operations with Doctrine.
27+
*/
2528
final class PersistProcessor implements ProcessorInterface
2629
{
2730
use ClassInfoTrait;

‎src/Doctrine/Common/State/RemoveProcessor.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
use Doctrine\Persistence\ManagerRegistry;
2020
use Doctrine\Persistence\ObjectManager as DoctrineObjectManager;
2121

22+
/**
23+
* Removes the data of delete operations with Doctrine.
24+
*/
2225
final class RemoveProcessor implements ProcessorInterface
2326
{
2427
use ClassInfoTrait;

‎src/Doctrine/Orm/Filter/UlidFilter.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
use ApiPlatform\Metadata\QueryParameter;
1818
use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
1919

20+
/**
21+
* Filters a collection by ULID.
22+
*/
2023
final class UlidFilter extends AbstractUuidFilter
2124
{
2225
private const ULID_SCHEMA = [

‎src/Doctrine/Orm/Filter/UuidBinaryFilter.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818
use Doctrine\DBAL\ArrayParameterType;
1919
use Doctrine\DBAL\ParameterType;
2020

21+
/**
22+
* Filters a collection by UUID, for UUIDs stored in binary columns.
23+
*/
2124
final class UuidBinaryFilter extends AbstractUuidFilter
2225
{
2326
public function __construct()

‎src/Doctrine/Orm/Filter/UuidFilter.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace ApiPlatform\Doctrine\Orm\Filter;
1515

16+
/**
17+
* Filters a collection by UUID.
18+
*/
1619
final class UuidFilter extends AbstractUuidFilter
1720
{
1821
}

‎src/Metadata/Operation/Factory/OperationMetadataFactoryInterface.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515

1616
use ApiPlatform\Metadata\Operation;
1717

18+
/**
19+
* Finds the operation that matches a URI template or an operation name.
20+
*/
1821
interface OperationMetadataFactoryInterface
1922
{
2023
public function create(string $uriTemplate, array $context = []): ?Operation;

‎src/Metadata/ResourceAccessCheckerInterface.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
namespace ApiPlatform\Metadata;
1515

16+
/**
17+
* Checks if the current user can access a resource, with a security expression.
18+
*/
1619
interface ResourceAccessCheckerInterface
1720
{
1821
/**

‎src/Metadata/UrlGeneratorInterface.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
use Symfony\Component\Routing\Exception\RouteNotFoundException;
1919

2020
/**
21-
* UrlGeneratorInterface is the interface that all URL generator classes must implement.
21+
* Generates URLs and paths from route names and parameters.
2222
*
2323
* This interface has been imported and adapted from the Symfony project.
2424
*

‎src/OpenApi/Factory/OpenApiFactoryInterface.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515

1616
use ApiPlatform\OpenApi\OpenApi;
1717

18+
/**
19+
* Creates the OpenAPI document of the API.
20+
*/
1821
interface OpenApiFactoryInterface
1922
{
2023
/**

‎src/OpenApi/Options.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515

1616
use ApiPlatform\OpenApi\Model\Tag;
1717

18+
/**
19+
* Holds the options of the OpenAPI document, such as its title, version and authentication schemes.
20+
*/
1821
final readonly class Options
1922
{
2023
/**

0 commit comments

Comments
 (0)