Add Operation defaults trait #984
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Sylius package. | ||
| * | ||
| * (c) Sylius Sp. z o.o. | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Sylius\Resource\Metadata\Resource\Factory; | ||
|
|
||
| use Sylius\Resource\Metadata\HttpOperation; | ||
| use Sylius\Resource\Metadata\MetadataInterface; | ||
| use Sylius\Resource\Metadata\Operation; | ||
| use Sylius\Resource\Metadata\RegistryInterface; | ||
| use Sylius\Resource\Metadata\ResourceMetadata; | ||
| use Sylius\Resource\Symfony\Request\State\Responder; | ||
| use Sylius\Resource\Symfony\Routing\Factory\RouteName\OperationRouteNameFactory; | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| trait OperationDefaultsTrait | ||
| { | ||
| private function getResourceWithDefaults( | ||
| string $resourceClass, | ||
| ResourceMetadata $resource, | ||
| MetadataInterface $resourceConfiguration, | ||
| ): ResourceMetadata { | ||
| $resource = $resource->withClass($resourceClass); | ||
|
|
||
| if (null === $resource->getAlias()) { | ||
| $resource = $resource->withAlias($resourceConfiguration->getAlias()); | ||
| } | ||
|
|
||
| if (null === $resource->getApplicationName()) { | ||
| $resource = $resource->withApplicationName($resourceConfiguration->getApplicationName()); | ||
| } | ||
|
|
||
| if (null === $resource->getName()) { | ||
| $resource = $resource->withName($resourceConfiguration->getName()); | ||
| } | ||
|
|
||
| return $resource; | ||
| } | ||
|
|
||
| private function getOperationWithDefaults( | ||
| Operation $operation, | ||
| ResourceMetadata $resource, | ||
| OperationRouteNameFactory $operationRouteNameFactory, | ||
| RegistryInterface $resourceRegistry, | ||
| ): array { | ||
| $resourceConfiguration = $resourceRegistry->get($resource->getAlias() ?? ''); | ||
|
|
||
| $operation = $operation->withResource($resource); | ||
|
|
||
| if (null === $resource->getName()) { | ||
| $resourceName = $resourceConfiguration->getName(); | ||
|
|
||
| $resource = $resource->withName($resourceName); | ||
| $operation = $operation->withResource($resource); | ||
| } | ||
|
|
||
| if (null === $resource->getPluralName()) { | ||
| $resourcePluralName = $resourceConfiguration->getPluralName(); | ||
|
|
||
| $resource = $resource->withPluralName($resourcePluralName); | ||
| $operation = $operation->withResource($resource); | ||
| } | ||
|
|
||
| if (null === $operation->getNormalizationContext()) { | ||
| $operation = $operation->withNormalizationContext($resource->getNormalizationContext()); | ||
| } | ||
|
|
||
| if (null === $operation->getDenormalizationContext()) { | ||
| $operation = $operation->withDenormalizationContext($resource->getDenormalizationContext()); | ||
| } | ||
|
|
||
| if (null === $operation->getValidationContext()) { | ||
| $operation = $operation->withValidationContext($resource->getValidationContext()); | ||
| } | ||
|
|
||
| $operation = $operation->withResource($resource); | ||
|
|
||
| if (null === $operation->getRepository()) { | ||
| $operation = $operation->withRepository($resourceConfiguration->getServiceId('repository')); | ||
| } | ||
|
|
||
| if (null === $operation->getFormType()) { | ||
| $formType = $resource->getFormType() ?? $resourceConfiguration->getClass('form'); | ||
| $operation = $operation->withFormType($formType); | ||
| } | ||
|
|
||
| $formOptions = $this->buildFormOptions($operation, $resourceConfiguration); | ||
| $operation = $operation->withFormOptions($formOptions); | ||
|
|
||
| if ($operation instanceof HttpOperation) { | ||
| if (null === $operation->getRoutePrefix()) { | ||
| $operation = $operation->withRoutePrefix($resource->getRoutePrefix() ?? null); | ||
| } | ||
|
|
||
| if (null === $operation->getTwigContextFactory()) { | ||
| $operation = $operation->withTwigContextFactory('sylius.twig.context.factory.default'); | ||
|
There was a problem hiding this comment. Unrelated to current PR, but why metadata factory is aware of the service ID? Should be handled via tagging/configuration/interfaces instead. |
||
| } | ||
|
|
||
| if (null === $routeName = $operation->getRouteName()) { | ||
| $routeName = $operationRouteNameFactory->createRouteName($operation); | ||
| $operation = $operation->withRouteName($routeName); | ||
| } | ||
|
|
||
| if (null === $operation->getResponder()) { | ||
| $operation = $operation->withResponder(Responder::class); | ||
| } | ||
|
|
||
| $operation = $operation->withName($routeName); | ||
| } | ||
|
|
||
| $operationName = $operation->getName(); | ||
|
|
||
| return [$operationName, $operation]; | ||
| } | ||
|
|
||
| private function buildFormOptions(Operation $operation, MetadataInterface $resourceConfiguration): array | ||
| { | ||
| $formOptions = array_merge( | ||
| ['data_class' => $resourceConfiguration->getClass('model')], | ||
| $operation->getFormOptions() ?? [], | ||
| ); | ||
|
|
||
| $validationGroups = $operation->getValidationContext()['groups'] ?? null; | ||
|
|
||
| if (null !== $validationGroups) { | ||
| $formOptions = array_merge(['validation_groups' => $validationGroups], $formOptions); | ||
| } | ||
|
|
||
| return $formOptions; | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.