Changeset 701 for trunk/lib

Timestamp:

Sep 3, 2019 7:35:42 AM (5 years ago)

Author:

anonymous

Message:

Add query-string-subkey-parsing to getFormData('foo[bar]')

File:

• trunk/lib/Utilities.inc.php (modified) (3 diffs)

trunk/lib/Utilities.inc.php

@@ -1053 +1053 @@
  * quotes if necessary.
  *
- * @param string $var (optional) The name of the form variable to look for.
+ * @param string $key (optional) The name of a $_REQUEST key.
  * @param string $default (optional) The value to return if the
  *                                   variable is not there.
- * @return mixed      A cleaned GET or POST if no $var specified.
- * @return string     A cleaned form $var if found, or $default.
- */
-function getFormData($var=null, $default=null)
+ * @return mixed      A cleaned GET or POST array if no key specified.
+ * @return string     A cleaned form value if found, or $default.
+ */
+function getFormData($key=null, $default=null)
 {
     $app =& App::getInstance();
 
-    if ('POST' == getenv('REQUEST_METHOD') && is_null($var)) {
+    if ('POST' == getenv('REQUEST_METHOD') && null === $key) {
         return dispelMagicQuotes($_POST, $app->getParam('always_dispel_magicquotes'));
-    } else if ('GET' == getenv('REQUEST_METHOD') && is_null($var)) {
+    } else if ('GET' == getenv('REQUEST_METHOD') && null === $key) {
         return dispelMagicQuotes($_GET, $app->getParam('always_dispel_magicquotes'));
     }
-    if (isset($_POST[$var])) {
-        return dispelMagicQuotes($_POST[$var], $app->getParam('always_dispel_magicquotes'));
-    } else if (isset($_GET[$var])) {
-        return dispelMagicQuotes($_GET[$var], $app->getParam('always_dispel_magicquotes'));
+
+    if (isset($_REQUEST[$key])) {
+        // $key is found in the flat array of REQUEST.
+        return dispelMagicQuotes($_REQUEST[$key], $app->getParam('always_dispel_magicquotes'));
+    } else if (mb_strpos($key, '[') !== false && isset($_REQUEST[strtok($key, '[')]) && preg_match_all('/\[([a-z0-9._~-]+)\]/', $key, $matches)) {
+        // $key is formatted with sub-keys, e.g., getFormData('foo[bar][baz]') and top level key (`foo`) exists in REQUEST.
+        // Extract these as sub-keys and access REQUEST as a multi-dimensional array, e.g., $_REQUEST[foo][bar][baz].
+        $leaf = $_REQUEST[strtok($key, '[')];
+        foreach ($matches[1] as $subkey) {
+            if (is_array($leaf) && isset($leaf[$subkey])) {
+                $leaf = $leaf[$subkey];
+            } else {
+                $leaf = null;
+            }
+        }
+        return $leaf;
     } else {
         return $default;
@@ -1077 +1089 @@
 }
 
-function getPost($var=null, $default=null)
+function getPost($key=null, $default=null)
 {
     $app =& App::getInstance();
 
-    if (is_null($var)) {
+    if (null === $key) {
         return dispelMagicQuotes($_POST, $app->getParam('always_dispel_magicquotes'));
     }
-    if (isset($_POST[$var])) {
-        return dispelMagicQuotes($_POST[$var], $app->getParam('always_dispel_magicquotes'));
+    if (isset($_POST[$key])) {
+        return dispelMagicQuotes($_POST[$key], $app->getParam('always_dispel_magicquotes'));
     } else {
         return $default;
@@ -1091 +1103 @@
 }
 
-function getGet($var=null, $default=null)
+function getGet($key=null, $default=null)
 {
     $app =& App::getInstance();
-    if (is_null($var)) {
+
+    if (null === $key) {
         return dispelMagicQuotes($_GET, $app->getParam('always_dispel_magicquotes'));
     }
-    if (isset($_GET[$var])) {
-        return dispelMagicQuotes($_GET[$var], $app->getParam('always_dispel_magicquotes'));
+    if (isset($_GET[$key])) {
+        return dispelMagicQuotes($_GET[$key], $app->getParam('always_dispel_magicquotes'));
     } else {
         return $default;