add mapping classes for statements and verbs

This commit reflects the latest changes from the php-xapi/model package
where the MappedStatement and MappedVerb classes have been removed as
they are purely related to Doctrine based repository implementations.

Author: xabbuh

CHANGELOG.md

@@ -4,6 +4,13 @@ CHANGELOG
 0.3.0
 -----
 
+* The `MappedStatement` and `MappedVerb` classes have been removed from the
+  `php-xapi/model` package. They have been replaced with the new `Statement`
+  and `Verb` classes in the `XApi\Repository\Doctrine\Mapping` namespace of
+  this package. Consequently, the `MappedStatementRepository` class has been
+  removed. It was replaced with a new `StatementRepository` class in the
+  `XApi\Repository\Doctrine\Repository\Mapping` namespace.
+
 * The requirements for `php-xapi/model` and `php-xapi/test-fixtures` have
   been bumped to `^1.0` to make use of their stable releases.
 

UPGRADE.md

@@ -4,6 +4,13 @@ UPGRADE
 Upgrading from 0.2 to 0.3
 -------------------------
 
+* The `MappedStatement` and `MappedVerb` classes have been removed from the
+  `php-xapi/model` package. They have been replaced with the new `Statement`
+  and `Verb` classes in the `XApi\Repository\Doctrine\Mapping` namespace of
+  this package. Consequently, the `MappedStatementRepository` class has been
+  removed. It was replaced with a new `StatementRepository` class in the
+  `XApi\Repository\Doctrine\Repository\Mapping` namespace.
+
 * The requirements for `php-xapi/model` and `php-xapi/test-fixtures` have
   been bumped to `^1.0` to make use of their stable releases.
 

composer.json

@@ -13,7 +13,8 @@
     "require": {
         "doctrine/common": "~2.4",
         "php-xapi/model": "^1.0",
-        "php-xapi/repository-api": "^0.3@dev"
+        "php-xapi/repository-api": "^0.3@dev",
+        "ramsey/uuid": "^2.9"
     },
     "require-dev": {
         "php-xapi/test-fixtures": "^1.0"

src/Mapping/Statement.php

@@ -0,0 +1,85 @@
+<?php
+
+/*
+ * This file is part of the xAPI package.
+ *
+ * (c) Christian Flothmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\Repository\Doctrine\Mapping;
+
+use Xabbuh\XApi\Model\Actor;
+use Xabbuh\XApi\Model\Result;
+use Xabbuh\XApi\Model\Statement as StatementModel;
+use Xabbuh\XApi\Model\StatementId;
+
+/**
+ * A {@link Statement} mapped to a storage backend.
+ *
+ * @author Christian Flothmann <[email protected]>
+ */
+class Statement
+{
+    /**
+     * @var string
+     */
+    public $id;
+
+    /**
+     * @var Actor
+     */
+    public $actor;
+
+    /**
+     * @var Verb
+     */
+    public $verb;
+
+    /**
+     * @var \Xabbuh\XApi\Model\Object
+     */
+    public $object;
+
+    /**
+     * @var Result
+     */
+    public $result;
+
+    /**
+     * @var Actor
+     */
+    public $authority;
+
+    /**
+     * @var \DateTime
+     */
+    public $created;
+
+    /**
+     * @var \DateTime
+     */
+    public $stored;
+
+    public function getModel()
+    {
+        return new StatementModel(StatementId::fromString($this->id), $this->actor, $this->verb->getModel(), $this->object, $this->result, $this->authority, $this->created, $this->stored);
+    }
+
+    public static function fromModel(StatementModel $statement)
+    {
+        $mappedStatement = new self();
+        $mappedStatement->id = $statement->getId()->getValue();
+        $mappedStatement->actor = $statement->getActor();
+        $mappedStatement->verb = Verb::fromModel($statement->getVerb());
+        $mappedStatement->object = $statement->getObject();
+        $mappedStatement->result = $statement->getResult();
+        $mappedStatement->authority = $statement->getAuthority();
+        $mappedStatement->created = $statement->getCreated();
+        $mappedStatement->stored = $statement->getStored();
+
+        return $mappedStatement;
+    }
+}

src/Mapping/Verb.php

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * This file is part of the xAPI package.
+ *
+ * (c) Christian Flothmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\Repository\Doctrine\Mapping;
+
+use Xabbuh\XApi\Model\Verb as VerbModel;
+
+/**
+ * A {@link Verb} mapped to a storage backend.
+ *
+ * @author Christian Flothmann <[email protected]>
+ */
+class Verb
+{
+    public $identifier;
+    public $id;
+    public $display;
+
+    public function getModel()
+    {
+        return new VerbModel($this->id, $this->display);
+    }
+
+    public function equals(Verb $verb)
+    {
+        if ($this->identifier !== $verb->identifier) {
+            return false;
+        }
+
+        if ($this->id !== $verb->id) {
+            return false;
+        }
+
+        if ($this->display !== $verb->display) {
+            return false;
+        }
+
+        return true;
+    }
+
+    public static function fromModel(VerbModel $verb)
+    {
+        $mappedVerb = new self();
+        $mappedVerb->id = $verb->getId();
+        $mappedVerb->display = $verb->getDisplay();
+
+        return $mappedVerb;
+    }
+}

src/Repository/MappedStatementRepository.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the xAPI package.
+ *
+ * (c) Christian Flothmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\Repository\Doctrine\Repository\Mapping;
+
+use XApi\Repository\Doctrine\Mapping\Statement;
+
+/**
+ * {@link Statement} repository interface definition.
+ *
+ * @author Christian Flothmann <[email protected]>
+ */
+interface StatementRepository
+{
+    /**
+     * @param array $criteria
+     *
+     * @return Statement The statement or null if no matching statement
+     *                   has been found
+     */
+    public function findStatement(array $criteria);
+
+    /**
+     * @param array $criteria
+     *
+     * @return Statement[] The statements matching the given criteria
+     */
+    public function findStatements(array $criteria);
+
+    /**
+     * Saves a {@link Statement} in the underlying storage.
+     *
+     * @param Statement $statement The statement being stored
+     * @param bool      $flush     Whether or not to flush the managed objects
+     *                             (i.e. write them to the data storage immediately)
+     */
+    public function storeStatement(Statement $statement, $flush = true);
+}