Added a common message representation

src/Exception/LogicException.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the PHP Translation package.
+ *
+ * (c) PHP Translation team <tobias.nyholm@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Translation\Common\Exception;
+
+use Translation\Common\Exception;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class LogicException extends \LogicException implements Exception
+{
+}

src/Model/Message.php

@@ -0,0 +1,197 @@
+<?php
+
+/*
+ * This file is part of the PHP Translation package.
+ *
+ * (c) PHP Translation team <tobias.nyholm@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Translation\Common\Model;
+
+/**
+ * A object representation of a translation in a specific language.
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class Message
+{
+    /**
+     * @var string
+     *
+     * The domain the message belongs to
+     */
+    private $domain;
+
+    /**
+     * @var string
+     *
+     * The key/phrase you write in the source code
+     */
+    private $id;
+
+    /**
+     * @var string
+     *
+     * The locale the translations is on
+     */
+    private $locale;
+
+    /**
+     * @var string
+     *
+     * The translated string. This is the preview of the message. Ie no placeholders is visible.
+     */
+    private $translation;
+
+    /**
+     * Key value array with metadata.
+     *
+     * @var array
+     */
+    private $meta = [];
+
+    /**
+     * @param string $id
+     * @param string $domain
+     * @param string $locale
+     * @param string $translation
+     * @param array  $meta
+     */
+    public function __construct($id = '', $domain = '', $locale = '', $translation = '', array $meta = [])
+    {
+        $this->domain = $domain;
+        $this->id = $id;
+        $this->locale = $locale;
+        $this->translation = $translation;
+        $this->meta = $meta;
+    }
+
+    /**
+     * @return string
+     */
+    public function getDomain()
+    {
+        return $this->domain;
+    }
+
+    /**
+     * @param string $domain
+     *
+     * @return Message
+     */
+    public function setDomain($domain)
+    {
+        $this->domain = $domain;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * @param string $id
+     *
+     * @return Message
+     */
+    public function setId($id)
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getLocale()
+    {
+        return $this->locale;
+    }
+
+    /**
+     * @param string $locale
+     *
+     * @return Message
+     */
+    public function setLocale($locale)
+    {
+        $this->locale = $locale;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getTranslation()
+    {
+        return $this->translation;
+    }
+
+    /**
+     * @param string $translation
+     *
+     * @return Message
+     */
+    public function setTranslation($translation)
+    {
+        $this->translation = $translation;
+
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function getAllMeta()
+    {
+        return $this->meta;
+    }
+
+    /**
+     * @param array $meta
+     *
+     * @return Message
+     */
+    public function setMeta(array $meta)
+    {
+        $this->meta = $meta;
+
+        return $this;
+    }
+
+    /**
+     * @param array $meta
+     *
+     * @return Message
+     */
+    public function addMeta($key, $value)
+    {
+        $this->meta[$key] = $value;
+
+        return $this;
+    }
+
+    /**
+     * @param string $key
+     *
+     * @return mixed|null
+     */
+    public function getMeta($key)
+    {
+        if (isset($this->meta[$key])) {
+            return $this->meta[$key];
+        }
+
+        return;
+    }
+}

src/Storage.php

@@ -11,6 +11,8 @@
 
 namespace Translation\Common;
 
+use Translation\Common\Model\Message;
+
 /**
  * The storage is a place when you can store your translations. A database, filesystem or a third party platform.
  */
@@ -23,7 +25,7 @@ interface Storage
      * @param string $domain
      * @param string $key
      *
-     * @return string
+     * @return Message
      */
     public function get($locale, $domain, $key);
 
@@ -35,7 +37,7 @@ public function get($locale, $domain, $key);
      * @param string $key
      * @param string $message
      */
-    public function update($locale, $domain, $key, $message);
+    public function update(Message $message);
 
     /**
      * Remove a translation from the storage.