Roundcube Framework
Back to top  

rcube_html2text

Converts HTML to formatted plain text

package

Framework
subpackage

Utils

Methods

Constructor.

__construct(string $source = '', boolean $from_file = false, boolean $do_links = true, integer $width = 75,  $charset = 'UTF-8')

If the HTML source string (or file) is supplied, the class will instantiate with that source propagated, all that has to be done it to call get_text().

Arguments

$source

string

HTML content

$from_file

boolean

Indicates $source is a file to pull content from

$do_links

boolean

Indicate whether a table of link URLs is desired

$width

integer

Maximum width of the formatted text, 0 for no limit

$charset

Helper function called by preg_replace() on link replacement.

_build_link_list(string $link, string $display)

Maintains an internal list of links to be displayed at the end of the text, with numeric indices to the original point in the text they appeared. Also makes an effort at identifying and handling absolute and relative links.

Arguments

$link

string

URL of the link

$display

string

Part of the text to associate number with

Workhorse function that does actual conversion (calls _converter() method).

_convert()

Helper function for BLOCKQUOTE body conversion.

_convert_blockquotes( &$text)

Arguments

$text

Helper function for PRE body conversion.

_convert_pre( &$text)

Arguments

$text

Workhorse function that does actual conversion.

_converter( &$text)

First performs custom tag replacement specified by $search and $replace arrays. Then strips any remaining HTML tags, reduces whitespace and newlines to a readable format, and word wraps the text to $width characters.

Arguments

$text

Strtoupper multibyte wrapper function with HTML entities handling.

_strtoupper(string $str) : string

Arguments

$str

string

Text to convert

Response

string

Converted text

Strtoupper function with HTML tags and entities handling.

_toupper(string $str) : string

Arguments

$str

string

Text to convert

Response

string

Converted text

Callback function to correctly add citation markers for blockquote contents

blockquote_citation_callback( $m)

Arguments

$m

Returns the text, converted from HTML.

get_text() : string

Response

string

Plain text

Callback function for preg_replace_callback use in PRE content handler.

pre_preg_callback(array $matches) : string

Arguments

$matches

array

PREG matches

Response

string

Prints the text, converted from HTML.

print_text()

Sets the allowed HTML tags to pass through to the resulting text.

set_allowed_tags( $allowed_tags = '')

Tags should be in the form "

", with no corresponding closing tag.

Arguments

$allowed_tags

Sets a base URL to handle relative links.

set_base_url( $url = '')

Arguments

$url

Loads source HTML into memory, either from $source string or a file.

set_html(string $source, boolean $from_file = false)

Arguments

$source

string

HTML content

$from_file

boolean

Indicates $source is a file to pull content from

Callback function for preg_replace_callback use.

tags_preg_callback(array $matches) : string

Arguments

$matches

array

PREG matches

Response

string

Properties

Contains the HTML content to convert.

html : string
var

Type(s)

string

Contains the converted, formatted text.

text : string
var

Type(s)

string

Maximum width of the formatted text, in columns.

width : integer

Set this value to 0 (or less) to ignore word wrapping and not constrain text to a fixed-width column.

var

Type(s)

integer

Target character encoding for output text

charset : string
var

Type(s)

string

List of preg* regular expression patterns to search for, used in conjunction with $replace.

search : array
var
see

Type(s)

array

List of pattern replacements corresponding to patterns searched.

replace : array
var
see

Type(s)

array

List of preg* regular expression patterns to search for, used in conjunction with $ent_replace.

ent_search : array
var
see

Type(s)

array

List of pattern replacements corresponding to patterns searched.

ent_replace : array
var
see

Type(s)

array

List of preg* regular expression patterns to search for and replace using callback function.

callback_search : array
var

Type(s)

array

List of preg* regular expression patterns to search for in PRE body, used in conjunction with $pre_replace.

pre_search : array
var
see

Type(s)

array

List of pattern replacements corresponding to patterns searched for PRE body.

pre_replace : array
var
see

Type(s)

array

Contains a list of HTML tags to allow in the resulting text.

allowed_tags : string
var
see

Type(s)

string

Contains the base URL that relative links should resolve to.

url : string
var

Type(s)

string

Indicates whether content in the $html variable has been converted yet.

_converted : boolean
var
see

$text

Type(s)

boolean

Contains URL addresses from links to be rendered in plain text.

_link_list : array
var
see

Type(s)

array

Boolean flag, true if a table of link URLs should be listed after the text.

_do_links : boolean
var
see

Type(s)

boolean