Merge branch

zendframework · Oct 31, 2013 · e75fb63 · e75fb63
commit e75fb63
Show file tree

Hide file tree

Showing 15 changed files with 147 additions and 105 deletions.
diff --git a/src/AbstractContainer.php b/src/AbstractContainer.php
@@ -93,7 +93,7 @@ public function notifyOrderUpdated()
      * calling {@link Page\AbstractPage::setParent()}.
      *
      * @param  Page\AbstractPage|array|Traversable $page  page to add
-     * @return AbstractContainer fluent interface, returns self
+     * @return self fluent interface, returns self
      * @throws Exception\InvalidArgumentException if page is invalid
      */
     public function addPage($page)
@@ -136,7 +136,7 @@ public function addPage($page)
      * Adds several pages at once
      *
      * @param  array|Traversable|AbstractContainer $pages pages to add
-     * @return AbstractContainer fluent interface, returns self
+     * @return self fluent interface, returns self
      * @throws Exception\InvalidArgumentException if $pages is not array,
      *                                            Traversable or AbstractContainer
      */
@@ -172,7 +172,7 @@ public function addPages($pages)
      * Sets pages this container should have, removing existing pages
      *
      * @param  array $pages pages to set
-     * @return AbstractContainer fluent interface, returns self
+     * @return self fluent interface, returns self
      */
     public function setPages(array $pages)
     {
@@ -223,7 +223,7 @@ public function removePage($page)
     /**
      * Removes all pages in container
      *
-     * @return AbstractContainer fluent interface, returns self
+     * @return self fluent interface, returns self
      */
     public function removePages()
     {

diff --git a/src/Page/AbstractPage.php b/src/Page/AbstractPage.php
@@ -115,6 +115,13 @@ abstract class AbstractPage extends AbstractContainer
      */
     protected $permission;
 
+    /**
+     * Text domain for Translator
+     *
+     * @var string
+     */
+    protected $textDomain;
+
     /**
      * Whether this page should be considered active
      *
@@ -143,6 +150,13 @@ abstract class AbstractPage extends AbstractContainer
      */
     protected $properties = array();
 
+    /**
+     * Static factories list for factory pages
+     *
+     * @var array
+     */
+    protected static $factories = array();
+
     // Initialization:
 
     /**
@@ -220,6 +234,14 @@ public static function factory($options)
             }
         }
 
+        if (static::$factories) {
+            foreach (static::$factories as $factoryCallBack) {
+                if (($page = call_user_func($factoryCallBack, $options))) {
+                    return $page;
+                }
+            }
+        }
+
         $hasUri = isset($options['uri']);
         $hasMvc = isset($options['action']) || isset($options['controller'])
                 || isset($options['route']);
@@ -235,6 +257,16 @@ public static function factory($options)
         }
     }
 
+    /**
+     * Add static factory for self::factory function
+     *
+     * @param type $callback Any callable variable
+     */
+    public static function addFactory($callback)
+    {
+        static::$factories[] = $callback;
+    }
+
     /**
      * Page constructor
      *
@@ -732,6 +764,33 @@ public function getPermission()
         return $this->permission;
     }
 
+    /**
+     * Sets text domain for translation
+     *
+     * @param  string|null $textDomain  [optional] text domain to associate
+     *                                  with this page. Default is null, which
+     *                                  sets no text domain.
+     *
+     * @return AbstractPage fluent interface, returns self
+     */
+    public function setTextDomain($textDomain = null)
+    {
+        if (null !== $textDomain) {
+            $this->textDomain = $textDomain;
+        }
+        return $this;
+    }
+
+    /**
+     * Returns text domain for translation
+     *
+     * @return mixed|null  text domain or null
+     */
+    public function getTextDomain()
+    {
+        return $this->textDomain;
+    }
+
     /**
      * Sets whether page should be considered active or not
      *

diff --git a/src/Page/Mvc.php b/src/Page/Mvc.php
@@ -97,7 +97,14 @@ class Mvc extends AbstractPage
      *
      * @var RouteStackInterface
      */
-    protected static $defaultRouter= null;
+    protected static $defaultRouter = null;
+
+    /**
+     * Default route name
+     *
+     * @var string
+     */
+    protected static $defaultRoute = null;
 
     // Accessors:
 
@@ -228,8 +235,8 @@ public function getHref()
         }
 
         switch (true) {
-            case ($this->getRoute() !== null):
-                $name = $this->getRoute();
+            case ($this->getRoute() !== null || static::getDefaultRoute() !== null):
+                $name = ($this->getRoute() !== null) ? $this->getRoute() : static::getDefaultRoute();
                 break;
             case ($this->getRouteMatch() !== null):
                 $name = $this->getRouteMatch()->getMatchedRouteName();
@@ -359,13 +366,7 @@ public function getQuery()
      */
     public function setParams(array $params = null)
     {
-        if (null === $params) {
-            $this->params = array();
-        } else {
-            // TODO: do this more intelligently?
-            $this->params = $params;
-        }
-
+        $this->params = empty($params) ? array() : $params;
         $this->hrefCache = null;
         return $this;
     }
@@ -508,6 +509,27 @@ public static function getDefaultRouter()
         return static::$defaultRouter;
     }
 
+    /**
+     * Set default route name
+     *
+     * @param string $route
+     * @return void
+     */
+    public static function setDefaultRoute($route)
+    {
+        static::$defaultRoute = $route;
+    }
+
+    /**
+     * Get default route name
+     *
+     * @return string
+     */
+    public static function getDefaultRoute()
+    {
+        return static::$defaultRoute;
+    }
+
     // Public methods:
 
     /**

diff --git a/test/ContainerTest.php b/test/ContainerTest.php
@@ -5,7 +5,6 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Navigation
  */
 
 namespace ZendTest\Navigation;
@@ -17,9 +16,6 @@
 /**
  * Tests the class Zend_Navigation_Container
  *
- * @category   Zend
- * @package    Zend_Navigation
- * @subpackage UnitTests
  * @group      Zend_Navigation
  */
 class ContainerTest extends \PHPUnit_Framework_TestCase
@@ -799,7 +795,7 @@ public function testFindOneByShouldReturnNullIfNotFound()
     {
         $nav = $this->_getFindByNavigation();
 
-        $found = $nav->findOneBy('id', 'non-existant');
+        $found = $nav->findOneBy('id', 'non-existent');
         $this->assertNull($found);
     }
 
@@ -823,7 +819,7 @@ public function testFindAllByShouldReturnAllMatchingPages()
     public function testFindAllByShouldReturnEmptyArrayifNotFound()
     {
         $nav = $this->_getFindByNavigation();
-        $found = $nav->findAllBy('id', 'non-existant');
+        $found = $nav->findAllBy('id', 'non-existent');
 
         $expected = array('type' => 'array', 'count' => 0);
         $actual = array('type' => gettype($found), 'count' => count($found));

diff --git a/test/NavigationTest.php b/test/NavigationTest.php
@@ -5,7 +5,6 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Navigation
  */
 
 namespace ZendTest\Navigation;
@@ -17,9 +16,6 @@
  */
 
 /**
- * @category   Zend
- * @package    Zend_Navigation
- * @subpackage UnitTests
  * @group      Zend_Navigation
  */
 class NavigationTest extends \PHPUnit_Framework_TestCase

diff --git a/test/Page/MvcTest.php b/test/Page/MvcTest.php
@@ -5,7 +5,6 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Navigation
  */
 
 namespace ZendTest\Navigation\Page;
@@ -25,9 +24,6 @@
 /**
  * Tests the class Zend_Navigation_Page_Mvc
  *
- * @category   Zend
- * @package    Zend_Navigation
- * @subpackage UnitTests
  * @group      Zend_Navigation
  */
 class MvcTest extends TestCase
@@ -53,6 +49,21 @@ protected function tearDown()
     {
     }
 
+    public function testHrefGeneratedByRouterWithDefaultRoute()
+    {
+        $page = new Page\Mvc(array(
+            'label'      => 'foo',
+            'action'     => 'index',
+            'controller' => 'index'
+        ));
+        Page\Mvc::setDefaultRoute('default');
+        $page->setRouter($this->router);
+        $page->setAction('view');
+        $page->setController('news');
+
+        $this->assertEquals('/news/view', $page->getHref());
+    }
+
     public function testHrefGeneratedByRouterRequiresNoRoute()
     {
         $page = new Page\Mvc(array(

diff --git a/test/Page/PageFactoryTest.php b/test/Page/PageFactoryTest.php
@@ -5,7 +5,6 @@
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
- * @package   Zend_Navigation
  */
 
 namespace ZendTest\Navigation;
@@ -16,15 +15,31 @@
 /**
  * Tests Zend_Navigation_Page::factory()
  *
-/**
- * @category   Zend
- * @package    Zend_Navigation
- * @subpackage UnitTests
  * @group      Zend_Navigation
  */
 class PageFactoryTest extends \PHPUnit_Framework_TestCase
 {
 
+    public function testDetectFactoryPage()
+    {
+        AbstractPage::addFactory(function ($page) {
+            if (isset($page['factory_uri'])) {
+                return new \Zend\Navigation\Page\Uri($page);
+            } elseif (isset($page['factory_mvc'])) {
+                return new \Zend\Navigation\Page\Mvc($page);
+            }
+        });
+
+        $this->assertInstanceOf('Zend\\Navigation\\Page\\Uri', AbstractPage::factory(array(
+            'label' => 'URI Page',
+            'factory_uri' => '#'
+        )));
+
+        $this->assertInstanceOf('Zend\\Navigation\\Page\\Mvc', AbstractPage::factory(array(
+            'label' => 'URI Page',
+            'factory_mvc' => '#'
+        )));
+    }
 
     public function testDetectMvcPage()
     {
@@ -118,8 +133,8 @@ public function testShouldFailForInvalidType()
     public function testShouldFailForNonExistantType()
     {
         $pageConfig = array(
-            'type' => 'My_NonExistant_Page',
-            'label' => 'My non-existant Page'
+            'type' => 'My_NonExistent_Page',
+            'label' => 'My non-existent Page'
         );
 
         try {
@@ -128,7 +143,7 @@ public function testShouldFailForNonExistantType()
             return;
         }
 
-        $msg = 'An exception has not been thrown for non-existant class';
+        $msg = 'An exception has not been thrown for non-existent class';
         $this->fail($msg);
     }