3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * class for managing a http request
40 class CRM_Utils_Request
{
43 * We only need one instance of this object. So we use the singleton
44 * pattern and cache the instance in this variable
49 static private $_singleton = NULL;
54 public function __construct() {}
57 * Retrieve a value from the request (GET/POST/REQUEST)
59 * @param string $name name of the variable to be retrieved
60 * @param string $type type of the variable (see CRM_Utils_Type for details)
61 * @param object $store session scope where variable is stored
62 * @param bool $abort is this variable required
63 * @param mixed $default default value of the variable if not present
64 * @param string $method where should we look for the variable
66 * @return mixed the value of the variable
69 public static function retrieve($name, $type, &$store = NULL, $abort = FALSE, $default = NULL, $method = 'REQUEST') {
71 // hack to detect stuff not yet converted to new style
72 if (!is_string($type)) {
73 CRM_Core_Error
::backtrace();
74 CRM_Core_Error
::fatal(ts("Please convert retrieve call to use new function signature"));
80 $value = CRM_Utils_Array
::value($name, $_GET);
84 $value = CRM_Utils_Array
::value($name, $_POST);
88 $value = CRM_Utils_Array
::value($name, $_REQUEST);
93 (CRM_Utils_Type
::validate($value, $type, $abort, $name) === NULL)
98 if (!isset($value) && $store) {
99 $value = $store->get($name);
102 if (!isset($value) && $abort) {
103 CRM_Core_Error
::fatal(ts("Could not find valid value for %1", array(1 => $name)));
106 if (!isset($value) && $default) {
110 // minor hack for action
111 if ($name == 'action' && is_string($value)) {
112 $value = CRM_Core_Action
::resolve($value);
115 if (isset($value) && $store) {
116 $store->set($name, $value);
123 * This is a replacement for $_REQUEST which includes $_GET/$_POST
124 * but excludes $_COOKIE / $_ENV / $_SERVER.
128 public static function exportValues() {
129 // For more discussion of default $_REQUEST handling, see:
130 // http://www.php.net/manual/en/reserved.variables.request.php
131 // http://www.php.net/manual/en/ini.core.php#ini.request-order
132 // http://www.php.net/manual/en/ini.core.php#ini.variables-order
136 $result = array_merge($result, $_GET);
139 $result = array_merge($result, $_POST);