Roundcube Framework
\

\rcube_text2html

Converts plain text to HTML

Summary

Methods
Properties
Constants
__construct()
set_text()
get_html()
print_html()
No public properties found
No constants found
convert()
converter()
convert_line()
$html
$text
$config
$converted
$nowrap
N/A
No private methods found
No private properties found
N/A

Properties

$html

$html : string

Type

string — Contains the HTML content after conversion

$text

$text : string

Type

string — Contains the plain text

$config

$config : array

Type

array — Configuration

$converted

$converted : bool

Type

bool — Internal state

$nowrap

$nowrap : bool

Type

bool — Internal no-wrap mode state

Methods

__construct()

__construct(string  $source = '', bool  $from_file = false, array  $config = []) : mixed

Constructor.

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

Parameters

string $source

Plain text
bool $from_file

Indicates $source is a file to pull content from
array $config

Class configuration

Returns

mixed —

set_text()

set_text(string  $source, bool  $from_file = false) : mixed

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

Parameters

string $source

Plain text
bool $from_file

Indicates $source is a file to pull content from

Returns

mixed —

get_html()

get_html() : string

Returns the HTML content.

Returns

string —

HTML content

print_html()

print_html() : mixed

Prints the HTML.

Returns

mixed —

convert()

convert() : mixed

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

Returns

mixed —

converter()

converter(string  $text) : string

Workhorse function that does actual conversion.

Parameters

string $text

Plain text

Returns

string —

HTML content

convert_line()

convert_line(string  $text) : string

Converts spaces in line of text

Parameters

string $text

Plain text

Returns

string —

Converted text