Integrate alias into $metadata

- added missing type PropertyPath
- added Identifier to Record
- added missing Type attribute to Record
- added alias to Identifier – including dirty hack to derive it from given namespace
- added addReference to Lodata Facade to allow adding additional vocabularies to the model
- added alias for all auto registered References

Author: mgerzabek

.gitignore

@@ -3,6 +3,7 @@ vendor/
 .phpunit.result.cache
 .phpunit.cache/test-results
 .phpdoc/
+.idea
 .idea/dataSources.xml
 .idea/**/tasks.xml
 .idea/**/usage.statistics.xml

src/Annotation.php

@@ -13,6 +13,7 @@
 use Flat3\Lodata\Type\Byte;
 use Flat3\Lodata\Type\Collection;
 use Flat3\Lodata\Type\Enum;
+use Flat3\Lodata\Type\PropertyPath;
 use Flat3\Lodata\Type\String_;
 use SimpleXMLElement;
 
@@ -58,6 +59,10 @@ public function appendJsonValue($value)
             case $value instanceof Record:
                 $record = (object) [];
 
+                if (method_exists($value, 'getTypeName') && $value->getTypeName()) {
+                    $record->{'@type'} = $value->getTypeName();
+                }
+
                 /** @var PropertyValue $propertyValue */
                 foreach ($value as $propertyValue) {
                     $record->{$propertyValue->getProperty()->getName()} = $this->appendJsonValue($propertyValue->getPrimitive());
@@ -109,6 +114,10 @@ protected function appendXmlValue(SimpleXMLElement $element, $value)
                 $element->addAttribute('Int', $value->toUrl());
                 break;
 
+            case $value instanceof PropertyPath:
+                $element->addAttribute('PropertyPath', $value->get());
+                break;
+
             case $value instanceof String_:
                 $element->addAttribute('String', $value->get());
                 break;
@@ -147,6 +156,10 @@ protected function appendXmlValue(SimpleXMLElement $element, $value)
     protected function appendXmlRecord(SimpleXMLElement $element, Record $record)
     {
         $recordElement = $element->addChild('Record');
+        $identifier = $record->getIdentifier();
+        if (!is_null($identifier)) {
+            $recordElement->addAttribute('Type', $identifier->getQualifiedName());
+        }
 
         /** @var PropertyValue $propertyValue */
         foreach ($record as $propertyValue) {

src/Annotation/Capabilities/V1/Reference.php

@@ -12,4 +12,5 @@ class Reference extends \Flat3\Lodata\Annotation\Reference
 {
     protected $uri = 'https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Capabilities.V1';
     protected $namespace = 'Org.OData.Capabilities.V1';
+    protected $alias = 'Capabilities';
 }

src/Annotation/Core/V1/Reference.php

@@ -12,4 +12,5 @@ class Reference extends \Flat3\Lodata\Annotation\Reference
 {
     protected $uri = 'https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Core.V1';
     protected $namespace = 'Org.OData.Core.V1';
+    protected $alias = 'Core';
 }

src/Annotation/Record.php

@@ -4,6 +4,7 @@
 
 namespace Flat3\Lodata\Annotation;
 
+use Flat3\Lodata\Helper\Identifier;
 use Flat3\Lodata\Helper\ObjectArray;
 use Flat3\Lodata\Interfaces\TypeInterface;
 use Flat3\Lodata\Traits\HasComplexType;
@@ -16,4 +17,31 @@
 class Record extends ObjectArray implements TypeInterface
 {
     use HasComplexType;
+
+    /**
+     * Resource identifier
+     * @var Identifier $identifier
+     */
+    protected $identifier;
+
+    /**
+     * Get the identifier
+     * @return Identifier Identifier
+     */
+    public function getIdentifier(): ?Identifier
+    {
+        return $this->identifier;
+    }
+
+    /**
+     * Set the identifier
+     * @param  string|Identifier  $identifier  Identifier
+     * @return $this
+     */
+    public function setIdentifier($identifier): Record
+    {
+        $this->identifier = $identifier instanceof Identifier ? $identifier : new Identifier($identifier);
+
+        return $this;
+    }
 }

src/Annotation/Reference.php

@@ -33,6 +33,21 @@ class Reference
      */
     protected $alias;
 
+    public function getUri(): string
+    {
+        return $this->uri;
+    }
+
+    public function getNamespace(): string
+    {
+        return $this->namespace;
+    }
+
+    public function getAlias(): string
+    {
+        return is_null($this->alias) ? $this->namespace : $this->alias;
+    }
+
     /**
      * Append this reference to the provided XML element
      * @param  SimpleXMLElement  $schema  Schema

src/Facades/Lodata.php

@@ -46,6 +46,7 @@
  * @method static ComplexType getComplexType(Identifier|string $name) Get a complex type from the model
  * @method static Singleton getSingleton(Identifier|string $name) Get a singleton from the model
  * @method static IdentifierInterface add(IdentifierInterface $item) Add a named resource or type to the model
+ * @method static Model addReference(Reference $reference) Add a reference to an external CSDL document
  * @method static Model drop(Identifier|string $key) Drop a named resource or type from the model
  * @method static EntityContainer getEntityContainer() Get the entity container
  * @method static string getNamespace() Get the namespace of this model

src/Helper/Identifier.php

@@ -26,6 +26,11 @@ final class Identifier
      */
     private $namespace;
 
+    /**
+     * @var string $alias
+     */
+    private $alias;
+
     public function __construct(string $identifier)
     {
         if (!Str::contains($identifier, '.')) {
@@ -38,6 +43,14 @@ public function __construct(string $identifier)
 
         $this->name = Str::afterLast($identifier, '.');
         $this->namespace = Str::beforeLast($identifier, '.');
+
+        // NB dirty hack to derive alias from namespace
+        if (preg_match('/\.([^.]+)\.V1$/', $this->namespace, $matches)) {
+            $this->alias = $matches[1];
+        }
+        else {
+            $this->alias = $this->namespace;
+        }
     }
 
     /**
@@ -98,7 +111,7 @@ public function setNamespace(string $namespace): self
      */
     public function getQualifiedName(): string
     {
-        return $this->namespace.'.'.$this->name;
+        return $this->alias.'.'.$this->name;
     }
 
     /**

src/Type/PropertyPath.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Flat3\Lodata\Type;
+
+use Flat3\Lodata\Type\String_;
+
+class PropertyPath extends String_
+{
+    // @PropertyPath in EDXML
+    const identifier = 'Edm.PropertyPath';
+}