docs: add protocol-relative link to PHPDocs

This commit is contained in:
kenjis 2024-02-04 17:31:31 +09:00
parent c3f646cd0b
commit b0e1bf7d14
No known key found for this signature in database
GPG Key ID: BD254878922AF198
2 changed files with 18 additions and 10 deletions

View File

@ -369,8 +369,10 @@ class SiteURI extends URI
/**
* For base_url() helper.
*
* @param array|string $relativePath URI string or array of URI segments
* @param string|null $scheme URI scheme. E.g., http, ftp
* @param array|string $relativePath URI string or array of URI segments.
* @param string|null $scheme URI scheme. E.g., http, ftp. If empty
* string '' is set, a protocol-relative
* link is returned.
*/
public function baseUrl($relativePath = '', ?string $scheme = null): string
{
@ -406,9 +408,11 @@ class SiteURI extends URI
/**
* For site_url() helper.
*
* @param array|string $relativePath URI string or array of URI segments
* @param string|null $scheme URI scheme. E.g., http, ftp
* @param App|null $config Alternate configuration to use
* @param array|string $relativePath URI string or array of URI segments.
* @param string|null $scheme URI scheme. E.g., http, ftp. If empty
* string '' is set, a protocol-relative
* link is returned.
* @param App|null $config Alternate configuration to use.
*/
public function siteUrl($relativePath = '', ?string $scheme = null, ?App $config = null): string
{

View File

@ -23,9 +23,11 @@ if (! function_exists('site_url')) {
/**
* Returns a site URL as defined by the App config.
*
* @param array|string $relativePath URI string or array of URI segments
* @param string|null $scheme URI scheme. E.g., http, ftp
* @param App|null $config Alternate configuration to use
* @param array|string $relativePath URI string or array of URI segments.
* @param string|null $scheme URI scheme. E.g., http, ftp. If empty
* string '' is set, a protocol-relative
* link is returned.
* @param App|null $config Alternate configuration to use.
*/
function site_url($relativePath = '', ?string $scheme = null, ?App $config = null): string
{
@ -42,8 +44,10 @@ if (! function_exists('base_url')) {
* Returns the base URL as defined by the App config.
* Base URLs are trimmed site URLs without the index page.
*
* @param array|string $relativePath URI string or array of URI segments
* @param string|null $scheme URI scheme. E.g., http, ftp
* @param array|string $relativePath URI string or array of URI segments.
* @param string|null $scheme URI scheme. E.g., http, ftp. If empty
* string '' is set, a protocol-relative
* link is returned.
*/
function base_url($relativePath = '', ?string $scheme = null): string
{