ILIAS\Refinery\String\MarkdownFormattingToHTML Class Reference

This class provides a transformation that converts Markdown formatting to HTML using the CommonMark Library. More...

Collaboration diagram for ILIAS\Refinery\String\MarkdownFormattingToHTML:

Public Member Functions
	__construct (bool $escape=true)
	toHTML ()
	Returns the converted Markdown with HTML tags. More...

Private Attributes
MarkdownConverter	$converter

Detailed Description

This class provides a transformation that converts Markdown formatting to HTML using the CommonMark Library.

Definition at line 32 of file MarkdownFormattingToHTML.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\String\MarkdownFormattingToHTML::__construct

(

bool

$escape = true

)

Definition at line 36 of file MarkdownFormattingToHTML.php.

    {
        $config = [
            'html_input' => 'escape',
            'renderer' => [
                'soft_break' => "<br/>"
            ],
            'allow_unsafe_links' => false,
            'max_nesting_level' => 42 // https://commonmark.thephpleague.com/1.5/security/#nesting-level
        ];
 
        $environment = new Environment($config);
        $environment->addExtension(new CommonMarkCoreExtension());
        $this->converter = new MarkDownConverter($environment);
    }

Member Function Documentation

toHTML()

ILIAS\Refinery\String\MarkdownFormattingToHTML::toHTML

(

)

Returns the converted Markdown with HTML tags.

Definition at line 55 of file MarkdownFormattingToHTML.php.

                            : Transformation
    {
        return new \ILIAS\Refinery\Custom\Transformation(
            fn($value) => $this->converter->convert($value)->getContent()
        );
    }

Field Documentation

$converter

MarkdownConverter ILIAS\Refinery\String\MarkdownFormattingToHTML::$converter

private

Definition at line 34 of file MarkdownFormattingToHTML.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Refinery/src/String/MarkdownFormattingToHTML.php