malhuda/CodeIgniter4
1
0
Fork 0
mirror of https://github.com/codeigniter4/CodeIgniter4.git synced 2025-02-20 11:44:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #6767 from kenjis/fix-phpdocs-html-url-helper

Browse Source 
docs: fix `@param` types in html/url helper
This commit is contained in:
kenjis 2022-10-27 20:46:38 +09:00 committed by GitHub
commit a01d2dd85e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
system/Helpers/html_helper.php
View File

@ -22,7 +22,7 @@ if (! function_exists('ul')) {
* Generates an HTML unordered list from an single or * Generates an HTML unordered list from an single or
* multi-dimensional array. * multi-dimensional array.
* *
* @param mixed $attributes HTML attributes string, array, object * @param array|object|string $attributes HTML attributes string, array, object
*/ */
function ul(array $list, $attributes = ''): string function ul(array $list, $attributes = ''): string
{ {
@ -36,7 +36,7 @@ if (! function_exists('ol')) {
* *
* Generates an HTML ordered list from an single or multi-dimensional array. * Generates an HTML ordered list from an single or multi-dimensional array.
* *
* @param mixed $attributes HTML attributes string, array, object * @param array|object|string $attributes HTML attributes string, array, object
*/ */
function ol(array $list, $attributes = ''): string function ol(array $list, $attributes = ''): string
{ {
@ -50,8 +50,8 @@ if (! function_exists('_list')) {
* *
* Generates an HTML ordered list from an single or multi-dimensional array. * Generates an HTML ordered list from an single or multi-dimensional array.
* *
* @param mixed $list * @param array $list
* @param mixed $attributes string, array, object * @param array|object|string $attributes string, array, object
*/ */
function _list(string $type = 'ul', $list = [], $attributes = '', int $depth = 0): string function _list(string $type = 'ul', $list = [], $attributes = '', int $depth = 0): string
{ {
@ -224,8 +224,8 @@ if (! function_exists('link_tag')) {
* *
* Generates link to a CSS file * Generates link to a CSS file
* *
* @param mixed $href Stylesheet href or an array * @param array|string $href Stylesheet href or an array
* @param bool $indexPage should indexPage be added to the CSS path. * @param bool $indexPage should indexPage be added to the CSS path.
*/ */
function link_tag($href = '', string $rel = 'stylesheet', string $type = 'text/css', string $title = '', string $media = '', bool $indexPage = false, string $hreflang = ''): string function link_tag($href = '', string $rel = 'stylesheet', string $type = 'text/css', string $title = '', string $media = '', bool $indexPage = false, string $hreflang = ''): string
{ {
@ -281,9 +281,9 @@ if (! function_exists('video')) {
* Generates a video element to embed videos. The video element can * Generates a video element to embed videos. The video element can
* contain one or more video sources * contain one or more video sources
* *
* @param mixed $src Either a source string or an array of sources * @param array|string $src Either a source string or an array of sources
* @param string $unsupportedMessage The message to display if the media tag is not supported by the browser * @param string $unsupportedMessage The message to display if the media tag is not supported by the browser
* @param string $attributes HTML attributes * @param string $attributes HTML attributes
*/ */
function video($src, string $unsupportedMessage = '', string $attributes = '', array $tracks = [], bool $indexPage = false): string function video($src, string $unsupportedMessage = '', string $attributes = '', array $tracks = [], bool $indexPage = false): string
{ {
@ -327,9 +327,9 @@ if (! function_exists('audio')) {
* *
* Generates an audio element to embed sounds * Generates an audio element to embed sounds
* *
* @param mixed $src Either a source string or an array of sources * @param array|string $src Either a source string or an array of sources
* @param string $unsupportedMessage The message to display if the media tag is not supported by the browser. * @param string $unsupportedMessage The message to display if the media tag is not supported by the browser.
* @param string $attributes HTML attributes * @param string $attributes HTML attributes
*/ */
function audio($src, string $unsupportedMessage = '', string $attributes = '', array $tracks = [], bool $indexPage = false): string function audio($src, string $unsupportedMessage = '', string $attributes = '', array $tracks = [], bool $indexPage = false): string
{ {

33
system/Helpers/url_helper.php
View File

@ -95,8 +95,7 @@ if (! function_exists('base_url')) {
* Returns the base URL as defined by the App config. * Returns the base URL as defined by the App config.
* Base URLs are trimmed site URLs without the index page. * Base URLs are trimmed site URLs without the index page.
* *
* @param mixed $relativePath URI string or array of URI segments * @param array|string $relativePath URI string or array of URI segments
* @param string $scheme
*/ */
function base_url($relativePath = '', ?string $scheme = null): string function base_url($relativePath = '', ?string $scheme = null): string
{ {
@ -143,7 +142,7 @@ if (! function_exists('previous_url')) {
* If that's not available, however, we'll use a sanitized url from $_SERVER['HTTP_REFERER'] * If that's not available, however, we'll use a sanitized url from $_SERVER['HTTP_REFERER']
* which can be set by the user so is untrusted and not set by certain browsers/servers. * which can be set by the user so is untrusted and not set by certain browsers/servers.
* *
* @return mixed|string|URI * @return string|URI
*/ */
function previous_url(bool $returnObject = false) function previous_url(bool $returnObject = false)
{ {
@ -197,10 +196,10 @@ if (! function_exists('anchor')) {
* *
* Creates an anchor based on the local URL. * Creates an anchor based on the local URL.
* *
* @param mixed $uri URI string or array of URI segments * @param array|string $uri URI string or array of URI segments
* @param string $title The link title * @param string $title The link title
* @param mixed $attributes Any attributes * @param array|object|string $attributes Any attributes
* @param App|null $altConfig Alternate configuration to use * @param App|null $altConfig Alternate configuration to use
*/ */
function anchor($uri = '', string $title = '', $attributes = '', ?App $altConfig = null): string function anchor($uri = '', string $title = '', $attributes = '', ?App $altConfig = null): string
{ {
@ -230,10 +229,10 @@ if (! function_exists('anchor_popup')) {
* Creates an anchor based on the local URL. The link * Creates an anchor based on the local URL. The link
* opens a new window based on the attributes specified. * opens a new window based on the attributes specified.
* *
* @param string $uri the URL * @param string $uri the URL
* @param string $title the link title * @param string $title the link title
* @param mixed $attributes any attributes * @param array|false|object|string $attributes any attributes
* @param App|null $altConfig Alternate configuration to use * @param App|null $altConfig Alternate configuration to use
*/ */
function anchor_popup($uri = '', string $title = '', $attributes = false, ?App $altConfig = null): string function anchor_popup($uri = '', string $title = '', $attributes = false, ?App $altConfig = null): string
{ {
@ -280,9 +279,9 @@ if (! function_exists('mailto')) {
/** /**
* Mailto Link * Mailto Link
* *
* @param string $email the email address * @param string $email the email address
* @param string $title the link title * @param string $title the link title
* @param mixed $attributes any attributes * @param array|object|string $attributes any attributes
*/ */
function mailto(string $email, string $title = '', $attributes = ''): string function mailto(string $email, string $title = '', $attributes = ''): string
{ {
@ -300,9 +299,9 @@ if (! function_exists('safe_mailto')) {
* *
* Create a spam-protected mailto link written in Javascript * Create a spam-protected mailto link written in Javascript
* *
* @param string $email the email address * @param string $email the email address
* @param string $title the link title * @param string $title the link title
* @param mixed $attributes any attributes * @param array|object|string $attributes any attributes
*/ */
function safe_mailto(string $email, string $title = '', $attributes = ''): string function safe_mailto(string $email, string $title = '', $attributes = ''): string
{ {