ILIAS\Data\Text\Shape\Markdown Class Reference

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

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

Public Member Functions
	__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
	fromString (string $text)
	isRawStringCompliant (string $text)
	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...
	getMarkup ()

Protected Attributes
Refinery Transformation	$markdown_to_html_transformation

Detailed Description

Definition at line 28 of file Markdown.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Data\Text\Shape\Markdown::__construct

(

Refinery\String\MarkdownFormattingToHTML

$markdown_to_html

)

Definition at line 32 of file Markdown.php.

      {
        $this->markdown_to_html_transformation = $markdown_to_html->toHTML();
    }

Member Function Documentation

fromString()

ILIAS\Data\Text\Shape\Markdown::fromString

(

string

$text

)

Exceptions

InvalidArgumentException if $text is not compliant.

Implements ILIAS\Data\Text\Shape.

Definition at line 63 of file Markdown.php.

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

References $text.

getMarkup()

ILIAS\Data\Text\Shape\Markdown::getMarkup

(

)

Implements ILIAS\Data\Text\Shape.

Definition at line 58 of file Markdown.php.

                               : Markup\Markdown
    {
        return new Markup\Markdown();
    }

isRawStringCompliant()

ILIAS\Data\Text\Shape\Markdown::isRawStringCompliant

(

string

$text

)

Implements ILIAS\Data\Text\Shape.

Definition at line 68 of file Markdown.php.

                                                      : bool
    {
        return true;
    }

toHTML()

ILIAS\Data\Text\Shape\Markdown::toHTML

(

Text\Text

$text

)

Definition at line 38 of file Markdown.php.

                                           : Text\HTML
    {
        if (!$text instanceof Text\Markdown) {
            throw new \LogicException("Text does not match format.");
        }
        return new Text\HTML(
            $this->markdown_to_html_transformation->transform(
                $text->getRawRepresentation()
            )
        );
    }

References $text.

toPlainText()

ILIAS\Data\Text\Shape\Markdown::toPlainText

(

Text\Text

$text

)

Definition at line 50 of file Markdown.php.

                                                : Text\PlainText
    {
        if (!$text instanceof Text\Markdown) {
            throw new \LogicException("Text does not match format.");
        }
        return new Text\PlainText($text->getRawRepresentation());
    }

References $text.

Field Documentation

$markdown_to_html_transformation

Refinery Transformation ILIAS\Data\Text\Shape\Markdown::$markdown_to_html_transformation

protected

Definition at line 30 of file Markdown.php.

---

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

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