CodeIgniter v3.0.0 API
\

\CI_Typography

Typography Class

Summary

Methods
Properties
Constants
auto_typography()
format_characters()
nl2br_except_pre()
$block_elements
$skip_elements
$inline_elements
$inner_block_required
$last_block_element
$protect_braced_quotes
No constants found
_format_newlines()
_protect_characters()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$block_elements

$block_elements : string

Block level elements that should not be wrapped inside <p> tags

Type

string

$skip_elements

$skip_elements : string

Elements that should not have <p> and <br /> tags within them.

Type

string

$inline_elements

$inline_elements : string

Tags we want the parser to completely ignore when splitting the string.

Type

string

$inner_block_required

$inner_block_required : array

array of block level elements that require inner content to be within another block level element

Type

array

$last_block_element

$last_block_element : string

the last block element parsed

Type

string

$protect_braced_quotes

$protect_braced_quotes : boolean

whether or not to protect quotes within { curly braces }

Type

boolean

Methods

auto_typography()

auto_typography(  $str,   $reduce_linebreaks = FALSE) : string

Auto Typography

This function converts text, making it typographically correct:

  • Converts double spaces into paragraphs.
  • Converts single line breaks into
    tags
  • Converts single and double quotes into correctly facing curly quote entities.
  • Converts three dots into ellipsis.
  • Converts double dashes into em-dashes.
    • Converts two spaces into entities

Parameters

$str
$reduce_linebreaks

Returns

string

format_characters()

format_characters(  $str) : string

Format Characters

This function mainly converts double and single quotes to curly entities, but it also converts em-dashes, double spaces, and ampersands

Parameters

$str

Returns

string

nl2br_except_pre()

nl2br_except_pre(  $str) : string

Convert newlines to HTML line breaks except within PRE tags

Parameters

$str

Returns

string

_format_newlines()

_format_newlines(  $str) : string

Format Newlines

Converts newline characters into either

tags or

Parameters

$str

Returns

string

_protect_characters()

_protect_characters(  $match) : string

Protect Characters

Protects special characters from being formatted later We don't want quotes converted within tags so we'll temporarily convert them to {@DQ} and {@SQ} and we don't want double dashes converted to emdash entities, so they are marked with {@DD} likewise double spaces are converted to {@NBS} to prevent entity conversion

Parameters

$match

Returns

string