Merge pull request #14 from Icinga/translator

Add Translator interface

Author: lippserd

src/Contract/Translator.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace ipl\Stdlib;
+
+/**
+ * Representation of translators
+ */
+interface Translator
+{
+    /**
+     * Translate a message
+     *
+     * @param string $message
+     * @param string $context Message context
+     *
+     * @return string Translated message or original message if no translation is found
+     */
+    public function translate($message, $context = null);
+
+    /**
+     * Translate a message in the given domain
+     *
+     * If no translation is found in the specified domain, the translation is also searched for in the default domain.
+     *
+     * @param string $domain
+     * @param string $message
+     * @param string $context Message context
+     *
+     * @return string Translated message or original message if no translation is found
+     */
+    public function translateInDomain($domain, $message, $context = null);
+
+    /**
+     * Translate a plural message
+     *
+     * The returned message is based on the given number to decide between the singular and plural forms.
+     * That is also the case if no translation is found.
+     *
+     * @param string $singular Singular message
+     * @param string $plural   Plural message
+     * @param int    $number   Number to decide between the returned singular and plural forms
+     * @param string $context  Message context
+     *
+     * @return string Translated message or original message if no translation is found
+     */
+    public function translatePlural($singular, $plural, $number, $context = null);
+
+    /**
+     * Translate a plural message in the given domain
+     *
+     * If no translation is found in the specified domain, the translation is also searched for in the default domain.
+     *
+     * The returned message is based on the given number to decide between the singular and plural forms.
+     * That is also the case if no translation is found.
+     *
+     * @param string $domain
+     * @param string $singular Singular message
+     * @param string $plural   Plural message
+     * @param int    $number   Number to decide between the returned singular and plural forms
+     * @param string $context  Message context
+     *
+     * @return string Translated message or original message if no translation is found
+     */
+    public function translatePluralInDomain($domain, $singular, $plural, $number, $context = null);
+}