Merge branch 'hotfix/i18n'

Close #57

Author: weierophinney

CHANGELOG.md

@@ -2,11 +2,14 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
-## 2.6.6 - TBD
+## 2.6.6 - 2016-04-18
 
 ### Added
 
-- Nothing.
+- [#57](https://github.com/zendframework/zend-view/pull/57) adds
+  `Zend\View\Helper\TranslatorAwareTrait`, which provides implementation for
+  `Zend\I18n\Translator\TranslatorAwareInterface`, and allowed removal of
+  duplicated implementations in several helpers.
 
 ### Deprecated
 
@@ -18,7 +21,15 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- Nothing.
+- [#57](https://github.com/zendframework/zend-view/pull/57) removes the explicit
+  dependency on `Zend\I18n\Translator\TranslatorAwareInterface` by allowing
+  helpers to duck type the interface to receive a translator during
+  instantiation; this allows such helpers to work even when zend-i18n is not
+  installed. The following helpers were updated to duck type the interface
+  instead of implement it explicitly:
+  - `FlashMessenger`
+  - `HeadTitle`
+  - all `Navigation` helpers
 
 ## 2.6.5 - 2016-03-21
 

src/Helper/FlashMessenger.php

@@ -1,22 +1,23 @@
 <?php
 /**
- * Zend Framework (http://framework.zend.com/)
- *
- * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @link      http://github.com/zendframework/zend-view for the canonical source repository
+ * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 
 namespace Zend\View\Helper;
 
 use Zend\Mvc\Controller\Plugin\FlashMessenger as PluginFlashMessenger;
-use Zend\I18n\View\Helper\AbstractTranslatorHelper;
 
 /**
  * Helper to proxy the plugin flash messenger
+ *
+ * Duck-types against Zend\I18n\Translator\TranslatorAwareInterface.
  */
-class FlashMessenger extends AbstractTranslatorHelper
+class FlashMessenger extends AbstractHelper
 {
+    use TranslatorAwareTrait;
+
     /**
      * Default attributes for the open format tag
      *
@@ -149,9 +150,9 @@ protected function renderMessages(
         }
 
         // Flatten message array
-        $escapeHtml      = $this->getEscapeHtmlHelper();
-        $messagesToPrint = [];
-        $translator = $this->getTranslator();
+        $escapeHtml           = $this->getEscapeHtmlHelper();
+        $messagesToPrint      = [];
+        $translator           = $this->getTranslator();
         $translatorTextDomain = $this->getTranslatorTextDomain();
         array_walk_recursive(
             $messages,

src/Helper/HeadTitle.php

@@ -1,24 +1,23 @@
 <?php
 /**
- * Zend Framework (http://framework.zend.com/)
- *
- * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @link      http://github.com/zendframework/zend-view for the canonical source repository
+ * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 
 namespace Zend\View\Helper;
 
-use Zend\I18n\Translator\TranslatorInterface as Translator;
-use Zend\I18n\Translator\TranslatorAwareInterface;
 use Zend\View\Exception;
 
 /**
- * Helper for setting and retrieving title element for HTML head
+ * Helper for setting and retrieving title element for HTML head.
+ *
+ * Duck-types against Zend\I18n\Translator\TranslatorAwareInterface.
  */
-class HeadTitle extends Placeholder\Container\AbstractStandalone implements
-    TranslatorAwareInterface
+class HeadTitle extends Placeholder\Container\AbstractStandalone
 {
+    use TranslatorAwareTrait;
+
     /**
      * Registry key for placeholder
      *
@@ -33,27 +32,6 @@ class HeadTitle extends Placeholder\Container\AbstractStandalone implements
      */
     protected $defaultAttachOrder = null;
 
-    /**
-     * Translator (optional)
-     *
-     * @var Translator
-     */
-    protected $translator;
-
-    /**
-     * Translator text domain (optional)
-     *
-     * @var string
-     */
-    protected $translatorTextDomain = 'default';
-
-    /**
-     * Whether translator should be used
-     *
-     * @var bool
-     */
-    protected $translatorEnabled = true;
-
     /**
      * Retrieve placeholder for title element and optionally set state
      *
@@ -109,14 +87,9 @@ public function renderTitle()
     {
         $items = [];
 
-        if (null !== ($translator = $this->getTranslator())) {
-            foreach ($this as $item) {
-                $items[] = $translator->translate($item, $this->getTranslatorTextDomain());
-            }
-        } else {
-            foreach ($this as $item) {
-                $items[] = $item;
-            }
+        $itemCallback = $this->getTitleItemCallback();
+        foreach ($this as $item) {
+            $items[] = $itemCallback($item);
         }
 
         $separator = $this->getSeparator();
@@ -172,92 +145,28 @@ public function getDefaultAttachOrder()
         return $this->defaultAttachOrder;
     }
 
-    // Translator methods - Good candidate to refactor as a trait with PHP 5.4
 
     /**
-     * Sets translator to use in helper
+     * Create and return a callback for normalizing title items.
      *
-     * @param  Translator $translator  [optional] translator.
-     *                                 Default is null, which sets no translator.
-     * @param  string     $textDomain  [optional] text domain
-     *                                 Default is null, which skips setTranslatorTextDomain
-     * @return HeadTitle
-     */
-    public function setTranslator(Translator $translator = null, $textDomain = null)
-    {
-        $this->translator = $translator;
-        if (null !== $textDomain) {
-            $this->setTranslatorTextDomain($textDomain);
-        }
-        return $this;
-    }
-
-    /**
-     * Returns translator used in helper
+     * If translation is not enabled, or no translator is present, returns a
+     * callable that simply returns the provided item; otherwise, returns a
+     * callable that returns a translation of the provided item.
      *
-     * @return Translator|null
+     * @return callable
      */
-    public function getTranslator()
+    private function getTitleItemCallback()
     {
-        if (! $this->isTranslatorEnabled()) {
-            return;
+        if (! $this->isTranslatorEnabled() || ! $this->hasTranslator()) {
+            return function ($item) {
+                return $item;
+            };
         }
 
-        return $this->translator;
-    }
-
-    /**
-     * Checks if the helper has a translator
-     *
-     * @return bool
-     */
-    public function hasTranslator()
-    {
-        return (bool) $this->getTranslator();
-    }
-
-    /**
-     * Sets whether translator is enabled and should be used
-     *
-     * @param  bool $enabled [optional] whether translator should be used.
-     *                       Default is true.
-     * @return HeadTitle
-     */
-    public function setTranslatorEnabled($enabled = true)
-    {
-        $this->translatorEnabled = (bool) $enabled;
-        return $this;
-    }
-
-    /**
-     * Returns whether translator is enabled and should be used
-     *
-     * @return bool
-     */
-    public function isTranslatorEnabled()
-    {
-        return $this->translatorEnabled;
-    }
-
-    /**
-     * Set translation text domain
-     *
-     * @param  string $textDomain
-     * @return HeadTitle
-     */
-    public function setTranslatorTextDomain($textDomain = 'default')
-    {
-        $this->translatorTextDomain = $textDomain;
-        return $this;
-    }
-
-    /**
-     * Return the translation text domain
-     *
-     * @return string
-     */
-    public function getTranslatorTextDomain()
-    {
-        return $this->translatorTextDomain;
+        $translator = $this->getTranslator();
+        $textDomain = $this->getTranslatorTextDomain();
+        return function ($item) use ($translator, $textDomain) {
+            return $translator->translate($item, $textDomain);
+        };
     }
 }