Documentation

MarkdownInputWithFrontMatter extends MarkdownInput
in package
implements FrontMatterProviderInterface

FinalYes

Table of Contents

Interfaces

FrontMatterProviderInterface

Properties

$frontMatter  : mixed|null

Methods

__construct()  : mixed
getContent()  : string
getFrontMatter()  : mixed|null
getLineCount()  : int
getLines()  : iterable<int, string>

Properties

Methods

__construct()

public __construct(string $content[, int $lineOffset = 0 ][, mixed|null $frontMatter = null ]) : mixed
Parameters
$content : string

Markdown content without the raw front matter

$lineOffset : int = 0

Line offset (based on number of front matter lines removed)

$frontMatter : mixed|null = null

Parsed front matter

getContent()

public getContent() : string
Return values
string

getLineCount()

public getLineCount() : int
Return values
int

getLines()

public getLines() : iterable<int, string>
Return values
iterable<int, string>

        
On this page

Search results