|
| 1 | +<?php |
| 2 | + |
| 3 | +/* |
| 4 | + * This file is part of the API Platform project. |
| 5 | + * |
| 6 | + * (c) Kévin Dunglas <dunglas@gmail.com> |
| 7 | + * |
| 8 | + * For the full copyright and license information, please view the LICENSE |
| 9 | + * file that was distributed with this source code. |
| 10 | + */ |
| 11 | + |
| 12 | +namespace ApiPlatform\Core\Metadata\Property\Factory; |
| 13 | + |
| 14 | +use ApiPlatform\Core\Exception\InvalidArgumentException; |
| 15 | +use ApiPlatform\Core\Exception\PropertyNotFoundException; |
| 16 | +use ApiPlatform\Core\Metadata\Property\PropertyMetadata; |
| 17 | +use Symfony\Component\Config\Util\XmlUtils; |
| 18 | + |
| 19 | +/** |
| 20 | + * Creates a property metadata from XML {@see Property} configuration. |
| 21 | + * |
| 22 | + * @author Baptiste Meyer <baptiste.meyer@gmail.com> |
| 23 | + */ |
| 24 | +class XmlPropertyMetadataFactory implements PropertyMetadataFactoryInterface |
| 25 | +{ |
| 26 | + const RESOURCE_SCHEMA = __DIR__.'/../../schema/metadata.xsd'; |
| 27 | + |
| 28 | + private $paths; |
| 29 | + private $decorated; |
| 30 | + |
| 31 | + /** |
| 32 | + * @param string[] $paths |
| 33 | + * @param PropertyMetadataFactoryInterface|null $decorated |
| 34 | + */ |
| 35 | + public function __construct(array $paths, PropertyMetadataFactoryInterface $decorated = null) |
| 36 | + { |
| 37 | + $this->paths = $paths; |
| 38 | + $this->decorated = $decorated; |
| 39 | + } |
| 40 | + |
| 41 | + /** |
| 42 | + * {@inheritdoc} |
| 43 | + */ |
| 44 | + public function create(string $resourceClass, string $property, array $options = []) : PropertyMetadata |
| 45 | + { |
| 46 | + $parentPropertyMetadata = null; |
| 47 | + if ($this->decorated) { |
| 48 | + try { |
| 49 | + $parentPropertyMetadata = $this->decorated->create($resourceClass, $property, $options); |
| 50 | + } catch (PropertyNotFoundException $propertyNotFoundException) { |
| 51 | + // Ignore not found exception from decorated factories |
| 52 | + } |
| 53 | + } |
| 54 | + |
| 55 | + if ( |
| 56 | + !property_exists($resourceClass, $property) || |
| 57 | + empty($propertyMetadata = $this->getMetadata($resourceClass, $property)) |
| 58 | + ) { |
| 59 | + return $this->handleNotFound($parentPropertyMetadata, $resourceClass, $property); |
| 60 | + } |
| 61 | + |
| 62 | + if ($parentPropertyMetadata) { |
| 63 | + return $this->update($parentPropertyMetadata, $propertyMetadata); |
| 64 | + } |
| 65 | + |
| 66 | + return new PropertyMetadata( |
| 67 | + null, |
| 68 | + $propertyMetadata['description'], |
| 69 | + $propertyMetadata['readable'], |
| 70 | + $propertyMetadata['writable'], |
| 71 | + $propertyMetadata['readableLink'], |
| 72 | + $propertyMetadata['writableLink'], |
| 73 | + $propertyMetadata['required'], |
| 74 | + $propertyMetadata['identifier'], |
| 75 | + $propertyMetadata['iri'], |
| 76 | + null, |
| 77 | + $propertyMetadata['attributes'] |
| 78 | + ); |
| 79 | + } |
| 80 | + |
| 81 | + /** |
| 82 | + * Returns the metadata from the decorated factory if available or throws an exception. |
| 83 | + * |
| 84 | + * @param PropertyMetadata|null $parentPropertyMetadata |
| 85 | + * @param string $resourceClass |
| 86 | + * @param string $property |
| 87 | + * |
| 88 | + * @throws PropertyNotFoundException |
| 89 | + * |
| 90 | + * @return PropertyMetadata |
| 91 | + */ |
| 92 | + private function handleNotFound(PropertyMetadata $parentPropertyMetadata = null, string $resourceClass, string $property) : PropertyMetadata |
| 93 | + { |
| 94 | + if ($parentPropertyMetadata) { |
| 95 | + return $parentPropertyMetadata; |
| 96 | + } |
| 97 | + |
| 98 | + throw new PropertyNotFoundException(sprintf('Property "%s" of the resource class "%s" not found.', $property, $resourceClass)); |
| 99 | + } |
| 100 | + |
| 101 | + /** |
| 102 | + * Extracts metadata from the XML tree. |
| 103 | + * |
| 104 | + * @param string $resourceClass |
| 105 | + * @param string $propertyName |
| 106 | + * |
| 107 | + * @throws InvalidArgumentException |
| 108 | + * |
| 109 | + * @return array |
| 110 | + */ |
| 111 | + private function getMetadata(string $resourceClass, string $propertyName) : array |
| 112 | + { |
| 113 | + foreach ($this->paths as $path) { |
| 114 | + try { |
| 115 | + $domDocument = XmlUtils::loadFile($path, self::RESOURCE_SCHEMA); |
| 116 | + } catch (\InvalidArgumentException $e) { |
| 117 | + throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e); |
| 118 | + } |
| 119 | + |
| 120 | + $properties = (new \DOMXPath($domDocument))->query(sprintf('//resources/resource[@class="%s"]/property[@name="%s"]', $resourceClass, $propertyName)); |
| 121 | + |
| 122 | + if ( |
| 123 | + false === $properties || |
| 124 | + 0 >= $properties->length || |
| 125 | + null === $properties->item(0) || |
| 126 | + false === $property = simplexml_import_dom($properties->item(0)) |
| 127 | + ) { |
| 128 | + continue; |
| 129 | + } |
| 130 | + |
| 131 | + return [ |
| 132 | + 'description' => (string) $property['description'] ?: null, |
| 133 | + 'readable' => $property['readable'] ? (bool) XmlUtils::phpize($property['readable']) : null, |
| 134 | + 'writable' => $property['writable'] ? (bool) XmlUtils::phpize($property['writable']) : null, |
| 135 | + 'readableLink' => $property['readableLink'] ? (bool) XmlUtils::phpize($property['readableLink']) : null, |
| 136 | + 'writableLink' => $property['writableLink'] ? (bool) XmlUtils::phpize($property['writableLink']) : null, |
| 137 | + 'required' => $property['required'] ? (bool) XmlUtils::phpize($property['required']) : null, |
| 138 | + 'identifier' => $property['identifier'] ? (bool) XmlUtils::phpize($property['identifier']) : null, |
| 139 | + 'iri' => (string) $property['iri'] ?: null, |
| 140 | + 'attributes' => $this->getAttributes($property), |
| 141 | + ]; |
| 142 | + } |
| 143 | + |
| 144 | + return []; |
| 145 | + } |
| 146 | + |
| 147 | + /** |
| 148 | + * Recursively transforms an attribute structure into an associative array. |
| 149 | + * |
| 150 | + * @param \SimpleXMLElement $element |
| 151 | + * |
| 152 | + * @return array |
| 153 | + */ |
| 154 | + private function getAttributes(\SimpleXMLElement $element) : array |
| 155 | + { |
| 156 | + $attributes = []; |
| 157 | + foreach ($element->attribute as $attribute) { |
| 158 | + $value = isset($attribute->attribute[0]) ? $this->getAttributes($attribute) : (string) $attribute; |
| 159 | + |
| 160 | + if (isset($attribute['name'])) { |
| 161 | + $attributes[(string) $attribute['name']] = $value; |
| 162 | + } else { |
| 163 | + $attributes[] = $value; |
| 164 | + } |
| 165 | + } |
| 166 | + |
| 167 | + return $attributes; |
| 168 | + } |
| 169 | + |
| 170 | + /** |
| 171 | + * Creates a new instance of metadata if the property is not already set. |
| 172 | + * |
| 173 | + * @param PropertyMetadata $propertyMetadata |
| 174 | + * @param array $metadata |
| 175 | + * |
| 176 | + * @return PropertyMetadata |
| 177 | + */ |
| 178 | + private function update(PropertyMetadata $propertyMetadata, array $metadata) : PropertyMetadata |
| 179 | + { |
| 180 | + $metadataAccessors = [ |
| 181 | + 'description' => 'get', |
| 182 | + 'readable' => 'is', |
| 183 | + 'writable' => 'is', |
| 184 | + 'writableLink' => 'is', |
| 185 | + 'readableLink' => 'is', |
| 186 | + 'required' => 'is', |
| 187 | + 'identifier' => 'is', |
| 188 | + 'iri' => 'get', |
| 189 | + 'attributes' => 'get', |
| 190 | + ]; |
| 191 | + |
| 192 | + foreach ($metadataAccessors as $metadataKey => $accessorPrefix) { |
| 193 | + if (null === $metadata[$metadataKey] || null !== $propertyMetadata->{$accessorPrefix.ucfirst($metadataKey)}()) { |
| 194 | + continue; |
| 195 | + } |
| 196 | + |
| 197 | + $propertyMetadata = $propertyMetadata->{'with'.ucfirst($metadataKey)}($metadata[$metadataKey]); |
| 198 | + } |
| 199 | + |
| 200 | + return $propertyMetadata; |
| 201 | + } |
| 202 | +} |
0 commit comments