3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
37 * class for managing a http request
40 class CRM_Utils_Request
{
43 * Retrieve a value from the request (GET/POST/REQUEST)
46 * Name of the variable to be retrieved.
48 * Type of the variable (see CRM_Utils_Type for details).
49 * @param object $store
50 * Session scope where variable is stored.
52 * TRUE, if the variable is required.
53 * @param mixed $default
54 * Default value of the variable if not present.
55 * @param string $method
56 * Where to look for the variable - 'GET', 'POST' or 'REQUEST'.
59 * The value of the variable
61 public static function retrieve($name, $type, &$store = NULL, $abort = FALSE, $default = NULL, $method = 'REQUEST') {
63 // hack to detect stuff not yet converted to new style
64 if (!is_string($type)) {
65 CRM_Core_Error
::backtrace();
66 CRM_Core_Error
::fatal(ts("Please convert retrieve call to use new function signature"));
72 $value = CRM_Utils_Array
::value($name, $_GET);
76 $value = CRM_Utils_Array
::value($name, $_POST);
80 $value = CRM_Utils_Array
::value($name, $_REQUEST);
85 (CRM_Utils_Type
::validate($value, $type, $abort, $name) === NULL)
90 if (!isset($value) && $store) {
91 $value = $store->get($name);
94 if (!isset($value) && $abort) {
95 CRM_Core_Error
::fatal(ts("Could not find valid value for %1", array(1 => $name)));
98 if (!isset($value) && $default) {
102 // minor hack for action
103 if ($name == 'action' && is_string($value)) {
104 $value = CRM_Core_Action
::resolve($value);
107 if (isset($value) && $store) {
108 $store->set($name, $value);
115 * This is a replacement for $_REQUEST which includes $_GET/$_POST
116 * but excludes $_COOKIE / $_ENV / $_SERVER.
120 public static function exportValues() {
121 // For more discussion of default $_REQUEST handling, see:
122 // http://www.php.net/manual/en/reserved.variables.request.php
123 // http://www.php.net/manual/en/ini.core.php#ini.request-order
124 // http://www.php.net/manual/en/ini.core.php#ini.variables-order
128 $result = array_merge($result, $_GET);
131 $result = array_merge($result, $_POST);