blob: 89730b03d53e5ea90ed6749cb49af6c40496fa98 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
#################
Typography Helper
#################
The Typography Helper file contains functions that help your format text
in semantically relevant ways.
.. contents::
:local:
.. raw:: html
<div class="custom-index container"></div>
Loading this Helper
===================
This helper is loaded using the following code::
$this->load->helper('typography');
Available Functions
===================
The following functions are available:
.. php:function:: auto_typography($str[, $reduce_linebreaks = FALSE])
:param string $str: Input string
:param bool $reduce_linebreaks: Whether to reduce multiple instances of double newlines to two
:returns: HTML-formatted typography-safe string
:rtype: string
Formats text so that it is semantically and typographically correct
HTML.
This function is an alias for ``CI_Typography::auto_typography()``.
For more info, please see the :doc:`Typography Library
<../libraries/typography>` documentation.
Usage example::
$string = auto_typography($string);
.. note:: Typographic formatting can be processor intensive, particularly if
you have a lot of content being formatted. If you choose to use this
function you may want to consider :doc:`caching <../general/caching>` your
pages.
.. php:function:: nl2br_except_pre($str)
:param string $str: Input string
:returns: String with HTML-formatted line breaks
:rtype: string
Converts newlines to <br /> tags unless they appear within <pre> tags.
This function is identical to the native PHP ``nl2br()`` function,
except that it ignores <pre> tags.
Usage example::
$string = nl2br_except_pre($string);
.. php:function:: entity_decode($str, $charset = NULL)
:param string $str: Input string
:param string $charset: Character set
:returns: String with decoded HTML entities
:rtype: string
This function is an alias for ``CI_Security::entity_decode()``.
Fore more info, please see the :doc:`Security Library
<../libraries/security>` documentation.
|
