tonyair
/
silverstripe-framework
mirror of https://github.com/silverstripe/silverstripe-framework
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Escape strings a bit safer for doc generation

This commit is contained in:
Damian Mooyman 2019-09-03 19:38:19 +12:00 committed by GitHub
parent f649657182
commit 6759af3767
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/Control/Director.php
View File

@ -425,12 +425,12 @@ class Director implements TemplateGlobalProvider
/**
* Converts the given path or url into an absolute url. This method follows the below rules:
* - 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:
* - 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)
* - 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 The url or path to resolve to absolute url.