Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: [5.x] finalize class #2394

Merged
merged 2 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion UPGRADE-5.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,16 @@ Future proofing for potential future changes and keeping it consistent with `des
```diff
- public function supports(array $types): bool;
+ public function supports(array $types, array $context = []): bool;
```
```

## BC BREAK: `Nelmio\ApiDocBundle\Command` has been made final

## BC BREAK: Made classes implementing `Nelmio\ApiDocBundle\PropertyDescriber\PropertyDescriberInterface` final
`Nelmio\ApiDocBundle\PropertyDescriber\ArrayPropertyDescriber`
`Nelmio\ApiDocBundle\PropertyDescriber\BooleanPropertyDescriber`
`Nelmio\ApiDocBundle\PropertyDescriber\DateTimePropertyDescriber`
`Nelmio\ApiDocBundle\PropertyDescriber\CompoundPropertyDescriber`
`Nelmio\ApiDocBundle\PropertyDescriber\FloatPropertyDescriber`
`Nelmio\ApiDocBundle\PropertyDescriber\IntegerPropertyDescriber`
`Nelmio\ApiDocBundle\PropertyDescriber\ObjectPropertyDescriber`
`Nelmio\ApiDocBundle\PropertyDescriber\StringPropertyDescriber`
5 changes: 1 addition & 4 deletions src/Command/DumpCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
* @final
*/
class DumpCommand extends Command
final class DumpCommand extends Command
{
private RenderOpenApi $renderOpenApi;

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/ArrayPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
use OpenApi\Annotations as OA;
use Symfony\Component\PropertyInfo\Type;

class ArrayPropertyDescriber implements PropertyDescriberInterface, ModelRegistryAwareInterface, PropertyDescriberAwareInterface
final class ArrayPropertyDescriber implements PropertyDescriberInterface, ModelRegistryAwareInterface, PropertyDescriberAwareInterface
{
use ModelRegistryAwareTrait;
use PropertyDescriberAwareTrait;
Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/BooleanPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
use OpenApi\Annotations as OA;
use Symfony\Component\PropertyInfo\Type;

class BooleanPropertyDescriber implements PropertyDescriberInterface
final class BooleanPropertyDescriber implements PropertyDescriberInterface
{
/**
* @param array<string, mixed> $context Context options for describing the property
Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/CompoundPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
use OpenApi\Annotations as OA;
use OpenApi\Generator;

class CompoundPropertyDescriber implements PropertyDescriberInterface, ModelRegistryAwareInterface, PropertyDescriberAwareInterface
final class CompoundPropertyDescriber implements PropertyDescriberInterface, ModelRegistryAwareInterface, PropertyDescriberAwareInterface
{
use ModelRegistryAwareTrait;
use PropertyDescriberAwareTrait;
Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/DateTimePropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
use OpenApi\Annotations as OA;
use Symfony\Component\PropertyInfo\Type;

class DateTimePropertyDescriber implements PropertyDescriberInterface
final class DateTimePropertyDescriber implements PropertyDescriberInterface
{
/**
* @param array<string, mixed> $context Context options for describing the property
Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/FloatPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
use OpenApi\Annotations as OA;
use Symfony\Component\PropertyInfo\Type;

class FloatPropertyDescriber implements PropertyDescriberInterface
final class FloatPropertyDescriber implements PropertyDescriberInterface
{
/**
* @param array<string, mixed> $context Context options for describing the property
Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/IntegerPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
use OpenApi\Annotations as OA;
use Symfony\Component\PropertyInfo\Type;

class IntegerPropertyDescriber implements PropertyDescriberInterface
final class IntegerPropertyDescriber implements PropertyDescriberInterface
{
/**
* @param array<string, mixed> $context Context options for describing the property
Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/ObjectPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
use OpenApi\Annotations as OA;
use Symfony\Component\PropertyInfo\Type;

class ObjectPropertyDescriber implements PropertyDescriberInterface, ModelRegistryAwareInterface
final class ObjectPropertyDescriber implements PropertyDescriberInterface, ModelRegistryAwareInterface
{
use ModelRegistryAwareTrait;

Expand Down
2 changes: 1 addition & 1 deletion src/PropertyDescriber/StringPropertyDescriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
use OpenApi\Annotations as OA;
use Symfony\Component\PropertyInfo\Type;

class StringPropertyDescriber implements PropertyDescriberInterface
final class StringPropertyDescriber implements PropertyDescriberInterface
{
/**
* @param array<string, mixed> $context Context options for describing the property
Expand Down
Loading