summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/helpers
diff options
context:
space:
mode:
authorAhmad Anbar <aanbar@gmail.com>2015-04-06 18:59:53 +0200
committerAhmad Anbar <aanbar@gmail.com>2015-04-06 18:59:53 +0200
commit5e50c42ef27261bc7fcb279499ce76cfc2519aa6 (patch)
treed74d660534b72ddc0b6cda9147cecfb64a225346 /user_guide_src/source/helpers
parented520408514fff6486788e1543589418d24d885e (diff)
parent7726b75552f765af94038e47a4a4272ac08c646e (diff)
Merge remote-tracking branch 'upstream/develop' into develop
Diffstat (limited to 'user_guide_src/source/helpers')
-rw-r--r--user_guide_src/source/helpers/date_helper.rst4
-rw-r--r--user_guide_src/source/helpers/email_helper.rst2
-rw-r--r--user_guide_src/source/helpers/file_helper.rst2
-rw-r--r--user_guide_src/source/helpers/form_helper.rst3
-rw-r--r--user_guide_src/source/helpers/html_helper.rst11
-rw-r--r--user_guide_src/source/helpers/smiley_helper.rst2
-rw-r--r--user_guide_src/source/helpers/string_helper.rst2
-rw-r--r--user_guide_src/source/helpers/url_helper.rst4
8 files changed, 17 insertions, 13 deletions
diff --git a/user_guide_src/source/helpers/date_helper.rst b/user_guide_src/source/helpers/date_helper.rst
index bed3b32a2..e0f9f0033 100644
--- a/user_guide_src/source/helpers/date_helper.rst
+++ b/user_guide_src/source/helpers/date_helper.rst
@@ -50,7 +50,7 @@ The following functions are available:
:returns: MySQL-formatted date
:rtype: string
- This function is identical to PHP's `date() <http://www.php.net/date>`_
+ This function is identical to PHP's `date() <http://php.net/manual/en/function.date.php>`_
function, except that it lets you use MySQL style date codes, where each
code letter is preceded with a percent sign, e.g. `%Y %m %d`
@@ -84,7 +84,7 @@ The following functions are available:
.. note:: This function is DEPRECATED. Use the native ``date()`` combined with
`DateTime's format constants
- <http://www.php.net/manual/en/class.datetime.php#datetime.constants.types>`_
+ <http://php.net/manual/en/class.datetime.php#datetime.constants.types>`_
instead::
echo date(DATE_RFC822, time());
diff --git a/user_guide_src/source/helpers/email_helper.rst b/user_guide_src/source/helpers/email_helper.rst
index 685226951..1ee97d902 100644
--- a/user_guide_src/source/helpers/email_helper.rst
+++ b/user_guide_src/source/helpers/email_helper.rst
@@ -62,7 +62,7 @@ The following functions are available:
:returns: TRUE if the mail was successfully sent, FALSE in case of an error
:rtype: bool
- Sends an email using PHP's native `mail() <http://www.php.net/function.mail>`_
+ Sends an email using PHP's native `mail() <http://php.net/function.mail>`_
function.
.. note:: All that this function does is to use PHP's native ``mail``
diff --git a/user_guide_src/source/helpers/file_helper.rst b/user_guide_src/source/helpers/file_helper.rst
index 92cb31a82..833cddea4 100644
--- a/user_guide_src/source/helpers/file_helper.rst
+++ b/user_guide_src/source/helpers/file_helper.rst
@@ -76,7 +76,7 @@ The following functions are available:
write_file('./path/to/file.php', $data, 'r+');
- The default mode is 'wb'. Please see the `PHP user guide <http://php.net/fopen>`_
+ The default mode is 'wb'. Please see the `PHP user guide <http://php.net/manual/en/function.fopen.php>`_
for mode options.
.. note: In order for this function to write data to a file, its permissions must
diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst
index 4706ee706..9ddca89bc 100644
--- a/user_guide_src/source/helpers/form_helper.rst
+++ b/user_guide_src/source/helpers/form_helper.rst
@@ -571,10 +571,11 @@ The following functions are available:
// Would produce: </form> </div></div>
-.. php:function:: set_value($field[, $default = ''])
+.. php:function:: set_value($field[, $default = ''[, $html_escape = TRUE]])
:param string $field: Field name
:param string $default: Default value
+ :param bool $html_escape: Whether to turn off HTML escaping of the value
:returns: Field value
:rtype: string
diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst
index d35be396a..88611011c 100644
--- a/user_guide_src/source/helpers/html_helper.rst
+++ b/user_guide_src/source/helpers/html_helper.rst
@@ -29,7 +29,7 @@ The following functions are available:
:param string $data: Content
:param string $h: Heading level
- :param array $attributes: HTML attributes
+ :param mixed $attributes: HTML attributes
:returns: HTML heading tag
:rtype: string
@@ -41,15 +41,18 @@ The following functions are available:
The above would produce: <h3>Welcome!</h3>
Additionally, in order to add attributes to the heading tag such as HTML
- classes, ids or inline styles, a third parameter is available::
+ classes, ids or inline styles, a third parameter accepts either a string
+ or an array::
- echo heading('Welcome!', 3, 'class="pink"')
+ echo heading('Welcome!', 3, 'class="pink"');
+ echo heading('How are you?', 4, array('id' => 'question', 'class' => 'green'));
The above code produces:
.. code-block:: html
<h3 class="pink">Welcome!<h3>
+ <h4 id="question" class="green">How are you?</h4>
.. php:function:: img([$src = ''[, $index_page = FALSE[, $attributes = '']]])
@@ -401,4 +404,4 @@ The following functions are available:
&nbsp;&nbsp;&nbsp;
.. note:: This function is DEPRECATED. Use the native ``str_repeat()``
- in combination with ``&nbsp;`` instead. \ No newline at end of file
+ in combination with ``&nbsp;`` instead.
diff --git a/user_guide_src/source/helpers/smiley_helper.rst b/user_guide_src/source/helpers/smiley_helper.rst
index 978d11e5f..3e7669942 100644
--- a/user_guide_src/source/helpers/smiley_helper.rst
+++ b/user_guide_src/source/helpers/smiley_helper.rst
@@ -43,7 +43,7 @@ download and install the smiley images, then create a controller and the
View as described.
.. important:: Before you begin, please `download the smiley images
- <http://ellislab.com/asset/ci_download_files/smileys.zip>`_
+ <https://ellislab.com/asset/ci_download_files/smileys.zip>`_
and put them in a publicly accessible place on your server.
This helper also assumes you have the smiley replacement array
located at `application/config/smileys.php`
diff --git a/user_guide_src/source/helpers/string_helper.rst b/user_guide_src/source/helpers/string_helper.rst
index 9d0d890b3..a1acb215c 100644
--- a/user_guide_src/source/helpers/string_helper.rst
+++ b/user_guide_src/source/helpers/string_helper.rst
@@ -124,7 +124,7 @@ The following functions are available:
:rtype: string
Converts double slashes in a string to a single slash, except those
- found in URL protocol prefixes (e.g. http://).
+ found in URL protocol prefixes (e.g. http&#58;//).
Example::
diff --git a/user_guide_src/source/helpers/url_helper.rst b/user_guide_src/source/helpers/url_helper.rst
index 83864d9d3..64deae240 100644
--- a/user_guide_src/source/helpers/url_helper.rst
+++ b/user_guide_src/source/helpers/url_helper.rst
@@ -144,7 +144,7 @@ Available Functions
be a string or an array.
.. note:: If you are building links that are internal to your application
- do not include the base URL (http://...). This will be added
+ do not include the base URL (http&#58;//...). This will be added
automatically from the information specified in your config file.
Include only the URI segments you wish appended to the URL.
@@ -317,7 +317,7 @@ Available Functions
:returns: Protocol-prefixed URL string
:rtype: string
- This function will add http:// in the event that a protocol prefix
+ This function will add http&#58;// in the event that a protocol prefix
is missing from a URL.
Pass the URL string to the function like this::