mirror/php-e107
1
0
Fork 0
mirror of https://github.com/e107inc/e107.git synced 2025-01-17 20:58:30 +01:00
Code Issues Releases Wiki Activity

Better documentation for e107::url()

Browse Source 
Clarifies that the output format of e107::url() is like htmlspecialchars()
This commit is contained in:
Nick Liu 2020-01-14 23:10:29 +01:00
parent ac47858941
commit 82b2da4c36
No known key found for this signature in database
GPG Key ID: 1167C5F9C9897637
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
e107_handlers/e107_class.php
View File

@ -3391,17 +3391,23 @@ class e107
}
/**
* Static (easy) sef-url creation method (works with e_url.php @see /index.php)
* Generate a plugin's search engine-friendly URL with HTML special characters escaped
*
* Can be spliced directly into HTML code like <a href="…"></a>
*
* Output is generated based on the plugin's e_url.php configuration
*
* @param string $plugin - plugin folder name
* @param string $key assigned in e_url.php configuration.
* @param array $row Array of variables in url config.
* @param array $options (optional) An associative array of additional options, with the following elements:
* @param string $options['mode'] abs | full
* @param array $options['query'] An array of query key/value-pairs (without any URL-encoding) to append to the URL.
* @param string $options['fragment'] A fragment identifier (named anchor) to append to the URL. Do not include the leading '#' character.
* @param bool $options['legacy'] When true legacy urls will be generated regardless of mod-rewrite status.
* @return string
* @param array $options = [ // (optional) An associative array of additional options
* 'mode' => 'abs | full', // @see e_parse::replaceConstants()
* 'query' => [], // An array of query key/value-pairs (without any URL encoding) to append to the URL
* 'fragment' => '', // A fragment identifier (named anchor) to append to the URL. Do not include the leading '#' character
* 'legacy' => false, // When true, legacy URLs will be generated regardless of mod_rewrite status
* ]
* @return string The SEF URL with HTML special characters escaped
* (equivalent to the htmlspecialchars() output)
*/
public static function url($plugin = '', $key = null, $row = array(), $options = array())
{