Ticket #22325: GPCS-2.php

<?php
/**
 * Proposal for GPCS variables
 *
 * @see: http://core.trac.wordpress.org/ticket/22325
 *
 * @author Mike Schinkel <mike@newclarity.net>
 */

/**
 * Retrieves value of $_GET[$key]
 *
 * @example
 *
 *   For URL http://example.com?test=50:
 *   Retrieve value with: _GET( 'test', 25 ) with a default value of 25
 *
 * @param string $key
 * @param mixed $default
 *
 * @return null|mixed Defaults to null if $key not in $_GET.
 */
function _GET( $key, $default = null ) {
  if ( WP_DEBUG && is_array( $key ) )
    trigger_error( sprintf( __( '_GET() does not support array keys.' ) ), E_USER_WARNING );

  return WP_GPCS::access( 'GET', $key, $default );
}

/**
 * Retrieves value of $_POST[$key]
 *
 * Note: See $key can be an array, see example:
 *
 * @example
 *
 *   For HTML <input type="text" name="test" /> w/default value of 25:
 *   Retrieve value with: _POST( 'test', 25 )
 *
 *   For HTML <input type="text" name="test[abc][123][xyz]" />
 *   Retrieve value with: _POST( array( 'test', 'abc','123','xyz' ) )
 *
 * @param string|array $key
 * @param mixed $default
 *
 * @return null|mixed
 */
function _POST( $key, $default = null ) {
  return WP_GPCS::access( 'POST', $key, $default );
}

/**
 * Retrieves value of $_REQUEST[$key]
 *
 * Note: See $key can be an array, see example:
 *
 * @example
 *
 *   For HTML <input type="text" name="test" /> w/default value of 25:
 *   Retrieve value with: _REQUEST( 'test', 25 )
 *
 *   For HTML <input type="text" name="test[abc][123][xyz]" />
 *   Retrieve value with: _REQUEST( array( 'test', 'abc','123','xyz' ) )
 *
 * @param string|array $key
 * @param mixed $default
 *
 * @return null|mixed
 */
function _REQUEST( $key, $default = null ) {
  return WP_GPCS::access( 'REQUEST', $key, $default );
}

/**
 * Tests for existance of $key as an array element in $_GET, or if count($_GET)>0 when $key is null.
 *
 * @param null|string|array $key Key value
 *
 * @return bool
 */
function has_GET( $key = null ) {
  return WP_GPCS::has( 'GET', $key );
}
/**
 * Tests for existance of $key as an array element in $_POST, or if count($_POST)>0 when $key is null.
 *
 * @param null|string|array $key Key value
 *
 * @return bool
 */
function has_POST( $key = null ) {
  return WP_GPCS::has( 'POST', $key );
}
/**
 * Tests for existance of $key as an array element in $_REQUEST, or if count($_REQUEST)>0 when $key is null.
 *
 * @param null|string|array $key Key value
 *
 * @return bool
 */
function has_REQUEST( $key = null ) {
  return WP_GPCS::has( 'REQUEST', $key );
}

/**
 * Sets a new value for $key in $_GET.
 *
 * @param string|array $key
 * @param mixed $value
 */
function set_GET( $key, $value ) {
  WP_GPCS::set( 'GET', $key, $value );
}
/**
 * Sets a new value for $key in $_POST.
 *
 * @param string|array $key Key value
 * @param mixed $value
 */
function set_POST( $key, $value ) {
  WP_GPCS::set( 'POST', $key, $value );
}
/**
 * Sets a new value for $key in $_REQUEST.
 *
 * @param string|array $key Key value
 * @param mixed $value
 */
function set_REQUEST( $key, $value ) {
  WP_GPCS::set( 'REQUEST', $key, $value );
}


/**
 * Helper class to manage Global variable access.
 */
class WP_GPCS {
  private static $_vars;
  static function on_load() {
    self::$_vars = array(
      'GET'     => $_GET,
      'POST'    => $_POST,
      'REQUEST' => $_REQUEST,
    );
  }
  /**
   * Helper function to support accessing $_GET, $_POST and $_REQUEST
   *
   * Retrieves value of $_POST[$key], $_GET[$key] or $_REQUEST[$key]
   *
   * Note: $key can be an array, see example:
   *
   * @example
   *
   *   For HTML <input type="text" name="test" /> w/default value of 25:
   *   Retrieve value with: WP_GPCS::access( $_POST, 'POST', 'test', 25 )
   *
   *   For HTML <input type="text" name="test[abc][123][xyz]" />
   *   Retrieve value with: WP_GPCS::access( $_POST, 'POST', array( 'test', 'abc','123','xyz' ) )
   *
   * @param string $type Pass in 'POST', 'GET' or 'REQUEST'
   * @param mixed $key Key value, may be array
   * @param null $default
   *
   * @return null
   */
  static function access( $type, $key, $default = null ) {
    if ( ( is_string( $key ) || is_numeric( $key ) ) ) {
      return isset( self::$_vars[$type][$key] ) ? self::$_vars[$type][$key] : $default;
    } else if ( is_array( $key ) ) {
      $value = self::$_vars[$type];
      foreach( $key as $subkey ) {
        if ( isset( $value[$subkey] ) ) {
          $value = $value[$subkey];
        } else {
          return $default;
        }
      }
      return $value;
    } else if ( WP_DEBUG ){
      trigger_error( sprintf( __( 'The key [%s] passed to _%s() is not a string, numeric or array.' ), $key, $type ), E_USER_WARNING );
    }
    return $default;
  }
  /**
   * Helper function to test for existance of $key as an array element in $_POST, $_GET or $_REQUEST
   *
   * @param string $type Pass in 'POST', 'GET' or 'REQUEST'
   * @param null|string|array $key Key value, may be array
   *
   * @return bool
   */
  static function has( $type, $key = null ) {
    if ( is_null( $key ) ) {
      return 0 < count( self::$_vars[$type] );
    } else if ( ( is_string( $key ) || is_numeric( $key ) ) && isset( self::$_vars[$key] ) ) {
      return true;
    } else if ( is_array( $key ) ) {
      $value = self::$_vars[$type];
      foreach( $key as $subkey ) {
        if ( ! isset( $value[$subkey] ) ) {
          return false;
        }
      }
      return true;
    }
    return false;
  }


  /**
   * Helper function to set a new value for $key in $_POST, $_GET or $_REQUEST
   *
   * @param string $type Pass in 'POST', 'GET' or 'REQUEST'
   * @param string|array $key Key value, may be array
   * @param mixed $value
   */
  static function set( $type, $key, $value ) {
    if ( ( is_string( $key ) || is_numeric( $key ) ) ) {
      self::$_vars[$type][$key] = $value;
    } else if ( is_array( $key ) ) {
      $old_value = &self::$_vars[$type];
      foreach( $key as $index => $subkey ) {
        $old_value[$subkey] = null;
        $old_value = &$old_value[$subkey];
      }
      $old_value = $value;
    } else if ( WP_DEBUG ){
      trigger_error( sprintf( __( 'The key [%s] passed to set_%s() is not a string, numeric or array.' ), $key, $type ), E_USER_WARNING );
    }
  }
}
WP_GPCS::on_load();


// TEST CODE FOLLOWS.
// TODO: DELETE IF INCLUDED INTO WORDPRESS CORE.
?>
<form method="post" action="?foo=123&bar=abc">
  <input type="text" name="test[abc][123][xyz]" value="100" />
  <input type="submit" value="Go!" />
</form>
<?php

include 'wp-load.php';

echo "\n<pre>\n";

if ( has_POST() ) {
  echo "\n----------\n";
  echo '$_POST["test"]: ';
  print_r( _POST('test') );
  echo "\n----------\n";
  echo '$_POST["test"]["abc"]["123"]: ';
  print_r( _POST( array( 'test','abc','123' ) ) );
  echo "\n----------\n";
  echo '$_POST["test"][abc][123][xyz]: ' . _POST( array( 'test', 'abc','123','xyz' ) );
  echo "\n----[This from Cache]------\n";
  echo '$_POST["test"][abc][123][xyz]: ' . _POST( array( 'test', 'abc','123','xyz' ) );
  set_POST( 'test', 123456 );
  echo "\n---[After set(number)]-------\n";
  print_r( _POST('test') );
  set_POST( array( 'test','abc','123' ), array( 'xyz' => 'ABC' ) );
  echo "\n---[After set(array)]-------\n";
  print_r( _POST('test') );
  echo "\n----------\n";
}
if ( has_GET() ) {
  echo '$_GET["foo"]: ' . _GET('foo');
  echo "\n----[This from Cache]------\n";
  echo '$_GET["foo"]: ' . _GET('foo');
  echo "\n----------\n";
  echo '$_GET["bar"]: ' . _GET('bar');
  echo "\n----------\n";
  echo '$_GET["baz"]: ' . _GET('baz', '1001' );
  if ( ! has_GET('banana') ) {
    echo "\n----------\nWe have no bananas today.\n";
  }
}
echo "\n</pre>\n";