interface/modules/zend_modules/library/Zend/Mvc/Router/Http/Query.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\Router\Http;
  11
  12 use Traversable;
  13 use Zend\Mvc\Router\Exception;
  14 use Zend\Mvc\Router\Http\RouteMatch;
  15 use Zend\Stdlib\ArrayUtils;
  16 use Zend\Stdlib\RequestInterface as Request;
  17
  18 /**
  19  * Query route.
  20  *
  21  * @deprecated
  22  */
  23 class Query implements RouteInterface
  24 {
  25     /**
  26      * Default values.
  27      *
  28      * @var array
  29      */
  30     protected $defaults;
  31
  32     /**
  33      * List of assembled parameters.
  34      *
  35      * @var array
  36      */
  37     protected $assembledParams = array();
  38
  39     /**
  40      * Create a new wildcard route.
  41      *
  42      * @param array $defaults
  43      */
  44     public function __construct(array $defaults = array())
  45     {
  46         /**
  47          * Legacy purposes only, to prevent code that uses it from breaking.
  48          */
  49         trigger_error('Query route deprecated as of ZF 2.1.4; use the "query" option of the HTTP router\'s assembling method instead', E_USER_DEPRECATED);
  50         $this->defaults = $defaults;
  51     }
  52
  53     /**
  54      * factory(): defined by RouteInterface interface.
  55      *
  56      * @see    \Zend\Mvc\Router\RouteInterface::factory()
  57      * @param  array|Traversable $options
  58      * @return Query
  59      * @throws Exception\InvalidArgumentException
  60      */
  61     public static function factory($options = array())
  62     {
  63         if ($options instanceof Traversable) {
  64             $options = ArrayUtils::iteratorToArray($options);
  65         } elseif (!is_array($options)) {
  66             throw new Exception\InvalidArgumentException(__METHOD__ . ' expects an array or Traversable set of options');
  67         }
  68
  69         if (!isset($options['defaults'])) {
  70             $options['defaults'] = array();
  71         }
  72
  73         return new static($options['defaults']);
  74     }
  75
  76     /**
  77      * match(): defined by RouteInterface interface.
  78      *
  79      * @see    \Zend\Mvc\Router\RouteInterface::match()
  80      * @param  Request $request
  81      * @return RouteMatch
  82      */
  83     public function match(Request $request)
  84     {
  85         // We don't merge the query parameters into the rotue match here because
  86         // of possible security problems. Use the Query object instead which is
  87         // included in the Request object.
  88         return new RouteMatch($this->defaults);
  89     }
  90
  91     /**
  92      * Recursively urldecodes keys and values from an array
  93      *
  94      * @param  array $array
  95      * @return array
  96      */
  97     protected function recursiveUrldecode(array $array)
  98     {
  99         $matches = array();
 100
 101         foreach ($array as $key => $value) {
 102             if (is_array($value)) {
 103                 $matches[urldecode($key)] = $this->recursiveUrldecode($value);
 104             } else {
 105                 $matches[urldecode($key)] = urldecode($value);
 106             }
 107         }
 108
 109         return $matches;
 110     }
 111
 112     /**
 113      * assemble(): Defined by RouteInterface interface.
 114      *
 115      * @see    \Zend\Mvc\Router\RouteInterface::assemble()
 116      * @param  array $params
 117      * @param  array $options
 118      * @return mixed
 119      */
 120     public function assemble(array $params = array(), array $options = array())
 121     {
 122         $mergedParams          = array_merge($this->defaults, $params);
 123         $this->assembledParams = array();
 124
 125         if (isset($options['uri']) && count($mergedParams)) {
 126             foreach ($mergedParams as $key => $value) {
 127                 $this->assembledParams[] = $key;
 128             }
 129
 130             $options['uri']->setQuery($mergedParams);
 131         }
 132
 133         // A query does not contribute to the path, thus nothing is returned.
 134         return '';
 135     }
 136
 137     /**
 138      * getAssembledParams(): defined by RouteInterface interface.
 139      *
 140      * @see    RouteInterface::getAssembledParams
 141      * @return array
 142      */
 143     public function getAssembledParams()
 144     {
 145         return $this->assembledParams;
 146     }
 147 }