portal/patient/fwk/libs/verysimple/Phreeze/ActionRouter.php

   1 <?php
   2 /** @package    verysimple::Phreeze */
   3 require_once("verysimple/HTTP/RequestUtil.php");
   4 require_once("verysimple/Util/UrlWriterMode.php");
   5 require_once("verysimple/Phreeze/IRouter.php");
   6
   7 /**
   8  * class for dealing with URLs
   9  *
  10  * @package verysimple::HTTP
  11  * @author VerySimple Inc.
  12  * @copyright 1997-2007 VerySimple, Inc. http://www.verysimple.com
  13  * @license http://www.gnu.org/licenses/lgpl.html LGPL
  14  * @version 1.0
  15  */
  16 class ActionRouter implements IRouter
  17 {
  18     private $_mode;
  19     private $_appRoot;
  20     private $_defaultRoute;
  21     protected $stripApi = true;
  22     protected $delim = '&';
  23     protected static $_format;
  24
  25     /**
  26      * Constructor allows a rewriting pattern to be specified
  27      *
  28      * @param string $format
  29      *          sprintf compatible format
  30      */
  31     public function __construct($format = "%s.%s.page?%s", $mode = UrlWriterMode::WEB, $appRoot = '', $defaultRoute = '')
  32     {
  33         self::$_format = $format;
  34         $this->_mode = $mode;
  35         $this->_appRoot = $appRoot;
  36         $this->_defaultRoute = $defaultRoute;
  37     }
  38
  39     /**
  40      * @inheritdocs
  41      */
  42     public function GetUri()
  43     {
  44         return implode('/', RequestUtil::GetUrlParts($this->_appRoot));
  45     }
  46
  47     /**
  48      * @inheritdocs
  49      */
  50     public function GetUrlParams()
  51     {
  52         return $_REQUEST;
  53     }
  54
  55     /**
  56      * @inheritdocs
  57      */
  58     public function GetUrlParam($key, $default = '')
  59     {
  60         // make the route params case insensitive
  61         return RequestUtil::Get($key, $default, false, true);
  62     }
  63
  64     /**
  65      * @inheritdocs
  66      */
  67     public function GetUrl($controller, $method, $params = '', $requestMethod = '')
  68     {
  69         $format = str_replace("{delim}", $this->delim, self::$_format);
  70
  71         $qs = "";
  72         $d = "";
  73         if (is_array($params)) {
  74             foreach ($params as $key => $val) {
  75                 // if no val, the omit the equal sign (this might be used in rest-type requests)
  76                 $qs .= $d . $key . (strlen($val) ? ("=" . urlencode($val)) : "");
  77                 $d = $this->delim;
  78             }
  79         } else {
  80             $qs = $params;
  81         }
  82
  83         $url = sprintf($format, $controller, $method, $qs);
  84
  85         // strip off trailing delimiters from the url
  86         $url = (substr($url, - 5) == "&amp;") ? substr($url, 0, strlen($url) - 5) : $url;
  87         $url = (substr($url, - 1) == "&" || substr($url, - 1) == "?") ? substr($url, 0, strlen($url) - 1) : $url;
  88
  89         $api_check = explode("/api/", RequestUtil::GetCurrentUrl());
  90         if ($this->stripApi && count($api_check) > 1) {
  91             $url = $api_check [0] . "/" . $url;
  92         }
  93
  94         return $url;
  95     }
  96
  97     /**
  98      * @inheritdocs
  99      */
 100     public function GetRoute($uri = "")
 101     {
 102         if ($uri == "") {
 103             $action = RequestUtil::Get('action');
 104             if (! $action) {
 105                 $action = $this->_defaultRoute;
 106             }
 107
 108             $uri = $action ? $action : RequestUtil::GetCurrentURL();
 109         }
 110
 111         // get the action requested
 112         $params = explode(".", str_replace("/", ".", $uri));
 113         $controller_param = isset($params [0]) && $params [0] ? $params [0] : "";
 114         $controller_param = str_replace(array (
 115                 ".",
 116                 "/",
 117                 "\\"
 118         ), array (
 119                 "",
 120                 "",
 121                 ""
 122         ), $controller_param);
 123
 124         if (! $controller_param) {
 125             throw new Exception("Invalid or missing Controller parameter");
 126         }
 127
 128         $method_param = isset($params [1]) && $params [1] ? $params [1] : "";
 129         if (! $method_param) {
 130             $method_param = "DefaultAction";
 131         }
 132
 133         return array (
 134                 $controller_param,
 135                 $method_param
 136         );
 137     }
 138
 139     /**
 140      * Returns true or false based on the $value passed in as to whether or not the
 141      * URL Writer is currently in that mode.
 142      *
 143      * @param $value String
 144      *          mode to check against the current mode
 145      * @return boolean TRUE if arg passed in is the current mode
 146      */
 147     public function ModeIs($value)
 148     {
 149         if (strcmp($this->_mode, $value) == 0) {
 150             return true;
 151         } else {
 152             return false;
 153         }
 154     }
 155
 156     /**
 157      * Returns how the Dispatcher plucks it's controller and method from the URL.
 158      *
 159      * @param $default_action The
 160      *          Default action in case the argument hasn't been supplied
 161      */
 162     public function GetAction($url_param = "action", $default_action = "Account.DefaultAction")
 163     {
 164         switch ($this->_mode) {
 165             // TODO: Determine mobile/joomla URL action (if different from default)
 166             /*
 167                          * case UrlWriterMode::JOOMLA:
 168                          * break;
 169                          * case UrlWriterMode::MOBILE:
 170                          * break;
 171                          */
 172             default:
 173                 // default is to return the standard browser-based action=%s.%s&%s:
 174                 return RequestUtil::Get($url_param, $default_action);
 175                 break;
 176         }
 177     }
 178 }