Skip to content

Commit c5adf56

Browse files
authored
Merge pull request #4075 from totoprayogo1916/update/userguide/indentation
Update userguide indentation
2 parents 02725d8 + d1d89e4 commit c5adf56

File tree

14 files changed

+1074
-1073
lines changed

14 files changed

+1074
-1073
lines changed

user_guide_src/source/helpers/array_helper.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Loading this Helper
1313

1414
This helper is loaded using the following code::
1515

16-
helper('array');
16+
helper('array');
1717

1818
Available Functions
1919
===================

user_guide_src/source/helpers/cookie_helper.rst

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Loading this Helper
1717

1818
This helper is loaded using the following code::
1919

20-
helper('cookie');
20+
helper('cookie');
2121

2222
Available Functions
2323
===================
@@ -26,54 +26,54 @@ The following functions are available:
2626

2727
.. php:function:: set_cookie($name[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = false[, $httpOnly = false[, $sameSite = '']]]]]]]])
2828
29-
:param mixed $name: Cookie name *or* associative array of all of the parameters available to this function
30-
:param string $value: Cookie value
31-
:param int $expire: Number of seconds until expiration
32-
:param string $domain: Cookie domain (usually: .yourdomain.com)
33-
:param string $path: Cookie path
34-
:param string $prefix: Cookie name prefix
35-
:param bool $secure: Whether to only send the cookie through HTTPS
36-
:param bool $httpOnly: Whether to hide the cookie from JavaScript
37-
:param string $sameSite: The value for the SameSite cookie parameter. If null, the default from `config/App.php` is used
38-
:rtype: void
39-
40-
This helper function gives you friendlier syntax to set browser
41-
cookies. Refer to the :doc:`Response Library </outgoing/response>` for
42-
a description of its use, as this function is an alias for
43-
``Response::setCookie()``.
29+
:param mixed $name: Cookie name *or* associative array of all of the parameters available to this function
30+
:param string $value: Cookie value
31+
:param int $expire: Number of seconds until expiration
32+
:param string $domain: Cookie domain (usually: .yourdomain.com)
33+
:param string $path: Cookie path
34+
:param string $prefix: Cookie name prefix
35+
:param bool $secure: Whether to only send the cookie through HTTPS
36+
:param bool $httpOnly: Whether to hide the cookie from JavaScript
37+
:param string $sameSite: The value for the SameSite cookie parameter. If null, the default from `config/App.php` is used
38+
:rtype: void
39+
40+
This helper function gives you friendlier syntax to set browser
41+
cookies. Refer to the :doc:`Response Library </outgoing/response>` for
42+
a description of its use, as this function is an alias for
43+
``Response::setCookie()``.
4444

4545
.. php:function:: get_cookie($index[, $xssClean = false])
4646
47-
:param string $index: Cookie name
48-
:param bool $xss_clean: Whether to apply XSS filtering to the returned value
49-
:returns: The cookie value or NULL if not found
50-
:rtype: mixed
47+
:param string $index: Cookie name
48+
:param bool $xss_clean: Whether to apply XSS filtering to the returned value
49+
:returns: The cookie value or NULL if not found
50+
:rtype: mixed
5151

52-
This helper function gives you friendlier syntax to get browser
53-
cookies. Refer to the :doc:`IncomingRequest Library </incoming/incomingrequest>` for
54-
detailed description of its use, as this function acts very
55-
similarly to ``IncomingRequest::getCookie()``, except it will also prepend
56-
the ``$cookiePrefix`` that you might've set in your
57-
*app/Config/App.php* file.
52+
This helper function gives you friendlier syntax to get browser
53+
cookies. Refer to the :doc:`IncomingRequest Library </incoming/incomingrequest>` for
54+
detailed description of its use, as this function acts very
55+
similarly to ``IncomingRequest::getCookie()``, except it will also prepend
56+
the ``$cookiePrefix`` that you might've set in your
57+
*app/Config/App.php* file.
5858

5959
.. php:function:: delete_cookie($name[, $domain = ''[, $path = '/'[, $prefix = '']]])
6060
61-
:param string $name: Cookie name
62-
:param string $domain: Cookie domain (usually: .yourdomain.com)
63-
:param string $path: Cookie path
64-
:param string $prefix: Cookie name prefix
65-
:rtype: void
61+
:param string $name: Cookie name
62+
:param string $domain: Cookie domain (usually: .yourdomain.com)
63+
:param string $path: Cookie path
64+
:param string $prefix: Cookie name prefix
65+
:rtype: void
6666

67-
Lets you delete a cookie. Unless you've set a custom path or other
68-
values, only the name of the cookie is needed.
69-
::
67+
Lets you delete a cookie. Unless you've set a custom path or other
68+
values, only the name of the cookie is needed.
69+
::
7070

71-
delete_cookie('name');
71+
delete_cookie('name');
7272

73-
This function is otherwise identical to ``set_cookie()``, except that it
74-
does not have the value and expiration parameters. You can submit an
75-
array of values in the first parameter or you can set discrete
76-
parameters.
77-
::
73+
This function is otherwise identical to ``set_cookie()``, except that it
74+
does not have the value and expiration parameters. You can submit an
75+
array of values in the first parameter or you can set discrete
76+
parameters.
77+
::
7878

79-
delete_cookie($name, $domain, $path, $prefix);
79+
delete_cookie($name, $domain, $path, $prefix);

user_guide_src/source/helpers/date_helper.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Loading this Helper
1717

1818
This helper is loaded using the following code::
1919

20-
helper('date');
20+
helper('date');
2121

2222
Available Functions
2323
===================
@@ -26,38 +26,38 @@ The following functions are available:
2626

2727
.. php:function:: now([$timezone = NULL])
2828
29-
:param string $timezone: Timezone
30-
:returns: UNIX timestamp
31-
:rtype: int
29+
:param string $timezone: Timezone
30+
:returns: UNIX timestamp
31+
:rtype: int
3232

33-
Returns the current time as a UNIX timestamp, referenced either to your server's
34-
local time or any PHP supported timezone, based on the "time reference" setting
35-
in your config file. If you do not intend to set your master time reference to
36-
any other PHP supported timezone (which you'll typically do if you run a site
37-
that lets each user set their own timezone settings) there is no benefit to using
38-
this function over PHP's ``time()`` function.
39-
::
33+
Returns the current time as a UNIX timestamp, referenced either to your server's
34+
local time or any PHP supported timezone, based on the "time reference" setting
35+
in your config file. If you do not intend to set your master time reference to
36+
any other PHP supported timezone (which you'll typically do if you run a site
37+
that lets each user set their own timezone settings) there is no benefit to using
38+
this function over PHP's ``time()`` function.
39+
::
4040

41-
echo now('Australia/Victoria');
41+
echo now('Australia/Victoria');
4242

43-
If a timezone is not provided, it will return ``time()`` based on the
44-
**time_reference** setting.
43+
If a timezone is not provided, it will return ``time()`` based on the
44+
**time_reference** setting.
4545

4646
.. php:function:: timezone_select([$class = '', $default = '', $what = \DateTimeZone::ALL, $country = null])
4747
48-
:param string $class: Optional class to apply to the select field
49-
:param string $default: Default value for initial selection
50-
:param int $what: DateTimeZone class constants (see `listIdentifiers <https://www.php.net/manual/en/datetimezone.listidentifiers.php>`_)
51-
:param string $country: A two-letter ISO 3166-1 compatible country code (see `listIdentifiers <https://www.php.net/manual/en/datetimezone.listidentifiers.php>`_)
52-
:returns: Preformatted HTML select field
53-
:rtype: string
48+
:param string $class: Optional class to apply to the select field
49+
:param string $default: Default value for initial selection
50+
:param int $what: DateTimeZone class constants (see `listIdentifiers <https://www.php.net/manual/en/datetimezone.listidentifiers.php>`_)
51+
:param string $country: A two-letter ISO 3166-1 compatible country code (see `listIdentifiers <https://www.php.net/manual/en/datetimezone.listidentifiers.php>`_)
52+
:returns: Preformatted HTML select field
53+
:rtype: string
5454

55-
Generates a `select` form field of available timezones (optionally filtered by `$what` and `$country`).
56-
You can supply an option class to apply to the field to make formatting easier, as well as a default
57-
selected value.
58-
::
55+
Generates a `select` form field of available timezones (optionally filtered by `$what` and `$country`).
56+
You can supply an option class to apply to the field to make formatting easier, as well as a default
57+
selected value.
58+
::
5959

60-
echo timezone_select('custom-select', 'America/New_York');
60+
echo timezone_select('custom-select', 'America/New_York');
6161

6262
Many functions previously found in the CodeIgniter 3 ``date_helper`` have been moved to the ``I18n``
6363
module in CodeIgniter 4.

0 commit comments

Comments
 (0)