diff --git a/src/Metadata/Operation/Factory/OperationMetadataFactoryInterface.php b/src/Metadata/Operation/Factory/OperationMetadataFactoryInterface.php index b5a49c048bd..1689b815435 100644 --- a/src/Metadata/Operation/Factory/OperationMetadataFactoryInterface.php +++ b/src/Metadata/Operation/Factory/OperationMetadataFactoryInterface.php @@ -15,6 +15,9 @@ use ApiPlatform\Metadata\Operation; +/** + * Finds the operation that matches a URI template or an operation name. + */ interface OperationMetadataFactoryInterface { public function create(string $uriTemplate, array $context = []): ?Operation; diff --git a/src/Metadata/ResourceAccessCheckerInterface.php b/src/Metadata/ResourceAccessCheckerInterface.php index 29bdd007b9f..a004fd54a76 100644 --- a/src/Metadata/ResourceAccessCheckerInterface.php +++ b/src/Metadata/ResourceAccessCheckerInterface.php @@ -13,6 +13,9 @@ namespace ApiPlatform\Metadata; +/** + * Checks if the current user can access a resource, with a security expression. + */ interface ResourceAccessCheckerInterface { /** diff --git a/src/Metadata/UrlGeneratorInterface.php b/src/Metadata/UrlGeneratorInterface.php index 5df27ef16e4..b6e446a12ca 100644 --- a/src/Metadata/UrlGeneratorInterface.php +++ b/src/Metadata/UrlGeneratorInterface.php @@ -18,7 +18,7 @@ use Symfony\Component\Routing\Exception\RouteNotFoundException; /** - * UrlGeneratorInterface is the interface that all URL generator classes must implement. + * Generates URLs and paths from route names and parameters. * * This interface has been imported and adapted from the Symfony project. * diff --git a/src/OpenApi/Factory/OpenApiFactoryInterface.php b/src/OpenApi/Factory/OpenApiFactoryInterface.php index 5e125ee4917..36d46deb953 100644 --- a/src/OpenApi/Factory/OpenApiFactoryInterface.php +++ b/src/OpenApi/Factory/OpenApiFactoryInterface.php @@ -15,6 +15,9 @@ use ApiPlatform\OpenApi\OpenApi; +/** + * Creates the OpenAPI document of the API. + */ interface OpenApiFactoryInterface { /** diff --git a/src/OpenApi/Options.php b/src/OpenApi/Options.php index a22904bd15c..ace1bc36eba 100644 --- a/src/OpenApi/Options.php +++ b/src/OpenApi/Options.php @@ -15,6 +15,9 @@ use ApiPlatform\OpenApi\Model\Tag; +/** + * Holds the options of the OpenAPI document, such as its title, version and authentication schemes. + */ final readonly class Options { /** diff --git a/src/State/Pagination/PaginationOptions.php b/src/State/Pagination/PaginationOptions.php index 24b226f10bd..766f04c3c22 100644 --- a/src/State/Pagination/PaginationOptions.php +++ b/src/State/Pagination/PaginationOptions.php @@ -13,6 +13,9 @@ namespace ApiPlatform\State\Pagination; +/** + * Holds the pagination options, such as the page size and the names of the query parameters. + */ final class PaginationOptions { public function __construct(private readonly bool $paginationEnabled = true, private readonly string $paginationPageParameterName = 'page', private readonly bool $clientItemsPerPage = false, private readonly string $itemsPerPageParameterName = 'itemsPerPage', private readonly bool $paginationClientEnabled = false, private readonly string $paginationClientEnabledParameterName = 'pagination', private readonly int $itemsPerPage = 30, private readonly ?int $maximumItemsPerPage = null, private readonly bool $partialPaginationEnabled = false, private readonly bool $clientPartialPaginationEnabled = false, private readonly string $partialPaginationParameterName = 'partial')