PHP Class Texy\Modules\HeadingModule

Inheritance: extends Texy\Module
Datei anzeigen Open project: dg/texy

Public Properties

Property Type Description
$TOC generated Table of Contents
$balancing balancing mode
$generateID autogenerate ID
$idPrefix prefix for autogenerated ID
$levels when $balancing = HeadingModule::FIXED
$moreMeansHigher surrounded headings: more #### means higher heading
$title textual content of first heading
$top level of top heading, 1..6

Public Methods

Method Description
__construct ( $texy )
afterParse ( Texy $texy, HtmlElement $DOM, $isSingleLine ) : void
beforeParse ( )
patternSurround ( BlockParser $parser, array $matches ) : HtmlElement | string | FALSE Callback for surrounded heading.
patternUnderline ( BlockParser $parser, array $matches ) : HtmlElement | string | FALSE Callback for underlined heading.
solve ( HandlerInvocation $invocation, $level, $content, Modifier $mod, $isSurrounded ) : HtmlElement Finish invocation.

Method Details

__construct() public method

public __construct ( $texy )

afterParse() public method

public afterParse ( Texy $texy, HtmlElement $DOM, $isSingleLine ) : void
$texy Texy
$DOM Texy\HtmlElement
return void

beforeParse() public method

public beforeParse ( )

patternSurround() public method

### Heading .(title)[class]{style}>
public patternSurround ( BlockParser $parser, array $matches ) : HtmlElement | string | FALSE
$parser Texy\BlockParser
$matches array
return Texy\HtmlElement | string | FALSE

patternUnderline() public method

Heading .(title)[class]{style}> -------------------------------
public patternUnderline ( BlockParser $parser, array $matches ) : HtmlElement | string | FALSE
$parser Texy\BlockParser
$matches array
return Texy\HtmlElement | string | FALSE

solve() public method

Finish invocation.
public solve ( HandlerInvocation $invocation, $level, $content, Modifier $mod, $isSurrounded ) : HtmlElement
$invocation Texy\HandlerInvocation
$mod Texy\Modifier
return Texy\HtmlElement

Property Details

$TOC public_oe property

generated Table of Contents
public $TOC

$balancing public_oe property

balancing mode
public $balancing

$generateID public_oe property

autogenerate ID
public $generateID

$idPrefix public_oe property

prefix for autogenerated ID
public $idPrefix

$levels public_oe property

when $balancing = HeadingModule::FIXED
public $levels

$moreMeansHigher public_oe property

surrounded headings: more #### means higher heading
public $moreMeansHigher

$title public_oe property

textual content of first heading
public $title

$top public_oe property

level of top heading, 1..6
public $top