ILIAS\Data\Text\TextBase Class Reference

Inheritance diagram for ILIAS\Data\Text\TextBase:

Collaboration diagram for ILIAS\Data\Text\TextBase:

Public Member Functions
	__construct (protected Shape $shape, protected string $raw)
	getShape ()
	getMarkup ()
	getSupportedStructure ()
	toHTML ()
	toPlainText ()
	getRawRepresentation ()
	getShape ()
	getMarkup ()
	getSupportedStructure ()
	toHTML ()
	toPlainText ()
	getRawRepresentation ()

Detailed Description

Definition at line 23 of file TextBase.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Data\Text\TextBase::__construct	(	protected Shape	$shape,
		protected string	$raw
	)

Definition at line 25 of file TextBase.php.

      {
        if (!$shape->isRawStringCompliant($raw)) {
            throw new \InvalidArgumentException("The provided string is not compliant with the supported structure!");
        }
    }

References ILIAS\Data\Text\Shape\isRawStringCompliant().

Here is the call graph for this function:

Member Function Documentation

getMarkup()

ILIAS\Data\Text\TextBase::getMarkup

(

)

Implements ILIAS\Data\Text\Text.

Definition at line 39 of file TextBase.php.

                               : Markup
    {
        return $this->shape->getMarkup();
    }

getRawRepresentation()

ILIAS\Data\Text\TextBase::getRawRepresentation

(

)

Implements ILIAS\Data\Text\Text.

Definition at line 62 of file TextBase.php.

                                          : string
    {
        return $this->raw;
    }

getShape()

ILIAS\Data\Text\TextBase::getShape

(

)

Implements ILIAS\Data\Text\Text.

Definition at line 34 of file TextBase.php.

                              : Shape
    {
        return $this->shape;
    }

getSupportedStructure()

ILIAS\Data\Text\TextBase::getSupportedStructure

(

)

Returns

Structure[]

Implements ILIAS\Data\Text\Text.

Reimplemented in ILIAS\Data\Text\Shape\SimpleDocumentMarkdown, and ILIAS\Data\Text\Shape\WordOnlyMarkdown.

Definition at line 47 of file TextBase.php.

                                           : array
    {
        return $this->shape->getSupportedStructure();
    }

toHTML()

ILIAS\Data\Text\TextBase::toHTML

(

)

Implements ILIAS\Data\Text\Text.

Definition at line 52 of file TextBase.php.

                            : HTML
    {
        return $this->shape->toHTML($this);
    }

toPlainText()

ILIAS\Data\Text\TextBase::toPlainText

(

)

Implements ILIAS\Data\Text\Text.

Definition at line 57 of file TextBase.php.

                                 : PlainText
    {
        return $this->shape->toPlainText($this);
    }

---

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

• components/ILIAS/Data/src/Text/TextBase.php