feat: RDF Object Mapper PoC

manifest.php

@@ -30,6 +30,7 @@
 use oat\tao\model\import\ServiceProvider\ImportServiceProvider;
 use oat\tao\model\metadata\ServiceProvider\MetadataServiceProvider;
 use oat\tao\model\Observer\ServiceProvider\ObserverServiceProvider;
+use oat\tao\model\RdfObjectMapper\ServiceProvider\RdfObjectMapperServiceProvider;
 use oat\tao\model\resources\ResourcesServiceProvider;
 use oat\tao\model\featureFlag\FeatureFlagServiceProvider;
 use oat\tao\helpers\form\ServiceProvider\FormServiceProvider;
@@ -297,5 +298,6 @@
         AccessControlServiceProvider::class,
         MetadataServiceProvider::class,
         ObserverServiceProvider::class,
+        RdfObjectMapperServiceProvider::class,
     ],
 ];

models/classes/RdfObjectMapper/Annotation/RdfAttributeMapping.php

@@ -0,0 +1,103 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2022 (original work) Open Assessment Technologies SA.
+ */
+
+namespace oat\tao\model\RdfObjectMapper\Annotation;
+
+use core_kernel_classes_Property;
+use core_kernel_classes_Resource;
+use Psr\Log\LoggerInterface;
+use ReflectionProperty;
+
+//#[\Attribute(\Attribute::TARGET_PROPERTY)]
+/**
+ *@Annotation
+ */
+class RdfAttributeMapping
+{
+    public /*string*/ $propertyUri;
+    public /*string*/ $attributeType = 'resource';
+    public /*string*/ $mappedField = null;
+
+    // the commented out constructors are in case we use PHP 8 annotations
+    /*public function __construct(
+        string $propertyUri,
+        string $attributeType = 'resource',
+        string $mappedField  = ''
+    )
+    {
+        $this->propertyUri   = $propertyUri;
+        $this->attributeType = $attributeType;
+        $this->mappedField   = $mappedField;
+    }*/
+
+    /*public function __construct() //($data, $b, $c)
+    {
+        //$this->attributeType = $attributeType;
+
+        //echo "Called RdfAttributeMapping ctor with ".var_export($data,true);
+    }*/
+
+    // You may see keeping hydrate() here in the annotation class as a good
+    // thing (as in "higher cohesion", keeping the value initialization in the
+    // annotation implementation) or bad thing (as in "higher coupling",
+    // preventing having more than one behaviour (implementation) for a given
+    // annotation).
+    //
+    // Maybe we'll want to allow overriding the behaviour for a given annotation
+    // somehow in the future (for example, from extensions)).
+    //
+    public function hydrate(
+        LoggerInterface $logger,
+        ReflectionProperty $property,
+        core_kernel_classes_Resource $src,
+        object $targetObject
+    ): void
+    {
+        $logger->debug(__CLASS__ . " maps a value to the property");
+
+        $values = $src->getPropertyValues(
+            new core_kernel_classes_Property($this->propertyUri)
+        );
+
+        if(count($values) == 0) {
+            $logger->warning(__CLASS__ . " no value to map");
+            return;
+        }
+
+        if(count($values) > 1) {
+            $logger->warning(__CLASS__ . "too many values to map");
+            return;
+        }
+
+        if(count($values) == 1) {
+            $value = current($values);
+            $logger->info(
+                sprintf("%s Mapping value %s into %s",
+                    __CLASS__,
+                    $value,
+                    $property->getName()
+                )
+            );
+
+            $property->setAccessible(true);
+            $property->setValue($targetObject, $value);
+        }
+    }
+}

models/classes/RdfObjectMapper/Annotation/RdfResourceAttributeMapping.php

@@ -0,0 +1,90 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2022 (original work) Open Assessment Technologies SA.
+ */
+
+namespace oat\tao\model\RdfObjectMapper\Annotation;
+
+use core_kernel_classes_Resource;
+use LogicException;
+use Psr\Log\LoggerInterface;
+use ReflectionProperty;
+
+//#[\Attribute(\Attribute::TARGET_PROPERTY)]
+/**
+ *@Annotation
+ */
+class RdfResourceAttributeMapping
+{
+    public /*int*/ $type = 0;
+
+    // the commented out constructors are in case we use PHP 8 annotations
+    //public function __construct(int $attributeType)
+    /*public function __construct($data)
+    {
+        //$this->attributeType = $attributeType;
+
+        //echo "Called RdfResourceAttributeMapping ctor with ".var_export($data,true);
+    }*/
+
+    public function hydrate(
+        LoggerInterface $logger,
+        ReflectionProperty $property,
+        core_kernel_classes_Resource $src,
+        object $targetObject
+    ): void
+    {
+        $logger->debug(
+            __CLASS__ .
+            ' maps a (direct) value from the resource class to the property'
+        );
+
+        switch ($this->type)
+        {
+            case RdfResourceAttributeType::LABEL:
+                $value = $src->getLabel();
+                break;
+            case RdfResourceAttributeType::COMMENT:
+                $value = $src->getComment();
+                break;
+            case RdfResourceAttributeType::URI:
+                $value = $src->getUri();
+                break;
+            default:
+                throw new LogicException(
+                    "Unknown ".__CLASS__."::type value: ".
+                    $this->type
+                );
+        }
+
+        $logger->info(
+            sprintf("%s Mapping value %s into %s",
+                __CLASS__,
+                $value,
+                $property->getName()
+            )
+        );
+
+        if (version_compare(PHP_VERSION, '8.1.0', '<')) {
+            // Not needed starting PHP 8.1 (it has become a no-op since then)
+            $property->setAccessible(true);
+        }
+
+        $property->setValue($targetObject, $value);
+    }
+}

models/classes/RdfObjectMapper/Annotation/RdfResourceAttributeType.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2022 (original work) Open Assessment Technologies SA.
+ */
+
+namespace oat\tao\model\RdfObjectMapper\Annotation;
+
+class RdfResourceAttributeType
+{
+    public const URI = 1;
+    public const LABEL = 2;
+    public const COMMENT = 3;
+}

models/classes/RdfObjectMapper/Contract/RdfObjectMapperInterface.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2022 (original work) Open Assessment Technologies SA.
+ */
+
+namespace oat\tao\model\RdfObjectMapper\Contract;
+
+use core_kernel_classes_Resource;
+
+interface RdfObjectMapperInterface
+{
+    public function mapResource(
+        core_kernel_classes_Resource $resource,
+        string $targetClass
+    ): object;
+}

models/classes/RdfObjectMapper/Example/UserSettingsMappedType.php

@@ -0,0 +1,119 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2021 (original work) Open Assessment Technologies SA.
+ */
+
+namespace oat\tao\model\RdfObjectMapper\Example;
+
+use oat\generis\model\GenerisRdf;
+use oat\tao\model\user\UserSettingsInterface;
+
+use oat\tao\model\RdfObjectMapper\Annotation\RdfAttributeMapping;
+use oat\tao\model\RdfObjectMapper\Annotation\RdfResourceAttributeMapping;
+use oat\tao\model\RdfObjectMapper\Annotation\RdfResourceAttributeType;
+
+
+/**
+ * Example object type with RDF mapping annotations.
+ *
+ * This would be "userland code" for the mapper (i.e. objects using annotations
+ * are to be located in other models/namespaces (tao/models/classes/user etc)
+ */
+class UserSettingsMappedType implements UserSettingsInterface
+{
+    //#[RdfResourceAttributeMapping(RdfResourceAttributeMapping::URI)]
+    /** @RdfResourceAttributeMapping(type = RdfResourceAttributeType::URI) */
+    private /*string*/ $userUri;
+
+    //#[RdfResourceAttributeMapping(RdfResourceAttributeMapping::LABEL)]
+    /** @RdfResourceAttributeMapping(type = RdfResourceAttributeType::LABEL) */
+    private /*string*/ $userLabel;
+
+    //#[RdfResourceAttributeMapping(RdfResourceAttributeMapping::COMMENT)]
+    /** @RdfResourceAttributeMapping(type = RdfResourceAttributeType::COMMENT) */
+    private /*string*/ $userComment;
+
+    /*#[RdfAttributeMapping(
+        GenerisRdf::PROPERTY_USER_UILG,
+        'resource',
+
+        // field returned for non-literal properties.
+        // Can be
+        // - 'alias' (string)
+        // - 'range' (core_kernel_classes_ContainerCollection, calls $property->getRange())
+        // - 'resource' (complete resource instance)
+        //      - 'uri' (resource URI as string)
+        'uri'
+    )]*/
+
+    /** @RdfAttributeMapping(
+     *     propertyUri = GenerisRdf::PROPERTY_USER_UILG,
+     *     attributeType = "resource",
+     *     mappedField = "uri")
+     */
+    private /*?string*/ $uiLanguageCode;
+
+    /**
+     * @RdfAttributeMapping(
+     *     propertyUri = GenerisRdf::PROPERTY_USER_DEFLG,
+     *     attributeType = "resource",
+     *     mappedField = "uri")
+     */
+    private /*?string*/ $dataLanguage;
+
+    /**
+     * property returned as a core_kernel_classes_Literal instance,
+     * will be converted to string
+     * @todo Use RdfResourceAttributeType (or a new class) constants for
+     *       attributeType
+     * @RdfAttributeMapping(
+     *     GenerisRdf::PROPERTY_USER_TIMEZONE,
+     *     attributeType = "literal")
+     */
+    private /*string*/ $timezone;
+
+    public function getUri(): string
+    {
+        return $this->userUri;
+    }
+
+    public function getLabel(): string
+    {
+        return $this->userLabel;
+    }
+
+    public function getComment(): string
+    {
+        return $this->userComment;
+    }
+
+    public function getUILanguageCode(): ?string
+    {
+        return $this->uiLanguageCode;
+    }
+
+    public function getDataLanguageCode(): ?string
+    {
+        return $this->dataLanguage;
+    }
+
+    public function getTimezone(): string
+    {
+        return $this->timezone;
+    }
+}