-
-
Notifications
You must be signed in to change notification settings - Fork 933
Introduce AbstractFilePropertyMetadatFactory to remove duplicated code. #835
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
144 changes: 144 additions & 0 deletions
144
src/Metadata/Property/Factory/AbstractFilePropertyMetadataFactory.php
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,144 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the API Platform project. | ||
| * | ||
| * (c) Kévin Dunglas <dunglas@gmail.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace ApiPlatform\Core\Metadata\Property\Factory; | ||
|
|
||
| use ApiPlatform\Core\Exception\InvalidArgumentException; | ||
| use ApiPlatform\Core\Exception\PropertyNotFoundException; | ||
| use ApiPlatform\Core\Metadata\Property\PropertyMetadata; | ||
|
|
||
| /** | ||
| * Common base class to load properties's metadata from files. | ||
| * | ||
| * @author Kévin Dunglas <dunglas@gmail.com> | ||
| * | ||
| * @internal | ||
| */ | ||
| abstract class AbstractFilePropertyMetadataFactory implements PropertyMetadataFactoryInterface | ||
| { | ||
| protected $paths; | ||
| protected $decorated; | ||
|
|
||
| /** | ||
| * @param string[] $paths | ||
| * @param PropertyMetadataFactoryInterface|null $decorated | ||
| */ | ||
| public function __construct(array $paths, PropertyMetadataFactoryInterface $decorated = null) | ||
| { | ||
| $this->paths = $paths; | ||
| $this->decorated = $decorated; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function create(string $resourceClass, string $property, array $options = []): PropertyMetadata | ||
| { | ||
| $parentPropertyMetadata = null; | ||
| if ($this->decorated) { | ||
| try { | ||
| $parentPropertyMetadata = $this->decorated->create($resourceClass, $property, $options); | ||
| } catch (PropertyNotFoundException $propertyNotFoundException) { | ||
| // Ignore not found exception from decorated factories | ||
| } | ||
| } | ||
|
|
||
| if ( | ||
| !property_exists($resourceClass, $property) || | ||
| empty($propertyMetadata = $this->getMetadata($resourceClass, $property)) | ||
| ) { | ||
| return $this->handleNotFound($parentPropertyMetadata, $resourceClass, $property); | ||
| } | ||
|
|
||
| if ($parentPropertyMetadata) { | ||
| return $this->update($parentPropertyMetadata, $propertyMetadata); | ||
| } | ||
|
|
||
| return new PropertyMetadata( | ||
| null, | ||
| $propertyMetadata['description'], | ||
| $propertyMetadata['readable'], | ||
| $propertyMetadata['writable'], | ||
| $propertyMetadata['readableLink'], | ||
| $propertyMetadata['writableLink'], | ||
| $propertyMetadata['required'], | ||
| $propertyMetadata['identifier'], | ||
| $propertyMetadata['iri'], | ||
| null, | ||
| $propertyMetadata['attributes'] | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Extracts metadata from the XML tree. | ||
| * | ||
| * @param string $resourceClass | ||
| * @param string $propertyName | ||
| * | ||
| * @throws InvalidArgumentException | ||
| * | ||
| * @return array | ||
| */ | ||
| abstract protected function getMetadata(string $resourceClass, string $propertyName): array; | ||
|
|
||
| /** | ||
| * Returns the metadata from the decorated factory if available or throws an exception. | ||
| * | ||
| * @param PropertyMetadata|null $parentPropertyMetadata | ||
| * @param string $resourceClass | ||
| * @param string $property | ||
| * | ||
| * @throws PropertyNotFoundException | ||
| * | ||
| * @return PropertyMetadata | ||
| */ | ||
| private function handleNotFound(PropertyMetadata $parentPropertyMetadata = null, string $resourceClass, string $property): PropertyMetadata | ||
| { | ||
| if ($parentPropertyMetadata) { | ||
| return $parentPropertyMetadata; | ||
| } | ||
|
|
||
| throw new PropertyNotFoundException(sprintf('Property "%s" of the resource class "%s" not found.', $property, $resourceClass)); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new instance of metadata if the property is not already set. | ||
| * | ||
| * @param PropertyMetadata $propertyMetadata | ||
| * @param array $metadata | ||
| * | ||
| * @return PropertyMetadata | ||
| */ | ||
| private function update(PropertyMetadata $propertyMetadata, array $metadata): PropertyMetadata | ||
| { | ||
| $metadataAccessors = [ | ||
| 'description' => 'get', | ||
| 'readable' => 'is', | ||
| 'writable' => 'is', | ||
| 'writableLink' => 'is', | ||
| 'readableLink' => 'is', | ||
| 'required' => 'is', | ||
| 'identifier' => 'is', | ||
| 'iri' => 'get', | ||
| 'attributes' => 'get', | ||
| ]; | ||
|
|
||
| foreach ($metadataAccessors as $metadataKey => $accessorPrefix) { | ||
| if (null === $metadata[$metadataKey] || null !== $propertyMetadata->{$accessorPrefix.ucfirst($metadataKey)}()) { | ||
| continue; | ||
| } | ||
|
|
||
| $propertyMetadata = $propertyMetadata->{'with'.ucfirst($metadataKey)}($metadata[$metadataKey]); | ||
| } | ||
|
|
||
| return $propertyMetadata; | ||
| } | ||
| } | ||
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
Oops, something went wrong.
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.
Not necessarily XML...