1. class
  2. Inphinit
  3. \
  4. Experimental
  5. \
  6. Utility
  7. \
  8. Markdown

Markdown

class Markdown (View source)

Constants

BLOCKQUOTE

CODE_BLOCK

H1

H2

H3

H4

H5

H6

HR

ANCHOR

ANCHOR_TITLE

FIGURE

FIGURE_CAPTION

OL

UL

BOLD

CODE

ITALIC

STRIKETHROUGH

TABLE

TASK

TASK_DONE

SUBSCRIPT

SUPERSCRIPT

Methods

__construct(bool $enableCustom = true)

No description

enableErrors(bool $enable)

Enable/disable parse errors

enableHtml(bool $enable)

Enable/disable use HTML in markdown body

setTemplate(int $type, string $template)

Set HTML template

setCustomInline(string $delimiter, string $template)

Set custom inline HTML template

string
fromString(string $input)

Convert a markdown string into an HTML string with paragraphs

string
fromInlineString(string $input)

Convert a markdown string into an HTML string (inline) without paragraphs

string
fromFile(string $path)

Convert a markdown file into an HTML string with paragraphs

Details

at line 71
__construct(bool $enableCustom = true)

No description

Parameters

bool $enableCustom

Enable/disable non-standard inline syntaxes:

  • !!highlight!! -> highlight
  • %%variable%% -> variable
  • ++inserted++ -> inserted
  • --deleted-- -> deleted

at line 126
enableErrors(bool $enable)

Enable/disable parse errors

Parameters

bool $enable

at line 136
enableHtml(bool $enable)

Enable/disable use HTML in markdown body

Parameters

bool $enable

at line 147
setTemplate(int $type, string $template)

Set HTML template

Parameters

int $type
string $template

at line 158
setCustomInline(string $delimiter, string $template)

Set custom inline HTML template

Parameters

string $delimiter
string $template

at line 174
string fromString(string $input)

Convert a markdown string into an HTML string with paragraphs

Parameters

string $input

Return Value

string

Exceptions

Exception

at line 192
string fromInlineString(string $input)

Convert a markdown string into an HTML string (inline) without paragraphs

Parameters

string $input

Return Value

string

Exceptions

Exception

at line 208
string fromFile(string $path)

Convert a markdown file into an HTML string with paragraphs

Parameters

string $path

Return Value

string

Exceptions

Exception