Changeset 2101

Timestamp:

08/02/2007 08:49:49 AM

Author:

xue

Message:

Fixed #681

Files:

• trunk/HISTORY (modified) (1 diff)
• trunk/framework/Exceptions/messages.txt (modified) (1 diff)
• trunk/framework/Web/TUrlMapping.php (modified) (18 diffs)

trunk/HISTORY

@@ -11 +11 @@
-ENH: Ticket#667 - Added TFeedService.ContentType property (Qiang)
-ENH: Ticket#678 - Improved DateTimeFormatInfo performance (Stever)
+ENH: Ticket#681 - TUrlMapping can construct custom URLs now (Qiang)
-ENH: Added THead requirement check (Qiang)
-CHG: GeSHi is replaced with Text_Highlighter (Christophe)

trunk/framework/Exceptions/messages.txt

@@ -419 +419 @@
-cachesession_cachemodule_inexistent             = TCacheHttpSession.CacheModuleID '{0}' points to a non-existent module.
-cachesession_cachemodule_invalid                = TCacheHttpSession.CacheModuleID '{0}' points to a module that does not implement ICache interface.
+
+urlmapping_urlmappingpattern_required   = TUrlMapping can only contain TUrlMappingPattern or its child classes.
+urlmappingpattern_serviceparameter_required = TUrlMappingPattern.ServiceParameter is required for pattern '{0}'.

trunk/framework/Web/TUrlMapping.php

@@ -12 +12 @@
-
-Prado::using('System.Web.TUrlManager');
+Prado::using('System.Collections.TAttributeCollection');
-
-/**
@@ -21 +22 @@
- * globally in the <tt>application.xml</tt> file and before any services.
- * <code>
+ *  <module id="request" class="THttpRequest" UrlManager="friendly-url" />
- *  <module id="friendly-url" class="System.Web.TUrlMapping">
- *    <url ServiceParameter="Posts.ViewPost" pattern="post/{id}/?" parameters.id="\d+" />
@@ -26 +28 @@
- *    <url ServiceParameter="Posts.ListPost" pattern="category/{cat}/?" parameters.cat="\d+" />
- *  </module>
- *  <module id="request" class="THttpRequest" UrlManager="friendly-url" />
- * </code>
- *
@@ -37 +38 @@
- * in particular order. For example, placing the most specific mappings first.
- *
-
+ed
- * file using the {@link setConfigFile ConfigFile} property.
- *
@@ -43 +44 @@
- * you may override {@link TUrlManager::constructUrl} to support your pattern-based
- * URL scheme.
+ *
+ * From PRADO v3.1.1, TUrlMapping also provides support to construct URLs according to
+ * the specified the pattern. You may enable this functionality by setting {@link setEnableCustomUrl EnableCustomUrl} to true.
+ * When you call THttpRequest::constructUrl() (or via TPageService::constructUrl()),
+ * TUrlMapping will examine the available URL mapping patterns using their {@link getServiceParameter ServiceParameter}
+ * and {@link getPattern Pattern} properties. A pattern is applied if its
+ * {@link getServiceParameter ServiceParameter} matches the service parameter passed
+ * to constructUrl() and every parameter in the {@link getPattern Pattern} is found
+ * in the GET variables.
- *
- * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
@@ -56 +66 @@
-        const CONFIG_FILE_EXT='.xml';
-        /**
-         * @var string default pattern class.
-         */
-        private $_defaultPatternClass='TUrlMappingPattern';
-        /**
-         * @var TUrlMappingPattern[] list of patterns.
-         */
@@ -71 +77 @@
-         */
-        private $_configFile=null;
+        /**
+         * @var boolean whether to enable custom contructUrl
+         */
+        private $_customUrl=false;
+        /**
+         * @var array rules for constructing URLs
+         */
+        private $_constructRules=array();
+
+        private $_urlPrefix='';
-
-        /**
@@ -86 +102 @@
-                        $this->loadConfigFile();
-                $this->loadUrlMappings($xml);
+                if($this->_urlPrefix==='')
+                        $this->_urlPrefix=$this->getRequest()->getApplicationUrl();
+                $this->_urlPrefix=rtrim($this->_urlPrefix,'/');
-        }
-
@@ -106 +125 @@
-
-        /**
+         * Returns a value indicating whether to enable custom constructUrl.
+         * If true, constructUrl() will make use of the URL mapping rules to
+         * construct valid URLs.
+         * @return boolean whether to enable custom constructUrl. Defaults to false.
+         */
+        public function getEnableCustomUrl()
+        {
+                return $this->_customUrl;
+        }
+
+        /**
+         * Sets a value indicating whether to enable custom constructUrl.
+         * If true, constructUrl() will make use of the URL mapping rules to
+         * construct valid URLs.
+         * @param boolean whether to enable custom constructUrl.
+         */
+        public function setEnableCustomUrl($value)
+        {
+                $this->_customUrl=TPropertyValue::ensureBoolean($value);
+        }
+
+        /**
+         * @return string the part that will be prefixed to the constructed URLs. Defaults to the requested script path (e.g. /path/to/index.php for a URL http://hostname/path/to/index.php)
+         */
+        public function getUrlPrefix()
+        {
+                return $this->_urlPrefix;
+        }
+
+        /**
+         * @param string the part that will be prefixed to the constructed URLs. This is used by constructUrl() when EnableCustomUrl is set true.
+         * @see getUrlPrefix
+         */
+        public function setUrlPrefix($value)
+        {
+                $this->_urlPrefix=$value;
+        }
+
+        /**
-         * @return string external configuration file. Defaults to null.
-         */
@@ -134 +192 @@
-                {
-                        $properties=$url->getAttributes();
-
-
-
-
+
+
+
-                        if(!($pattern instanceof TUrlMappingPattern))
-path_dispatch_invalid_pattern_class
+mapping_urlmappingpattern_required
-                        foreach($properties as $name=>$value)
-                                $pattern->setSubproperty($name,$value);
-                        $this->_patterns[] = $pattern;
-                        $pattern->init($url);
+
+                        $key=$pattern->getServiceID().':'.$pattern->getServiceParameter();
+                        $this->_constructRules[$key][]=$pattern;
-                }
-        }
@@ -176 +236 @@
-
-        /**
+         * Constructs a URL that can be recognized by PRADO.
+         *
+         * This method provides the actual implementation used by {@link THttpRequest::constructUrl}.
+         * Override this method if you want to provide your own way of URL formatting.
+         * If you do so, you may also need to override {@link parseUrl} so that the URL can be properly parsed.
+         *
+         * The URL is constructed as the following format:
+         * /entryscript.php?serviceID=serviceParameter&get1=value1&...
+         * If {@link THttpRequest::setUrlFormat THttpRequest.UrlFormat} is 'Path',
+         * the following format is used instead:
+         * /entryscript.php/serviceID/serviceParameter/get1,value1/get2,value2...
+         * @param string service ID
+         * @param string service parameter
+         * @param array GET parameters, null if not provided
+         * @param boolean whether to encode the ampersand in URL
+         * @param boolean whether to encode the GET parameters (their names and values)
+         * @return string URL
+         * @see parseUrl
+         * @since 3.1.1
+         */
+        public function constructUrl($serviceID,$serviceParam,$getItems,$encodeAmpersand,$encodeGetItems)
+        {
+                if(!$this->_customUrl || !(is_array($getItems) || ($getItems instanceof Traversable)))
+                        return parent::constructUrl($serviceID,$serviceParam,$getItems,$encodeAmpersand,$encodeGetItems);
+
+                $key=$serviceID.':'.$serviceParam;
+                if(isset($this->_constructRules[$key]))
+                {
+                        foreach($this->_constructRules[$key] as $rule)
+                        {
+                                if($rule->supportCustomUrl($getItems))
+                                        return $rule->constructUrl($getItems,$encodeAmpersand,$encodeGetItems);
+                        }
+                }
+                return parent::constructUrl($serviceID,$serviceParam,$getItems,$encodeAmpersand,$encodeGetItems);
+        }
+
+        /**
-         * @return TUrlMappingPattern the matched pattern, null if not found.
-         */
@@ -252 +350 @@
-         * @var string url pattern to match.
-         */
-
+=''
-        /**
-         * @var TMap parameter regular expressions.
@@ -260 +358 @@
-         * @var string regular expression pattern.
-         */
-
+=''
-        /**
-         * @var boolean case sensitive matching, default is true
@@ -266 +364 @@
-        private $_caseSensitive=true;
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        }
-
@@ -278 +387 @@
-        public function init($config)
-        {
-
-
+
-                        $this->setRegularExpression($body);
-
-
-
-
-
+
+
-        }
-
@@ -358 +463 @@
-
-        /**
-
+ Defaults to ''.
-         */
-        public function getPattern()
@@ -413 +518 @@
-        public function getPatternMatches($url)
-        {
-                $path = $url->getPath();
-                $matches=array();
-
-
-
-
+
+
+
-                return $matches;
-        }
@@ -432 +535 @@
-                return $modifiers;
-        }
+
+        /**
+         * Returns a value indicating whether to use this pattern to construct URL.
+         * @return boolean whether to enable custom constructUrl. Defaults to true.
+         * @since 3.1.1
+         */
+        public function getEnableCustomUrl()
+        {
+                return $this->_customUrl;
+        }
+
+        /**
+         * Sets a value indicating whether to enable custom constructUrl using this pattern
+         * @param boolean whether to enable custom constructUrl.
+         */
+        public function setEnableCustomUrl($value)
+        {
+                $this->_customUrl=TPropertyValue::ensureBoolean($value);
+        }
+
+        /**
+         * @param array list of GET items to be put in the constructed URL
+         * @return boolean whether this pattern IS the one for constructing the URL with the specified GET items.
+         * @since 3.1.1
+         */
+        public function supportCustomUrl($getItems)
+        {
+                if(!$this->_customUrl || $this->getPattern()==='')
+                        return false;
+                foreach($this->_parameters as $key=>$value)
+                        if(!isset($getItems[$key]))
+                                return false;
+
+                return true;
+        }
+
+        /**
+         * Constructs a URL using this pattern.
+         * @param array list of GET variables
+         * @param boolean whether the ampersand should be encoded in the constructed URL
+         * @param boolean whether the GET variables should be encoded in the constructed URL
+         * @return string the constructed URL
+         * @since 3.1.1
+         */
+        public function constructUrl($getItems,$encodeAmpersand,$encodeGetItems)
+        {
+                $extra=array();
+                $replace=array();
+                // for the GET variables matching the pattern, put them in the URL path
+                foreach($getItems as $key=>$value)
+                {
+                        if($encodeGetItems)
+                                $value=urlencode($value);
+                        if($this->_parameters->contains($key))
+                                $replace['{'.$key.'}']=$value;
+                        else
+                                $extra[$key]=$value;
+                }
+
+                $url=$this->_manager->getUrlPrefix().'/'.trim(strtr($this->getPattern(),$replace),'/');
+
+                // for the rest of the GET variables, put them in the query string
+                if(count($extra)>0)
+                {
+                        $url2='';
+                        $amp=$encodeAmpersand?'&amp;':'&';
+                        if($encodeGetItems)
+                        {
+                                foreach($extra as $name=>$value)
+                                {
+                                        if(is_array($value))
+                                        {
+                                                $name=urlencode($name.'[]');
+                                                foreach($value as $v)
+                                                        $url2.=$amp.$name.'='.urlencode($v);
+                                        }
+                                        else
+                                                $url2.=$amp.urlencode($name).'='.urlencode($value);
+                                }
+                        }
+                        else
+                        {
+                                foreach($extra as $name=>$value)
+                                {
+                                        if(is_array($value))
+                                        {
+                                                foreach($value as $v)
+                                                        $url2.=$amp.$name.'[]='.$v;
+                                        }
+                                        else
+                                                $url2.=$amp.$name.'='.$value;
+                                }
+                        }
+                        $url=$url.'?'.substr($url2,strlen($amp));
+                }
+                return $url;
+        }
-}
-