Trait cebe\markdown\block\ListTrait

Implemented bycebe\markdown\GithubMarkdown, cebe\markdown\Markdown, cebe\markdown\MarkdownExtra, cebe\markdown\latex\GithubMarkdown, cebe\markdown\latex\Markdown

Adds the list blocks

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$keepListStartNumber bool Enable support start attribute of ordered lists. cebe\markdown\block\ListTrait

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
consumeOl() Consume lines for an ordered list cebe\markdown\block\ListTrait
consumeUl() Consume lines for an unordered list cebe\markdown\block\ListTrait
identifyOl() Identify a line as the beginning of an ordered list. cebe\markdown\block\ListTrait
identifyUl() Identify a line as the beginning of an unordered list. cebe\markdown\block\ListTrait
parseInline() cebe\markdown\block\ListTrait
renderAbsy() cebe\markdown\block\ListTrait
renderList() Renders a list cebe\markdown\block\ListTrait

Property Details

$keepListStartNumber public property

Enable support start attribute of ordered lists. This means that lists will start with the number you actually type in markdown and not the HTML generated one. Defaults to false which means that numeration of all ordered lists(

    ) starts with 1.

public bool $keepListStartNumber false

Method Details

consumeOl() protected method

Consume lines for an ordered list

protected void consumeOl ( $lines, $current )
$lines
$current
consumeUl() protected method

Consume lines for an unordered list

protected void consumeUl ( $lines, $current )
$lines
$current
identifyOl() protected method

Identify a line as the beginning of an ordered list.

protected void identifyOl ( $line )
$line
identifyUl() protected method

Identify a line as the beginning of an unordered list.

protected void identifyUl ( $line )
$line
parseInline() protected abstract method

protected abstract void parseInline ( $text )
$text
renderAbsy() protected abstract method

protected abstract void renderAbsy ( $absy )
$absy
renderList() protected method

Renders a list

protected void renderList ( $block )
$block