class Texy

Texy! - Convert plain text to XHTML format using {@link process()}.

$texy = new Texy(); $html = $texy->process($text);

Traits

Better OOP experience.

Constants

ALL

NONE

VERSION

CONTENT_MARKUP

CONTENT_REPLACED

CONTENT_TEXTUAL

CONTENT_BLOCK

FILTER_ANCHOR

FILTER_IMAGE

XML

HTML4_TRANSITIONAL

HTML4_STRICT

HTML5

XHTML1_TRANSITIONAL

XHTML1_STRICT

XHTML5

Properties

array $allowed
true|false|array $allowedTags
true|false|array $allowedClasses
true|false|array $allowedStyles
int $tabWidth
bool $obfuscateEmail
array $urlSchemeFilters
bool $mergeLines
array $summary
array $alignClasses
bool $removeSoftHyphens
string $nontextParagraph
ScriptModule $scriptModule
ParagraphModule $paragraphModule
HtmlModule $htmlModule
ImageModule $imageModule
LinkModule $linkModule
PhraseModule $phraseModule
EmoticonModule $emoticonModule
BlockModule $blockModule
HeadingModule $headingModule
HorizLineModule $horizLineModule
BlockQuoteModule $blockQuoteModule
ListModule $listModule
TableModule $tableModule
FigureModule $figureModule
TypographyModule $typographyModule
LongWordsModule $longWordsModule
HtmlOutputModule $htmlOutputModule
array $_classes
array $_styles
array $dtd DTD descriptor.

Methods

__construct()

No description

void
setOutputMode(int $mode)

Set HTML/XHTML output mode (overwrites self::$allowedTags)

int
getOutputMode()

Get HTML/XHTML output mode

void
loadModules()

Create array of all used modules ($this->modules).

void
registerLinePattern(callable $handler, string $pattern, string $name, string $againTest = null)

No description

void
registerBlockPattern(callable $handler, string $pattern, string $name)

No description

void
registerPostLine(callable $handler, string $name)

No description

string
process(string $text, bool $singleLine = false)

Converts document in Texy! to (X)HTML code.

string
processLine(string $text)

Converts single line in Texy! to (X)HTML code.

string
processTypo(string $text)

Makes only typographic corrections.

string
toText()

Converts DOM structure to pure text.

string
stringToHtml(string $s)

Converts internal string representation to final HTML code.

string
stringToText(string $s)

Converts internal string representation to final HTML code.

void
addHandler(string $event, callable $callback)

Add new event handler.

mixed
invokeAroundHandlers(string $event, Parser $parser, array $args)

Invoke registered around-handlers.

void
invokeHandlers(string $event, array $args)

Invoke registered after-handlers.

string
protect(string $child, string $contentType)

Generate unique mark - useful for freezing (folding) some substrings.

bool
checkURL(string $URL, string $type)

Filters bad URLs.

string
unProtect(string $html)

No description

array
getLinePatterns()

No description

array
getBlockPatterns()

No description

getDOM()

No description

__clone()

No description

static string
freezeSpaces(string $s) deprecated

No description

static string
unfreezeSpaces(string $s) deprecated

No description

static string
normalize(string $s) deprecated

No description

static string
webalize(string $s, string $charlist = null) deprecated

No description

static string
escapeHtml(string $s) deprecated

No description

static string
unescapeHtml(string $s) deprecated

No description

static string
outdent(string $s) deprecated

No description

static bool
isRelative(string $URL) deprecated

No description

static string
prependRoot(string $URL, string $root) deprecated

No description

Details

at line 202
__construct()

at line 230
void setOutputMode(int $mode)

Set HTML/XHTML output mode (overwrites self::$allowedTags)

Parameters

int $mode

Return Value

void

at line 257
int getOutputMode()

Get HTML/XHTML output mode

Return Value

int

at line 267
protected void loadModules()

Create array of all used modules ($this->modules).

This array can be changed by overriding this method (by subclasses)

Return Value

void

at line 294
final void registerLinePattern(callable $handler, string $pattern, string $name, string $againTest = null)

Parameters

callable $handler
string $pattern
string $name
string $againTest

Return Value

void

at line 308
final void registerBlockPattern(callable $handler, string $pattern, string $name)

Parameters

callable $handler
string $pattern
string $name

Return Value

void

at line 322
final void registerPostLine(callable $handler, string $name)

Parameters

callable $handler
string $name

Return Value

void

at line 335
string process(string $text, bool $singleLine = false)

Converts document in Texy! to (X)HTML code.

Parameters

string $text
bool $singleLine

Return Value

string

at line 417
string processLine(string $text)

Converts single line in Texy! to (X)HTML code.

Parameters

string $text input text

Return Value

string output HTML code

at line 428
string processTypo(string $text)

Makes only typographic corrections.

Parameters

string $text input text

Return Value

string output text

at line 447
string toText()

Converts DOM structure to pure text.

Return Value

string

at line 460
final string stringToHtml(string $s)

Converts internal string representation to final HTML code.

Parameters

string $s

Return Value

string

at line 499
final string stringToText(string $s)

Converts internal string representation to final HTML code.

Parameters

string $s

Return Value

string

at line 529
final void addHandler(string $event, callable $callback)

Add new event handler.

Parameters

string $event
callable $callback

Return Value

void

at line 539
final mixed invokeAroundHandlers(string $event, Parser $parser, array $args)

Invoke registered around-handlers.

Parameters

string $event
Parser $parser
array $args

Return Value

mixed

at line 553
final void invokeHandlers(string $event, array $args)

Invoke registered after-handlers.

Parameters

string $event
array $args

Return Value

void

at line 568
final string protect(string $child, string $contentType)

Generate unique mark - useful for freezing (folding) some substrings.

Parameters

string $child
string $contentType

Return Value

string

at line 588
final bool checkURL(string $URL, string $type)

Filters bad URLs.

Parameters

string $URL
string $type

Return Value

bool

at line 597
final string unProtect(string $html)

Parameters

string $html

Return Value

string

at line 603
final array getLinePatterns()

Return Value

array

at line 609
final array getBlockPatterns()

Return Value

array

at line 615
final HtmlElement getDOM()

Return Value

HtmlElement

at line 621
final __clone()

at line 628
final static string freezeSpaces(string $s) deprecated

deprecated

Parameters

string $s

Return Value

string

at line 636
final static string unfreezeSpaces(string $s) deprecated

deprecated

Parameters

string $s

Return Value

string

at line 644
final static string normalize(string $s) deprecated

deprecated

Parameters

string $s

Return Value

string

at line 652
final static string webalize(string $s, string $charlist = null) deprecated

deprecated

Parameters

string $s
string $charlist

Return Value

string

at line 660
final static string escapeHtml(string $s) deprecated

deprecated

Parameters

string $s

Return Value

string

at line 668
final static string unescapeHtml(string $s) deprecated

deprecated

Parameters

string $s

Return Value

string

at line 676
final static string outdent(string $s) deprecated

deprecated

Parameters

string $s

Return Value

string

at line 684
final static bool isRelative(string $URL) deprecated

deprecated

Parameters

string $URL

Return Value

bool

at line 692
final static string prependRoot(string $URL, string $root) deprecated

deprecated

Parameters

string $URL
string $root

Return Value

string