Source for file Param.php

Documentation is available at Param.php

  1. <?php
  2.     /**
  3.      * Parameter accessing helper functions
  4.      *
  5.      * @copyright Copyright (c) 2004-2006 Mirchev Ideas Ltd. All rights reserved.
  6.      * @package MIPHPF
  7.      */
  8.  
  9.     /**
  10.      * Retrieves a param. First tryies from $_POST, and then $_GET. If the param is not found
  11.      * prints an error and terminates the application
  12.      *
  13.      * @param string $param The param name
  14.      * @return string the value
  15.      * @throws miException
  16.      */
  17.     function miGetParam($param)
  18.     {
  19.         if (array_key_exists($param, $_POST))
  20.             return $_POST[$param];
  21.         if (array_key_exists($param, $_GET))
  22.             return $_GET[$param];
  23.             
  24.         throw new miException(sprintf(miI18N::getSystemMessage('MI_EXPECTED_PARAM_ERROR_MSG'), $param));
  25.     }
  26.     
  27.     
  28.     /**
  29.      * Retrieves a param or returns a default value.
  30.      * First tryies from $_POST, and then $_GET. If the param is not found returns $defult
  31.      *
  32.      * @param string $param The param name
  33.      * @param string $default the default value
  34.      * @return string the value
  35.      */
  36.     function miGetParamDefault($param, $default)
  37.     {
  38.         if (array_key_exists($param, $_POST))
  39.             return $_POST[$param];
  40.         if (array_key_exists($param, $_GET))
  41.             return $_GET[$param];
  42.         
  43.         return $default;
  44.     }
  45.     
  46.     /**
  47.      * Returns true if the param is set
  48.      *
  49.      * @param string $param 
  50.      * @return bool true if the param is set
  51.      */
  52.     function miHasParam($param)
  53.     {
  54.         return (array_key_exists($param, $_POST)) or (array_key_exists($param, $_GET));
  55.     }
  56.     
  57.     /**
  58.      * Sets the param value. This value can be then obtained from miGetParam
  59.      * It clears the $_GET array value, and sets the value into the $_POST and $_REQUEST arrays
  60.      * 
  61.      * @access public
  62.      * @param string $param The param name
  63.      * @param any $value the param value
  64.      */ 
  65.     function miSetParam($param, $value)
  66.     {
  67.         unset($_GET[$param]);
  68.         $_POST[$param] = $value;
  69.         $_REQUEST[$param] = $value; 
  70.     }
  71. ?>

Documentation generated on Thu, 08 May 2008 16:57:30 +0300 by phpDocumentor 1.4.1