ILIAS\Data\Text\Shape\SimpleDocumentMarkdown Class Reference

Inheritance diagram for ILIAS\Data\Text\Shape\SimpleDocumentMarkdown:

Collaboration diagram for ILIAS\Data\Text\Shape\SimpleDocumentMarkdown:

Public Member Functions
	getSupportedStructure ()
	fromString (string $text)
	isRawStringCompliant (string $text)
Public Member Functions inherited from ILIAS\Data\Text\Shape\Markdown
	__construct (Refinery\String\MarkdownFormattingToHTML $markdown_to_html,)
	toHTML (Text\Text $text)
	toPlainText (Text\Text $text)
	getMarkup ()
	fromString (string $text)
	isRawStringCompliant (string $text)
Public Member Functions inherited from ILIAS\Data\Text\Shape
	toHTML (Text $text)
	It should almost never be required to call this directly on shape. More...
	toPlainText (Text $text)
	It should almost never be required to call this directly on shape. More...

Additional Inherited Members
Protected Attributes inherited from ILIAS\Data\Text\Shape\Markdown
Refinery Transformation	$markdown_to_html_transformation

Detailed Description

Definition at line 27 of file SimpleDocumentMarkdown.php.

Member Function Documentation

fromString()

ILIAS\Data\Text\Shape\SimpleDocumentMarkdown::fromString

(

string

$text

)

Exceptions

Implements ILIAS\Data\Text\Shape.

Definition at line 52 of file SimpleDocumentMarkdown.php.

Referenced by ILIAS\Data\Text\MarkdownFactory\simpleDocument().

                                            : Text\SimpleDocumentMarkdown
    {
        return new Text\SimpleDocumentMarkdown($this, $text);
    }

Here is the caller graph for this function:

getSupportedStructure()

ILIAS\Data\Text\Shape\SimpleDocumentMarkdown::getSupportedStructure

(

)

Returns

Structure[]

Definition at line 32 of file SimpleDocumentMarkdown.php.

References ILIAS\Data\Text\CODE.

                                           : array
    {
        return [
            Structure::BOLD,
            Structure::ITALIC,
            Structure::HEADING_1,
            Structure::HEADING_2,
            Structure::HEADING_3,
            Structure::HEADING_4,
            Structure::HEADING_5,
            Structure::HEADING_6,
            Structure::UNORDERED_LIST,
            Structure::ORDERED_LIST,
            Structure::PARAGRAPH,
            Structure::LINK,
            Structure::BLOCKQUOTE,
            Structure::CODE
        ];
    }

isRawStringCompliant()

ILIAS\Data\Text\Shape\SimpleDocumentMarkdown::isRawStringCompliant

(

string

$text

)

Implements ILIAS\Data\Text\Shape.

Definition at line 57 of file SimpleDocumentMarkdown.php.

                                                      : bool
    {
        $options = mb_regex_set_options();
        try {
            mb_regex_set_options("m");
            return !mb_ereg_match(
                '.*((' . MRE::IMAGE->value . ')|(' . MRE::REF->value . ')|(' . MRE::IMAGE_REF_USAGE->value . '))',
                $text
            );
        } finally {
            mb_regex_set_options($options);
        }
    }

---

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

• components/ILIAS/Data/src/Text/Shape/SimpleDocumentMarkdown.php