interface/modules/zend_modules/library/Zend/Mvc/ModuleRouteListener.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Mvc;
  11
  12 use Zend\EventManager\EventManagerInterface;
  13 use Zend\EventManager\ListenerAggregateInterface;
  14
  15 class ModuleRouteListener implements ListenerAggregateInterface
  16 {
  17     const MODULE_NAMESPACE    = '__NAMESPACE__';
  18     const ORIGINAL_CONTROLLER = '__CONTROLLER__';
  19
  20     /**
  21      * @var \Zend\Stdlib\CallbackHandler[]
  22      */
  23     protected $listeners = array();
  24
  25     /**
  26      * Attach to an event manager
  27      *
  28      * @param  EventManagerInterface $events
  29      * @param  int $priority
  30      */
  31     public function attach(EventManagerInterface $events, $priority = 1)
  32     {
  33         $this->listeners[] = $events->attach(MvcEvent::EVENT_ROUTE, array($this, 'onRoute'), $priority);
  34     }
  35
  36     /**
  37      * Detach all our listeners from the event manager
  38      *
  39      * @param  EventManagerInterface $events
  40      * @return void
  41      */
  42     public function detach(EventManagerInterface $events)
  43     {
  44         foreach ($this->listeners as $index => $listener) {
  45             if ($events->detach($listener)) {
  46                 unset($this->listeners[$index]);
  47             }
  48         }
  49     }
  50
  51     /**
  52      * Listen to the "route" event and determine if the module namespace should
  53      * be prepended to the controller name.
  54      *
  55      * If the route match contains a parameter key matching the MODULE_NAMESPACE
  56      * constant, that value will be prepended, with a namespace separator, to
  57      * the matched controller parameter.
  58      *
  59      * @param  MvcEvent $e
  60      * @return null
  61      */
  62     public function onRoute(MvcEvent $e)
  63     {
  64         $matches = $e->getRouteMatch();
  65         if (!$matches instanceof Router\RouteMatch) {
  66             // Can't do anything without a route match
  67             return;
  68         }
  69
  70         $module = $matches->getParam(self::MODULE_NAMESPACE, false);
  71         if (!$module) {
  72             // No module namespace found; nothing to do
  73             return;
  74         }
  75
  76         $controller = $matches->getParam('controller', false);
  77         if (!$controller) {
  78             // no controller matched, nothing to do
  79             return;
  80         }
  81
  82         // Ensure the module namespace has not already been applied
  83         if (0 === strpos($controller, $module)) {
  84             return;
  85         }
  86
  87         // Keep the originally matched controller name around
  88         $matches->setParam(self::ORIGINAL_CONTROLLER, $controller);
  89
  90         // Prepend the controllername with the module, and replace it in the
  91         // matches
  92         $controller = $module . '\\' . str_replace(' ', '', ucwords(str_replace('-', ' ', $controller)));
  93         $matches->setParam('controller', $controller);
  94     }
  95 }