mirror of
https://github.com/Sylius/Sylius.git
synced 2026-07-05 20:57:12 +00:00
[API] Minor clean up of UPGRADE files (#16844)
| Q | A |-----------------|----- | Branch? | api-platform-3 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no<!-- don't forget to update the UPGRADE-*.md file --> | Related tickets | | License | MIT <!-- - Bug fixes must be submitted against the 1.13 branch - Features and deprecations must be submitted against the 1.14 branch - Features, removing deprecations and BC breaks must be submitted against the 2.0 branch - Make sure that the correct base branch is set To be sure you are not breaking any Backward Compatibilities, check the documentation: https://docs.sylius.com/en/latest/book/organization/backward-compatibility-promise.html -->
This commit is contained in:
Rafał Jaskulski
GitHub
commit
bddbfd8a7d
3 changed files with 40 additions and 42 deletions
|
|
@ -1,3 +0,0 @@
|
|||
# UPGRADE FROM `v1.13.X` TO `v1.14.0`
|
||||
|
||||
1. The class `Sylius\Bundle\CoreBundle\Twig\StateMachineExtension` has been deprecated and will be removed in Sylius 2.0. Use `Sylius\Abstraction\StateMachine\Twig\StateMachineExtension` instead.
|
||||
|
|
@ -1,12 +1,4 @@
|
|||
# UPGRADE FROM `1.13` TO `2.0`
|
||||
|
||||
1. Non-prefix serialization groups in Sylius resources have been removed.
|
||||
If you have extended any of them, you must prefix them with `sylius:`, for example:
|
||||
|
||||
```diff
|
||||
- #[Groups(['admin:product:index'])]
|
||||
+ #[Groups(['sylius:admin:product:index'])]
|
||||
```
|
||||
# UPGRADE FROM `1.14` TO `2.0`
|
||||
|
||||
## Configuration
|
||||
|
||||
|
|
@ -108,34 +100,6 @@
|
|||
+ private string $targetState = PaymentInterface::STATE_CART,
|
||||
)
|
||||
```
|
||||
* The signature of method `applyToCollection` of the following classes has been changed:
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\AcceptedProductReviewsExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\AddressesExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\AvailableProductAssociationsInProductCollectionExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\CountryCollectionExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\CurrencyCollectionExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\EnabledProductVariantsExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\HideArchivedShippingMethodExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\LocaleCollectionExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\OrdersByChannelExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\OrdersByLoggedInUserExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\ProductsByChannelAndLocaleCodeExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\ProductsByTaxonExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\ProductsWithEnableFlagExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\ProductsWithEnableFlagExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\RestrictingFilterEagerLoadingExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\TaxonCollectionExtension`
|
||||
|
||||
```php
|
||||
public function applyToCollection(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
- string $operationName = null,
|
||||
+ \ApiPlatform\Metadata\Operation $operation = null,
|
||||
array $context = [],
|
||||
): void;
|
||||
```
|
||||
|
||||
* The `swiftmailer/swiftmailer` dependency has been removed. Use `symfony/mailer` instead.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,12 @@
|
|||
# UPGRADE FROM `1.13` TO `2.0`
|
||||
# UPGRADE FROM `1.14` TO `2.0`
|
||||
|
||||
* Non-prefix serialization groups in Sylius resources have been removed.
|
||||
If you have extended any of them, you must prefix them with `sylius:`, for example:
|
||||
|
||||
```diff
|
||||
- #[Groups(['admin:product:index'])]
|
||||
+ #[Groups(['sylius:admin:product:index'])]
|
||||
```
|
||||
|
||||
* API Platform has dropped `DataProviders` and `DataPersisters` in favor of `Providers` and `Processors`, respectively.
|
||||
Due to this change, Sylius custom `DataProviders` and `DataPersisters` have been adapted to the new API Platform interfaces
|
||||
|
|
@ -158,7 +166,7 @@ All the `setter` methods have been removed from the commands above and also ther
|
|||
}
|
||||
```
|
||||
|
||||
1. There has been introduced a new parameter:
|
||||
* There has been introduced a new parameter:
|
||||
|
||||
```yaml
|
||||
sylius_api:
|
||||
|
|
@ -168,3 +176,32 @@ All the `setter` methods have been removed from the commands above and also ther
|
|||
```
|
||||
|
||||
That avoids duplication of logic and is used in one `Sylius\Bundle\ApiBundle\Doctrine\ORM\QueryExtension\Common\NonArchivedExtension` rather than dedicated extensions for each entity.
|
||||
|
||||
* The signature of method `applyToCollection` of the following classes has been changed:
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\AcceptedProductReviewsExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\AddressesExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\AvailableProductAssociationsInProductCollectionExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\CountryCollectionExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\CurrencyCollectionExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\EnabledProductVariantsExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\HideArchivedShippingMethodExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\LocaleCollectionExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\OrdersByChannelExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\OrdersByLoggedInUserExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\ProductsByChannelAndLocaleCodeExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\ProductsByTaxonExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\ProductsWithEnableFlagExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\ProductsWithEnableFlagExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\RestrictingFilterEagerLoadingExtension`
|
||||
* `Sylius\Bundle\ApiBundle\Doctrine\QueryCollectionExtension\TaxonCollectionExtension`
|
||||
|
||||
```php
|
||||
public function applyToCollection(
|
||||
QueryBuilder $queryBuilder,
|
||||
QueryNameGeneratorInterface $queryNameGenerator,
|
||||
string $resourceClass,
|
||||
- string $operationName = null,
|
||||
+ \ApiPlatform\Metadata\Operation $operation = null,
|
||||
array $context = [],
|
||||
): void;
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue