Ciconia / A New Markdown Parser for #PHP

class Ciconia

Ciconia - The New Markdown Parser

This is just the central point to manage renderer and extensions.

The Core extensions are based on Markdown.pl The Gfm extensions are based on Github Flavored Markdown

Constants

VERSION

Version number

Methods

__construct(RendererInterface $renderer = null)

Constructor

string render(string $text, array $options = array())
Ciconia setRenderer(RendererInterface $renderer)
RendererInterface getRenderer()
Ciconia addExtension(ExtensionInterface $extension)
Ciconia addExtensions(array $extensions)
Ciconia removeExtension(string|object $extension)
boolean hasExtension(string|object $extension)

Details

at line 47 public __construct(RendererInterface $renderer = null)

Constructor

Parameters

RendererInterface $renderer

at line 67 public string render(string $text, array $options = array())

Parameters

string $text The markdown content
array $options An array of options

Return Value

string

at line 86 public Ciconia setRenderer(RendererInterface $renderer)

Parameters

RendererInterface $renderer

Return Value

Ciconia

at line 96 public RendererInterface getRenderer()

Return Value

RendererInterface

at line 106 public Ciconia addExtension(ExtensionInterface $extension)

Parameters

ExtensionInterface $extension

Return Value

Ciconia

at line 118 public Ciconia addExtensions(array $extensions)

Parameters

array $extensions

Return Value

Ciconia

at line 132 public Ciconia removeExtension(string|object $extension)

Parameters

string|object $extension

Return Value

Ciconia

at line 148 public boolean hasExtension(string|object $extension)

Parameters

string|object $extension

Return Value

boolean