Skip to content

Commit 268156c

Browse files
authored
Merge pull request #9171 from kenjis/docs-url_helper.rst
docs: improve url_helper.rst
2 parents ce7f591 + 2ef57ab commit 268156c

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

user_guide_src/source/helpers/url_helper.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The following functions are available:
2121
.. php:function:: site_url([$uri = ''[, $protocol = null[, $altConfig = null]]])
2222
2323
:param array|string $uri: URI string or array of URI segments.
24-
:param string $protocol: Protocol, e.g., 'http' or 'https'. If empty string '' is set, a protocol-relative link is returned.
24+
:param string $protocol: Protocol, e.g., ``'http'`` or ``'https'``. If empty string ``''`` is set, a protocol-relative link is returned.
2525
:param \\Config\\App $altConfig: Alternate configuration to use.
2626
:returns: Site URL
2727
:rtype: string
@@ -57,7 +57,7 @@ The following functions are available:
5757
.. php:function:: base_url([$uri = ''[, $protocol = null]])
5858
5959
:param array|string $uri: URI string or array of URI segments.
60-
:param string $protocol: Protocol, e.g., 'http' or 'https'. If empty string '' is set, a protocol-relative link is returned.
60+
:param string $protocol: Protocol, e.g., ``'http'`` or ``'https'``. If empty string ``''`` is set, a protocol-relative link is returned.
6161
:returns: Base URL
6262
:rtype: string
6363

@@ -124,7 +124,7 @@ The following functions are available:
124124
125125
:param boolean $returnObject: True if you would like a URI instance returned instead of a string.
126126
:returns: The URL the user was previously on
127-
:rtype: string|mixed|\\CodeIgniter\\HTTP\\URI
127+
:rtype: string|\\CodeIgniter\\HTTP\\URI
128128

129129
Returns the full URL (including segments) of the page the user was previously on.
130130

@@ -182,10 +182,10 @@ The following functions are available:
182182

183183
.. php:function:: anchor([$uri = ''[, $title = ''[, $attributes = ''[, $altConfig = null]]]])
184184
185-
:param mixed $uri: URI string or array of URI segments
186-
:param string $title: Anchor title
187-
:param mixed $attributes: HTML attributes
188-
:param \\Config\\App $altConfig: Alternate configuration to use
185+
:param array|string $uri: URI string or array of URI segments
186+
:param string $title: Anchor title
187+
:param array|object|string $attributes: HTML attributes
188+
:param \\Config\\App|null $altConfig: Alternate configuration to use
189189
:returns: HTML hyperlink (anchor tag)
190190
:rtype: string
191191

@@ -222,7 +222,7 @@ The following functions are available:
222222
223223
:param string $uri: URI string
224224
:param string $title: Anchor title
225-
:param mixed $attributes: HTML attributes
225+
:param array|false|object|string $attributes: HTML attributes
226226
:param \\Config\\App $altConfig: Alternate configuration to use
227227
:returns: Pop-up hyperlink
228228
:rtype: string
@@ -262,7 +262,7 @@ The following functions are available:
262262
263263
:param string $email: E-mail address
264264
:param string $title: Anchor title
265-
:param mixed $attributes: HTML attributes
265+
:param array|object|string $attributes: HTML attributes
266266
:returns: A "mail to" hyperlink
267267
:rtype: string
268268

@@ -281,7 +281,7 @@ The following functions are available:
281281
282282
:param string $email: E-mail address
283283
:param string $title: Anchor title
284-
:param mixed $attributes: HTML attributes
284+
:param array|object|string $attributes: HTML attributes
285285
:returns: A spam-safe "mail to" hyperlink
286286
:rtype: string
287287

@@ -292,7 +292,7 @@ The following functions are available:
292292
.. php:function:: auto_link($str[, $type = 'both'[, $popup = false]])
293293
294294
:param string $str: Input string
295-
:param string $type: Link type ('email', 'url' or 'both')
295+
:param string $type: Link type (``'email'``, ``'url'`` or ``'both'``)
296296
:param bool $popup: Whether to create popup links
297297
:returns: Linkified string
298298
:rtype: string
@@ -378,7 +378,7 @@ The following functions are available:
378378
.. php:function:: url_to($controller[, ...$args])
379379
380380
:param string $controller: Route name or Controller::method
381-
:param mixed ...$args: One or more parameters to be passed to the route. The last parameter allows you to set the locale.
381+
:param int|string ...$args: One or more parameters to be passed to the route. The last parameter allows you to set the locale.
382382
:returns: Absolute URL
383383
:rtype: string
384384

0 commit comments

Comments
 (0)