Add TranslatorTrait refs #2493

src/lib/Zikula/Common/Translator/TranslatorTrait.php

@@ -0,0 +1,95 @@
+<?php
+/**
+ * Copyright Zikula Foundation 2015 - Zikula Application Framework
+ * This work is contributed to the Zikula Foundation under one or more
+ * Contributor Agreements and licensed to You under the following license:
+ * 
+ * @license GNU/LGPLv3 (or at your option, any later version).
+ * @package Zikula
+ *          Please see the NOTICE file distributed with this source code for further
+ *          information regarding copyright and licensing.
+ */
+
+namespace Zikula\Common\Translator;
+
+/**
+ * Class TranslatorTrait
+ * @package Zikula\Common\Translator
+ */
+trait TranslatorTrait
+{
+    /**
+     * @var \Zikula\Common\Translator\Translator
+     */
+    private $translator;
+    /**
+     * singular translation for modules.
+     *
+     * @param string $msg Message.
+     * @param null $domain
+     * @param null $locale
+     * @return string
+     */
+    public function __($msg, $domain = null, $locale = null)
+    {
+        return $this->translator->__($msg, $domain, $locale);
+    }
+
+    /**
+     * Plural translations for modules.
+     *
+     * @param string $m1 Singular.
+     * @param string $m2 Plural.
+     * @param integer $n Count.
+     * @param null $domain
+     * @param null $locale
+     * @return string
+     */
+    public function _n($m1, $m2, $n, $domain = null, $locale = null)
+    {
+        return $this->translator->_n($m1, $m2, $n, $domain, $locale);
+    }
+
+    /**
+     * Format translations for modules.
+     *
+     * @param string $msg Message.
+     * @param string|array $param Format parameters.
+     * @param null $domain
+     * @param null $locale
+     * @return string
+     */
+    public function __f($msg, $param, $domain = null, $locale = null)
+    {
+        return $this->translator->__f($msg, $param, $domain, $locale);
+    }
+
+    /**
+     * Format plural translations for modules.
+     *
+     * @param string $m1 Singular.
+     * @param string $m2 Plural.
+     * @param integer $n Count.
+     * @param string|array $param Format parameters.
+     * @param null $domain
+     * @param null $locale
+     * @return string
+     */
+    public function _fn($m1, $m2, $n, $param, $domain = null, $locale = null)
+    {
+        return $this->translator->_fn($m1, $m2, $n, $param, $domain, $locale);
+    }
+
+    /**
+     * @return Translator
+     */
+    public function getTranslator()
+    {
+        return $this->translator;
+    }
+
+    /**
+     * @param $translator
+     */
+    abstract public function setTranslator($translator);
+}