tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Clarify Director::absoluteURL behaviour

Browse Source 
Fixes #9111
This commit is contained in:
Damian Mooyman 2019-09-03 19:34:16 +12:00 committed by GitHub
parent ef49dcf726
commit f649657182
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/Control/Director.php
View File

@ -424,16 +424,18 @@ class Director implements TemplateGlobalProvider
} }
/** /**
* Turns the given URL into an absolute URL. By default non-site root relative urls will be * Converts the given path or url into an absolute url. This method follows the below rules:
* evaluated relative to the current base_url. * - Absolute urls (e.g. http://localhost) are not modified
* - Relative urls (e.g. //localhost) have current protocol added (http://localhost)
* - Absolute paths (e.g. /base/about-us) are resolved by adding the current protocol and host (http://localhost/base/about-us)
* - Relative paths (e.g. about-us/staff) must be resolved using one of three methods, disambiguated via the $relativeParent argument:
* - BASE - Append this path to the base url (i.e. behaves as though `<base>` tag is provided in a html document). This is the default.
* - REQUEST - Resolve this path to the current url (i.e. behaves as though no <base> tag is provided in a html document)
* - ROOT - Treat this as though it was an absolute path, and append it to the protocol and hostname.
* *
* @param string $url URL To transform to absolute. * @param string $url The url or path to resolve to absolute url.
* @param string $relativeParent Method to use for evaluating relative urls. * @param string $relativeParent Disambiguation method to use for evaluating relative paths
* Either one of BASE (baseurl), ROOT (site root), or REQUEST (requested page). * @return string The absolute url
* Defaults to BASE, which is the same behaviour as template url resolution.
* Ignored if the url is absolute or site root.
*
* @return string
*/ */
public static function absoluteURL($url, $relativeParent = self::BASE) public static function absoluteURL($url, $relativeParent = self::BASE)
{ {