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
League CommonMark CommonMarkConverter	$converter

Detailed Description

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

Definition at line 28 of file MarkdownFormattingToHTML.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\String\MarkdownFormattingToHTML::__construct

(

bool

$escape = true

)

Definition at line 32 of file MarkdownFormattingToHTML.php.

    {
        $config = [
            'allow_unsafe_links' => false,
            'max_nesting_level' => 42 // https://commonmark.thephpleague.com/1.5/security/#nesting-level
        ];

        if ($escape === true) {
            $config['html_input'] = 'escape';
        }

        $this->converter = new \League\CommonMark\CommonMarkConverter($config);
    }

Member Function Documentation

toHTML()

ILIAS\Refinery\String\MarkdownFormattingToHTML::toHTML

(

)

Returns the converted Markdown with HTML tags.

Definition at line 49 of file MarkdownFormattingToHTML.php.

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

Field Documentation

$converter

League CommonMark CommonMarkConverter ILIAS\Refinery\String\MarkdownFormattingToHTML::$converter

private

Definition at line 30 of file MarkdownFormattingToHTML.php.

---

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

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