interface/modules/zend_modules/library/Zend/Mvc/Controller/Plugin/Params.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\Controller\Plugin;
  11
  12 use Zend\Mvc\Controller\Plugin\AbstractPlugin;
  13 use Zend\Mvc\Exception\RuntimeException;
  14 use Zend\Mvc\InjectApplicationEventInterface;
  15
  16 class Params extends AbstractPlugin
  17 {
  18     /**
  19      * Grabs a param from route match by default.
  20      *
  21      * @param string $param
  22      * @param mixed $default
  23      * @return mixed
  24      */
  25     public function __invoke($param = null, $default = null)
  26     {
  27         if ($param === null) {
  28             return $this;
  29         }
  30         return $this->fromRoute($param, $default);
  31     }
  32
  33     /**
  34      * Return all files or a single file.
  35      *
  36      * @param  string $name File name to retrieve, or null to get all.
  37      * @param  mixed $default Default value to use when the file is missing.
  38      * @return array|\ArrayAccess|null
  39      */
  40     public function fromFiles($name = null, $default = null)
  41     {
  42         if ($name === null) {
  43             return $this->getController()->getRequest()->getFiles($name, $default)->toArray();
  44         }
  45
  46         return $this->getController()->getRequest()->getFiles($name, $default);
  47     }
  48
  49     /**
  50      * Return all header parameters or a single header parameter.
  51      *
  52      * @param  string $header Header name to retrieve, or null to get all.
  53      * @param  mixed $default Default value to use when the requested header is missing.
  54      * @return null|\Zend\Http\Header\HeaderInterface
  55      */
  56     public function fromHeader($header = null, $default = null)
  57     {
  58         if ($header === null) {
  59             return $this->getController()->getRequest()->getHeaders($header, $default)->toArray();
  60         }
  61
  62         return $this->getController()->getRequest()->getHeaders($header, $default);
  63     }
  64
  65     /**
  66      * Return all post parameters or a single post parameter.
  67      *
  68      * @param string $param Parameter name to retrieve, or null to get all.
  69      * @param mixed $default Default value to use when the parameter is missing.
  70      * @return mixed
  71      */
  72     public function fromPost($param = null, $default = null)
  73     {
  74         if ($param === null) {
  75             return $this->getController()->getRequest()->getPost($param, $default)->toArray();
  76         }
  77
  78         return $this->getController()->getRequest()->getPost($param, $default);
  79     }
  80
  81     /**
  82      * Return all query parameters or a single query parameter.
  83      *
  84      * @param string $param Parameter name to retrieve, or null to get all.
  85      * @param mixed $default Default value to use when the parameter is missing.
  86      * @return mixed
  87      */
  88     public function fromQuery($param = null, $default = null)
  89     {
  90         if ($param === null) {
  91             return $this->getController()->getRequest()->getQuery($param, $default)->toArray();
  92         }
  93
  94         return $this->getController()->getRequest()->getQuery($param, $default);
  95     }
  96
  97     /**
  98      * Return all route parameters or a single route parameter.
  99      *
 100      * @param string $param Parameter name to retrieve, or null to get all.
 101      * @param mixed $default Default value to use when the parameter is missing.
 102      * @return mixed
 103      * @throws RuntimeException
 104      */
 105     public function fromRoute($param = null, $default = null)
 106     {
 107         $controller = $this->getController();
 108
 109         if (!$controller instanceof InjectApplicationEventInterface) {
 110             throw new RuntimeException(
 111                 'Controllers must implement Zend\Mvc\InjectApplicationEventInterface to use this plugin.'
 112             );
 113         }
 114
 115         if ($param === null) {
 116             return $controller->getEvent()->getRouteMatch()->getParams();
 117         }
 118
 119         return $controller->getEvent()->getRouteMatch()->getParam($param, $default);
 120     }
 121 }