tests/Zend/View/Helper/Navigation/MenuTest.php

   1 <?php
   2 require_once dirname(__FILE__) . '/TestAbstract.php';
   3 require_once 'Zend/View/Helper/Navigation/Menu.php';
   4
   5 /**
   6  * Tests Zend_View_Helper_Navigation_Menu
   7  *
   8  */
   9 class Zend_View_Helper_Navigation_MenuTest
  10     extends Zend_View_Helper_Navigation_TestAbstract
  11 {
  12     /**
  13      * Class name for view helper to test
  14      *
  15      * @var string
  16      */
  17     protected $_helperName = 'Zend_View_Helper_Navigation_Menu';
  18
  19     /**
  20      * View helper
  21      *
  22      * @var Zend_View_Helper_Navigation_Menu
  23      */
  24     protected $_helper;
  25
  26     public function testHelperEntryPointWithoutAnyParams()
  27     {
  28         $returned = $this->_helper->menu();
  29         $this->assertEquals($this->_helper, $returned);
  30         $this->assertEquals($this->_nav1, $returned->getContainer());
  31     }
  32
  33     public function testHelperEntryPointWithContainerParam()
  34     {
  35         $returned = $this->_helper->menu($this->_nav2);
  36         $this->assertEquals($this->_helper, $returned);
  37         $this->assertEquals($this->_nav2, $returned->getContainer());
  38     }
  39
  40     public function testNullingOutContainerInHelper()
  41     {
  42         $this->_helper->setContainer();
  43         $this->assertEquals(0, count($this->_helper->getContainer()));
  44     }
  45
  46     public function testAutoloadingContainerFromRegistry()
  47     {
  48         $oldReg = null;
  49         if (Zend_Registry::isRegistered(self::REGISTRY_KEY)) {
  50             $oldReg = Zend_Registry::get(self::REGISTRY_KEY);
  51         }
  52         Zend_Registry::set(self::REGISTRY_KEY, $this->_nav1);
  53
  54         $this->_helper->setContainer(null);
  55
  56         $expected = $this->_getExpected('menu/default1.html');
  57         $actual = $this->_helper->render();
  58
  59         Zend_Registry::set(self::REGISTRY_KEY, $oldReg);
  60
  61         $this->assertEquals($expected, $actual);
  62     }
  63
  64     public function testSetIndentAndOverrideInRenderMenu()
  65     {
  66         $this->_helper->setIndent(8);
  67
  68         $expected = array(
  69             'indent4' => $this->_getExpected('menu/indent4.html'),
  70             'indent8' => $this->_getExpected('menu/indent8.html')
  71         );
  72
  73         $renderOptions = array(
  74             'indent' => 4
  75         );
  76
  77         $actual = array(
  78             'indent4' => rtrim($this->_helper->renderMenu(null, $renderOptions), PHP_EOL),
  79             'indent8' => rtrim($this->_helper->renderMenu(), PHP_EOL)
  80         );
  81
  82         $this->assertEquals($expected, $actual);
  83     }
  84
  85     public function testRenderSuppliedContainerWithoutInterfering()
  86     {
  87         $rendered1 = $this->_getExpected('menu/default1.html');
  88         $rendered2 = $this->_getExpected('menu/default2.html');
  89         $expected = array(
  90             'registered'       => $rendered1,
  91             'supplied'         => $rendered2,
  92             'registered_again' => $rendered1
  93         );
  94
  95         $actual = array(
  96             'registered'       => $this->_helper->render(),
  97             'supplied'         => $this->_helper->render($this->_nav2),
  98             'registered_again' => $this->_helper->render()
  99         );
 100
 101         $this->assertEquals($expected, $actual);
 102     }
 103
 104     public function testUseAclRoleAsString()
 105     {
 106         $acl = $this->_getAcl();
 107         $this->_helper->setAcl($acl['acl']);
 108         $this->_helper->setRole('member');
 109
 110         $expected = $this->_getExpected('menu/acl_string.html');
 111         $this->assertEquals($expected, $this->_helper->render());
 112     }
 113
 114     public function testFilterOutPagesBasedOnAcl()
 115     {
 116         $acl = $this->_getAcl();
 117         $this->_helper->setAcl($acl['acl']);
 118         $this->_helper->setRole($acl['role']);
 119
 120         $expected = $this->_getExpected('menu/acl.html');
 121         $actual = $this->_helper->render();
 122
 123         $this->assertEquals($expected, $actual);
 124     }
 125
 126     public function testDisablingAcl()
 127     {
 128         $acl = $this->_getAcl();
 129         $this->_helper->setAcl($acl['acl']);
 130         $this->_helper->setRole($acl['role']);
 131         $this->_helper->setUseAcl(false);
 132
 133         $expected = $this->_getExpected('menu/default1.html');
 134         $actual = $this->_helper->render();
 135
 136         $this->assertEquals($expected, $actual);
 137     }
 138
 139     public function testUseAnAclRoleInstanceFromAclObject()
 140     {
 141         $acl = $this->_getAcl();
 142         $this->_helper->setAcl($acl['acl']);
 143         $this->_helper->setRole($acl['acl']->getRole('member'));
 144
 145         $expected = $this->_getExpected('menu/acl_role_interface.html');
 146         $this->assertEquals($expected, $this->_helper->render());
 147     }
 148
 149     public function testUseConstructedAclRolesNotFromAclObject()
 150     {
 151         $acl = $this->_getAcl();
 152         $this->_helper->setAcl($acl['acl']);
 153         $this->_helper->setRole(new Zend_Acl_Role('member'));
 154
 155         $expected = $this->_getExpected('menu/acl_role_interface.html');
 156         $this->assertEquals($expected, $this->_helper->render());
 157     }
 158
 159     public function testSetUlCssClass()
 160     {
 161         $this->_helper->setUlClass('My_Nav');
 162         $expected = $this->_getExpected('menu/css.html');
 163         $this->assertEquals($expected, $this->_helper->render($this->_nav2));
 164     }
 165
 166     public function testTranslationUsingZendTranslate()
 167     {
 168         $translator = $this->_getTranslator();
 169         $this->_helper->setTranslator($translator);
 170
 171         $expected = $this->_getExpected('menu/translated.html');
 172         $this->assertEquals($expected, $this->_helper->render());
 173     }
 174
 175     public function testTranslationUsingZendTranslateAdapter()
 176     {
 177         $translator = $this->_getTranslator();
 178         $this->_helper->setTranslator($translator->getAdapter());
 179
 180         $expected = $this->_getExpected('menu/translated.html');
 181         $this->assertEquals($expected, $this->_helper->render());
 182     }
 183
 184     public function testTranslationUsingTranslatorFromRegistry()
 185     {
 186         $oldReg = Zend_Registry::isRegistered('Zend_Translate')
 187                 ? Zend_Registry::get('Zend_Translate')
 188                 : null;
 189
 190         $translator = $this->_getTranslator();
 191         Zend_Registry::set('Zend_Translate', $translator);
 192
 193         $expected = $this->_getExpected('menu/translated.html');
 194         $actual = $this->_helper->render();
 195
 196         Zend_Registry::set('Zend_Translate', $oldReg);
 197
 198         $this->assertEquals($expected, $actual);
 199
 200     }
 201
 202     public function testDisablingTranslation()
 203     {
 204         $translator = $this->_getTranslator();
 205         $this->_helper->setTranslator($translator);
 206         $this->_helper->setUseTranslator(false);
 207
 208         $expected = $this->_getExpected('menu/default1.html');
 209         $this->assertEquals($expected, $this->_helper->render());
 210     }
 211
 212     public function testRenderingPartial()
 213     {
 214         $this->_helper->setPartial('menu.phtml');
 215
 216         $expected = $this->_getExpected('menu/partial.html');
 217         $actual = $this->_helper->render();
 218
 219         $this->assertEquals($expected, $actual);
 220     }
 221
 222     public function testRenderingPartialBySpecifyingAnArrayAsPartial()
 223     {
 224         $this->_helper->setPartial(array('menu.phtml', 'default'));
 225
 226         $expected = $this->_getExpected('menu/partial.html');
 227         $actual = $this->_helper->render();
 228
 229         $this->assertEquals($expected, $actual);
 230     }
 231
 232     public function testRenderingPartialShouldFailOnInvalidPartialArray()
 233     {
 234         $this->_helper->setPartial(array('menu.phtml'));
 235
 236         try {
 237             $this->_helper->render();
 238             $this->fail('invalid $partial should throw Zend_View_Exception');
 239         } catch (Zend_View_Exception $e) {
 240         }
 241     }
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251     public function testSetMaxDepth()
 252     {
 253         $this->_helper->setMaxDepth(1);
 254
 255         $expected = $this->_getExpected('menu/maxdepth.html');
 256         $actual = $this->_helper->renderMenu();
 257
 258         $this->assertEquals($expected, $actual);
 259     }
 260
 261     public function testSetMinDepth()
 262     {
 263         $this->_helper->setMinDepth(1);
 264
 265         $expected = $this->_getExpected('menu/mindepth.html');
 266         $actual = $this->_helper->renderMenu();
 267
 268         $this->assertEquals($expected, $actual);
 269     }
 270
 271     public function testSetBothDepts()
 272     {
 273         $this->_helper->setMinDepth(1)->setMaxDepth(2);
 274
 275         $expected = $this->_getExpected('menu/bothdepts.html');
 276         $actual = $this->_helper->renderMenu();
 277
 278         $this->assertEquals($expected, $actual);
 279     }
 280
 281     public function testSetOnlyActiveBranch()
 282     {
 283         $this->_helper->setOnlyActiveBranch(true);
 284
 285         $expected = $this->_getExpected('menu/onlyactivebranch.html');
 286         $actual = $this->_helper->renderMenu();
 287
 288         $this->assertEquals($expected, $actual);
 289     }
 290
 291     public function testSetRenderParents()
 292     {
 293         $this->_helper->setOnlyActiveBranch(true)->setRenderParents(false);
 294
 295         $expected = $this->_getExpected('menu/onlyactivebranch_noparents.html');
 296         $actual = $this->_helper->renderMenu();
 297
 298         $this->assertEquals($expected, $actual);
 299     }
 300
 301     public function testSetOnlyActiveBranchAndMinDepth()
 302     {
 303         $this->_helper->setOnlyActiveBranch()->setMinDepth(1);
 304
 305         $expected = $this->_getExpected('menu/onlyactivebranch_mindepth.html');
 306         $actual = $this->_helper->renderMenu();
 307
 308         $this->assertEquals($expected, $actual);
 309     }
 310
 311     public function testOnlyActiveBranchAndMaxDepth()
 312     {
 313         $this->_helper->setOnlyActiveBranch()->setMaxDepth(2);
 314
 315         $expected = $this->_getExpected('menu/onlyactivebranch_maxdepth.html');
 316         $actual = $this->_helper->renderMenu();
 317
 318         $this->assertEquals($expected, $actual);
 319     }
 320
 321     public function testOnlyActiveBranchAndBothDepthsSpecified()
 322     {
 323         $this->_helper->setOnlyActiveBranch()->setMinDepth(1)->setMaxDepth(2);
 324
 325         $expected = $this->_getExpected('menu/onlyactivebranch_bothdepts.html');
 326         $actual = $this->_helper->renderMenu();
 327
 328         $this->assertEquals($expected, $actual);
 329     }
 330
 331     public function testOnlyActiveBranchNoParentsAndBothDepthsSpecified()
 332     {
 333         $this->_helper->setOnlyActiveBranch()
 334                       ->setMinDepth(1)
 335                       ->setMaxDepth(2)
 336                       ->setRenderParents(false);
 337
 338         $expected = $this->_getExpected('menu/onlyactivebranch_np_bd.html');
 339         $actual = $this->_helper->renderMenu();
 340
 341         $this->assertEquals($expected, $actual);
 342     }
 343
 344     private function _setActive($label)
 345     {
 346         $container = $this->_helper->getContainer();
 347
 348         foreach ($container->findAllByActive(true) as $page) {
 349             $page->setActive(false);
 350         }
 351
 352         if ($p = $container->findOneByLabel($label)) {
 353             $p->setActive(true);
 354         }
 355     }
 356
 357     public function testOnlyActiveBranchNoParentsActiveOneBelowMinDepth()
 358     {
 359         $this->_setActive('Page 2');
 360
 361         $this->_helper->setOnlyActiveBranch()
 362                       ->setMinDepth(1)
 363                       ->setMaxDepth(1)
 364                       ->setRenderParents(false);
 365
 366         $expected = $this->_getExpected('menu/onlyactivebranch_np_bd2.html');
 367         $actual = $this->_helper->renderMenu();
 368
 369         $this->assertEquals($expected, $actual);
 370     }
 371
 372     public function testRenderSubMenuShouldOverrideOptions()
 373     {
 374         $this->_helper->setOnlyActiveBranch(false)
 375                       ->setMinDepth(1)
 376                       ->setMaxDepth(2)
 377                       ->setRenderParents(true);
 378
 379         $expected = $this->_getExpected('menu/onlyactivebranch_noparents.html');
 380         $actual = $this->_helper->renderSubMenu();
 381
 382         $this->assertEquals($expected, $actual);
 383     }
 384
 385     public function testOptionMaxDepth()
 386     {
 387         $options = array(
 388             'maxDepth' => 1
 389         );
 390
 391         $expected = $this->_getExpected('menu/maxdepth.html');
 392         $actual = $this->_helper->renderMenu(null, $options);
 393
 394         $this->assertEquals($expected, $actual);
 395     }
 396
 397     public function testOptionMinDepth()
 398     {
 399         $options = array(
 400             'minDepth' => 1
 401         );
 402
 403         $expected = $this->_getExpected('menu/mindepth.html');
 404         $actual = $this->_helper->renderMenu(null, $options);
 405
 406         $this->assertEquals($expected, $actual);
 407     }
 408
 409     public function testOptionBothDepts()
 410     {
 411         $options = array(
 412             'minDepth' => 1,
 413             'maxDepth' => 2
 414         );
 415
 416         $expected = $this->_getExpected('menu/bothdepts.html');
 417         $actual = $this->_helper->renderMenu(null, $options);
 418
 419         $this->assertEquals($expected, $actual);
 420     }
 421
 422     public function testOptionOnlyActiveBranch()
 423     {
 424         $options = array(
 425             'onlyActiveBranch' => true
 426         );
 427
 428         $expected = $this->_getExpected('menu/onlyactivebranch.html');
 429         $actual = $this->_helper->renderMenu(null, $options);
 430
 431         $this->assertEquals($expected, $actual);
 432     }
 433
 434     public function testOptionOnlyActiveBranchNoParents()
 435     {
 436         $options = array(
 437             'onlyActiveBranch' => true,
 438             'renderParents' => false
 439         );
 440
 441         $expected = $this->_getExpected('menu/onlyactivebranch_noparents.html');
 442         $actual = $this->_helper->renderMenu(null, $options);
 443
 444         $this->assertEquals($expected, $actual);
 445     }
 446
 447     public function testOptionOnlyActiveBranchAndMinDepth()
 448     {
 449         $options = array(
 450             'minDepth' => 1,
 451             'onlyActiveBranch' => true
 452         );
 453
 454         $expected = $this->_getExpected('menu/onlyactivebranch_mindepth.html');
 455         $actual = $this->_helper->renderMenu(null, $options);
 456
 457         $this->assertEquals($expected, $actual);
 458     }
 459
 460     public function testOptionOnlyActiveBranchAndMaxDepth()
 461     {
 462         $options = array(
 463             'maxDepth' => 2,
 464             'onlyActiveBranch' => true
 465         );
 466
 467         $expected = $this->_getExpected('menu/onlyactivebranch_maxdepth.html');
 468         $actual = $this->_helper->renderMenu(null, $options);
 469
 470         $this->assertEquals($expected, $actual);
 471     }
 472
 473     public function testOptionOnlyActiveBranchAndBothDepthsSpecified()
 474     {
 475         $options = array(
 476             'minDepth' => 1,
 477             'maxDepth' => 2,
 478             'onlyActiveBranch' => true
 479         );
 480
 481         $expected = $this->_getExpected('menu/onlyactivebranch_bothdepts.html');
 482         $actual = $this->_helper->renderMenu(null, $options);
 483
 484         $this->assertEquals($expected, $actual);
 485     }
 486
 487     public function testOptionOnlyActiveBranchNoParentsAndBothDepthsSpecified()
 488     {
 489         $options = array(
 490             'minDepth' => 2,
 491             'maxDepth' => 2,
 492             'onlyActiveBranch' => true,
 493             'renderParents' => false
 494         );
 495
 496         $expected = $this->_getExpected('menu/onlyactivebranch_np_bd.html');
 497         $actual = $this->_helper->renderMenu(null, $options);
 498
 499         $this->assertEquals($expected, $actual);
 500     }
 501 }