Source for file jUrlBase.class.php

Documentation is available at jUrlBase.class.php

  1. <?php
  2. /**
  3. * @package     jelix
  4. * @subpackage  core_url
  5. * @author      Laurent Jouanneau
  6. * @copyright   2005-2006 Laurent Jouanneau
  7. * @link        http://jelix.org
  8. * @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
  9. */
  10.  
  11.  
  12. /**
  13.  * base class for jUrl and jUrlAction
  14.  * @package  jelix
  15.  * @subpackage core_url
  16.  * @author      Laurent Jouanneau
  17.  * @copyright   2005-2006 Laurent Jouanneau
  18.  */
  19. abstract class jUrlBase {
  20.  
  21.     /**
  22.      * parameters
  23.      */
  24.     public $params=array();
  25.  
  26.     /**
  27.     * add or change the value of a parameter
  28.     * @param    string    $name    parameter name
  29.     * @param    string    $value   parameter value
  30.     */
  31.     public function setParam ($name, $value){
  32.         $this->params[$name] = $value;
  33.     }
  34.  
  35.     /**
  36.     * delete a parameter
  37.     * @param    string    $name    parameter name
  38.     */
  39.     public function delParam ($name){
  40.         if (array_key_exists($name, $this->params))
  41.             unset ($this->params[$name]);
  42.     }
  43.  
  44.     /**
  45.     * get a parameter value
  46.     * @param string  $name    parameter name
  47.     * @param string  $defaultValue   the default value returned if the parameter doesn't exists
  48.     * @return string the value
  49.     */
  50.     public function getParam ($name, $defaultValue=null){
  51.         return array_key_exists($name, $this->params)? $this->params[$name] :$defaultValue;
  52.     }
  53.  
  54.     /**
  55.     * Clear parameters
  56.     */
  57.     public function clearParam (){
  58.         $this->params = array ();
  59.     }
  60.  
  61.  
  62.     /**
  63.      * get the url string corresponding to the url/action
  64.      * @param boolean $forxml  true: some characters will be escaped
  65.      * @return string 
  66.      */
  67.     abstract public function toString($forxml = false);
  68.  
  69.  
  70.     /**
  71.      * magic method for echo and others...
  72.      */
  73.     public function __toString(){
  74.         return $this->toString();
  75.     }
  76. }

Documentation generated on Thu, 22 Mar 2012 22:17:31 +0100 by phpDocumentor 1.4.3