Source for file jUrl.class.php
Documentation is available at jUrl.class.php
- <?php
- /**
- * @package jelix
- * @subpackage core_url
- * @author Laurent Jouanneau
- * @contributor Thibault PIRONT < nuKs >
- * @contributor Loic Mathaud
- * @copyright 2005-2008 Laurent Jouanneau
- * @copyright 2007 Thibault PIRONT
- * @copyright 2006 Loic Mathaud
- * Some parts of this file are took from an experimental branch of the Copix project (CopixUrl.class.php, Copix 2.3dev20050901, http://www.copix.org),
- * Some lines of code are still copyrighted 2001-2005 CopixTeam (LGPL licence).
- * Initial authors of this parts are Gerald Croes and Laurent Jouanneau,
- * and this parts were adapted for Jelix by Laurent Jouanneau
- * @link http://jelix.org
- * @licence GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
- */
-
-
- /**
- * Object that contains url data, and which provides static method helpers
- * @package jelix
- * @subpackage core_url
- * @author Laurent Jouanneau (for the original code from Copix and enhancement for jelix)
- * @author Gerald Croes (for the original code from Copix)
- * @contributor Loic Mathaud
- * @contributor Thibault PIRONT < nuKs >
- */
- class jUrl extends jUrlBase {
-
- /**#@+
- * constant for get() method
- * @var integer
- */
- const STRING=0;
- const XMLSTRING=1;
- const JURL=2;
- const JURLACTION=3;
- /**#@-*/
-
- /**
- * script name including its path
- * @var string
- */
- public $scriptName;
-
- /**
- * path info part of the url
- * @var string
- */
- public $pathInfo = '';
-
- /**
- * constructor
- * @param string $scriptname script name
- * @param array $params parameters
- * @param string $pathInfo path info contents
- */
- function __construct ($scriptname='', $params=array (), $pathInfo=''){
- $this->params = $params;
- $this->scriptName = $scriptname;
- $this->pathInfo = $pathInfo;
- }
-
-
- /**
- * converts the url to a string
- * @param boolean $forxml true: some characters will be escaped
- * @return string
- */
- public function toString ($forxml = false){
- return $this->getPath().$this->getQuery($forxml);
- }
-
- /**
- * get the path part of the url (scriptName + pathinfo)
- * @return string
- * @since 1.0.4
- */
- public function getPath() {
- $url = $this->scriptName;
- if(substr($this->scriptName,-1) == '/')
- $url.=ltrim($this->pathInfo,'/');
- else
- $url.= $this->pathInfo;
- return $url;
- }
-
- /**
- * get the query part of the url
- * @param boolean $forxml true: some characters will be escaped
- * @return string
- * @since 1.0.4
- */
- public function getQuery($forxml = false) {
- $url = '';
- if (count ($this->params)>0){
- $q = http_build_query($this->params, '', ($forxml?'&':'&'));
- if(strpos($q, '%3A')!==false)
- $q = str_replace( '%3A', ':', $q);
- $url .='?'.$q;
- }
- return $url;
- }
-
- //============================== static helper methods
-
- /**
- * get current Url
- * @param boolean $forxml if true, escape some characters to include the url into an html/xml document
- * @return string the url
- */
- static function getCurrentUrl ($forxml = false) {
- if(isset($_SERVER["REQUEST_URI"])){
- return $_SERVER["REQUEST_URI"];
- }
- static $url = false;
- if ($url === false){
- $url = 'http://'.$_SERVER['HTTP_HOST'].$GLOBALS['gJCoord']->request->urlScript.$GLOBALS['gJCoord']->request->urlPathInfo.'?';
- $q = http_build_query($_GET, '', ($forxml?'&':'&'));
- if(strpos($q, '%3A')!==false)
- $q = str_replace( '%3A', ':', $q);
- $url .=$q;
- }
- return $url;
- }
-
- /**
- * Adds parameters to the given url
- * @param string $url an URL
- * @param array $params some parameters to append to the url
- * @param boolean $forxml if true, escape some characters to include the url into an html/xml document
- * @return string the url
- */
- static function appendToUrlString ($url, $params = array (), $forxml = false){
- $q = http_build_query($params, '', ($forxml?'&':'&'));
- if(strpos($q, '%3A')!==false)
- $q = str_replace( '%3A', ':', $q);
- if ((($pos = strpos ( $url, '?')) !== false) && ($pos !== (strlen ($url)-1))){
- return $url . ($forxml ? '&' : '&').$q;
- }else{
- return $url . '?'.$q;
- }
- }
-
- /**
- * Gets the url corresponding to an action, in the given format
- * @param string $actSel action selector. You can use # instead of the module
- * or the action name, to specify the current url.
- * @param array $params associative array with the parameters
- * @param integer $what the format you want : one of the jUrl const,
- * STRING XMLSTRING JURL JURLACTION
- * @return mixed a value, depending of the $what parameter
- */
- static function get ($actSel, $params = array (), $what=0) {
-
- $sel = new jSelectorAct($actSel,true);
- $params['module'] = $sel->module;
- $params['action'] = $sel->resource;
- $ua = new jUrlAction($params, $sel->request);
-
- if($what == 3) return $ua;
-
- $url = jUrl::getEngine()->create($ua);
-
- if($what == 2) return $url;
-
- return $url->toString($what != 0);
- }
-
- /**
- * Parse a url
- * @param string $scriptNamePath /path/index.php
- * @param string $pathinfo the path info of the url.
- * @param array $params url parameter ($_REQUEST)
- * @return jUrlAction
- */
- static function parse($scriptNamePath, $pathinfo, $params ){
- return jUrl::getEngine()->parse($scriptNamePath,$pathinfo, $params);
- }
-
- /**
- * Parse a url from the request
- * @param jRequest $request
- * @param array $params url parameters ($_REQUEST, or $_GET)
- * @return jUrlAction
- * @since 1.1
- */
- static function parseFromRequest($request, $params ){
- return jUrl::getEngine()->parseFromRequest($request, $params);
- }
-
- /**
- * escape and simplier a string to be a part of an url path
- * remove or replace not allowed characters etc..
- * @param string $str the string to escape
- * @param boolean $highlevel false : just to a urlencode. true, replace some characters
- * @return string escaped string
- */
- static function escape($str, $highlevel=false){
- static $url_escape_from = null;
- static $url_escape_to = null;
-
- if($highlevel){
- if($url_escape_from == null){
- $url_escape_from = explode(' ',jLocale::get('jelix~format.url_escape_from'));
- $url_escape_to = explode(' ',jLocale::get('jelix~format.url_escape_to'));
- }
- // first, we do transliteration.
- // we don't use iconv because it is system dependant
- // we don't use strtr because it is not utf8 compliant
- $str = str_replace($url_escape_from, $url_escape_to, $str);
- // then we replace all non word characters by a space
- $str = preg_replace("/([^\w])/"," ",$str);
- // then we remove words of 2 letters
- //$str=preg_replace("/(?<=\s)\w{1,2}(?=\s)/"," ",$str);
- // then we replace all spaces by a -
- $str = preg_replace("/( +)/","-",trim($str));
- // we convert all character to lower case
- $str = strtolower($str);
- return $str;
- }else{
- return urlencode (str_replace (array ('-', ' '), array ('--','-'), $str));
- }
- }
-
- /**
- * perform the opposit of escape
- * @param string $str the string to escape
- * @return string
- */
- static function unescape($str){
- return strtr ($str, array ('--'=>'-', '-'=>' '));
- }
-
- /**
- * return the current url engine
- * @return jIUrlEngine
- * @internal call with true parameter, to force to re-instancy the engine. useful for test suite
- */
- static function getEngine($reset=false){
- static $engine = null;
-
- if($engine === null || $reset){
- global $gJConfig;
- $name = $gJConfig->urlengine['engine'];
- if( !isset($gJConfig->_pluginsPathList_urls[$name])
- || !file_exists($gJConfig->_pluginsPathList_urls[$name]) ){
- throw new jException('jelix~errors.urls.engine.notfound', $name);
- }
- require_once($gJConfig->_pluginsPathList_urls[$name].$name.'.urls.php');
-
- $cl = $name.'UrlEngine';
- $engine = new $cl();
- }
- return $engine;
- }
- }
Documentation generated on Thu, 22 Mar 2012 22:17:30 +0100 by phpDocumentor 1.4.3