Support mapping properties in XML and YAML #814
There are no files selected for viewing
This file contains 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 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 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 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 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,202 @@ | ||
| <?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; | ||
| use Symfony\Component\Config\Util\XmlUtils; | ||
|
|
||
| /** | ||
| * Creates a property metadata from XML {@see Property} configuration. | ||
| * | ||
| * @author Baptiste Meyer <baptiste.meyer@gmail.com> | ||
| */ | ||
| class XmlPropertyMetadataFactory implements PropertyMetadataFactoryInterface | ||
| { | ||
| const RESOURCE_SCHEMA = __DIR__.'/../../schema/metadata.xsd'; | ||
|
|
||
| private $paths; | ||
| private $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'] | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * 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) { | ||
|
There was a problem hiding this comment.
|
||
| return $parentPropertyMetadata; | ||
| } | ||
|
|
||
| throw new PropertyNotFoundException(sprintf('Property "%s" of the resource class "%s" not found.', $property, $resourceClass)); | ||
| } | ||
|
|
||
| /** | ||
| * Extracts metadata from the XML tree. | ||
| * | ||
| * @param string $resourceClass | ||
| * @param string $propertyName | ||
| * | ||
| * @throws InvalidArgumentException | ||
| * | ||
| * @return array | ||
| */ | ||
| private function getMetadata(string $resourceClass, string $propertyName) : array | ||
| { | ||
| foreach ($this->paths as $path) { | ||
| try { | ||
| $domDocument = XmlUtils::loadFile($path, self::RESOURCE_SCHEMA); | ||
| } catch (\InvalidArgumentException $e) { | ||
| throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e); | ||
| } | ||
|
|
||
| $properties = (new \DOMXPath($domDocument))->query(sprintf('//resources/resource[@class="%s"]/property[@name="%s"]', $resourceClass, $propertyName)); | ||
|
|
||
| if ( | ||
| false === $properties || | ||
| 0 >= $properties->length || | ||
| null === $properties->item(0) || | ||
| false === $property = simplexml_import_dom($properties->item(0)) | ||
| ) { | ||
| continue; | ||
| } | ||
|
|
||
| return [ | ||
| 'description' => (string) $property['description'] ?: null, | ||
| 'readable' => $property['readable'] ? (bool) XmlUtils::phpize($property['readable']) : null, | ||
| 'writable' => $property['writable'] ? (bool) XmlUtils::phpize($property['writable']) : null, | ||
| 'readableLink' => $property['readableLink'] ? (bool) XmlUtils::phpize($property['readableLink']) : null, | ||
| 'writableLink' => $property['writableLink'] ? (bool) XmlUtils::phpize($property['writableLink']) : null, | ||
| 'required' => $property['required'] ? (bool) XmlUtils::phpize($property['required']) : null, | ||
| 'identifier' => $property['identifier'] ? (bool) XmlUtils::phpize($property['identifier']) : null, | ||
| 'iri' => (string) $property['iri'] ?: null, | ||
| 'attributes' => $this->getAttributes($property), | ||
| ]; | ||
| } | ||
|
|
||
| return []; | ||
| } | ||
|
|
||
| /** | ||
| * Recursively transforms an attribute structure into an associative array. | ||
| * | ||
| * @param \SimpleXMLElement $element | ||
| * | ||
| * @return array | ||
| */ | ||
| private function getAttributes(\SimpleXMLElement $element) : array | ||
| { | ||
| $attributes = []; | ||
| foreach ($element->attribute as $attribute) { | ||
| $value = isset($attribute->attribute[0]) ? $this->getAttributes($attribute) : (string) $attribute; | ||
|
|
||
| if (isset($attribute['name'])) { | ||
| $attributes[(string) $attribute['name']] = $value; | ||
| } else { | ||
| $attributes[] = $value; | ||
| } | ||
| } | ||
|
|
||
| return $attributes; | ||
| } | ||
|
|
||
| /** | ||
| * 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 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,96 @@ | ||
| <?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\ResourceClassNotFoundException; | ||
| use ApiPlatform\Core\Metadata\Property\PropertyNameCollection; | ||
| use Symfony\Component\Config\Util\XmlUtils; | ||
|
|
||
| /** | ||
| * Creates a property name collection from XML {@see Property} configuration files. | ||
| * | ||
| * @author Baptiste Meyer <baptiste.meyer@gmail.com> | ||
| */ | ||
| class XmlPropertyNameCollectionFactory implements PropertyNameCollectionFactoryInterface | ||
| { | ||
| const RESOURCE_SCHEMA = __DIR__.'/../../schema/metadata.xsd'; | ||
|
|
||
| private $paths; | ||
| private $decorated; | ||
|
|
||
| /** | ||
| * @param array $paths | ||
| * @param PropertyNameCollectionFactoryInterface|null $decorated | ||
| */ | ||
| public function __construct(array $paths, PropertyNameCollectionFactoryInterface $decorated = null) | ||
| { | ||
| $this->paths = $paths; | ||
| $this->decorated = $decorated; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @throws InvalidArgumentException | ||
| */ | ||
| public function create(string $resourceClass, array $options = []) : PropertyNameCollection | ||
| { | ||
| if ($this->decorated) { | ||
| try { | ||
| $propertyNameCollection = $this->decorated->create($resourceClass, $options); | ||
| } catch (ResourceClassNotFoundException $resourceClassNotFoundException) { | ||
| // Ignore not found exceptions from parent | ||
| } | ||
| } | ||
|
|
||
| if (!class_exists($resourceClass)) { | ||
| if (isset($propertyNameCollection)) { | ||
| return $propertyNameCollection; | ||
| } | ||
|
|
||
| throw new ResourceClassNotFoundException(sprintf('The resource class "%s" does not exist.', $resourceClass)); | ||
| } | ||
|
|
||
| $propertyNames = []; | ||
|
|
||
| foreach ($this->paths as $path) { | ||
| try { | ||
| $domDocument = XmlUtils::loadFile($path, self::RESOURCE_SCHEMA); | ||
| } catch (\InvalidArgumentException $e) { | ||
| throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e); | ||
| } | ||
|
|
||
| $properties = (new \DOMXPath($domDocument))->query(sprintf('//resources/resource[@class="%s"]/property', $resourceClass)); | ||
|
|
||
| if (false === $properties || 0 >= $properties->length) { | ||
| continue; | ||
| } | ||
|
|
||
| foreach ($properties as $property) { | ||
| if ('' === $propertyName = $property->getAttribute('name')) { | ||
| continue; | ||
| } | ||
|
|
||
| $propertyNames[$propertyName] = true; | ||
| } | ||
| } | ||
|
|
||
| if (isset($propertyNameCollection)) { | ||
| foreach ($propertyNameCollection as $propertyName) { | ||
| $propertyNames[$propertyName] = true; | ||
| } | ||
| } | ||
|
|
||
| return new PropertyNameCollection(array_keys($propertyNames)); | ||
| } | ||
| } |
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.
null !== $parentPropertyMetadataThere 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.
Yes but #770 (comment).