ILIAS\Data\Text\Shape Interface Reference

Methods in this interface should mostly be called by the according methods on Text instances, most consumer code shouldn't need to bother with Shape directly. More...

Inheritance diagram for ILIAS\Data\Text\Shape:

Collaboration diagram for ILIAS\Data\Text\Shape:

Public Member Functions
	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 ()

Detailed Description

Methods in this interface should mostly be called by the according methods on Text instances, most consumer code shouldn't need to bother with Shape directly.

Only exception is fromString which acts as an entrypoint into the logic of Text.

Definition at line 34 of file Shape.php.

Member Function Documentation

fromString()

ILIAS\Data\Text\Shape::fromString

(

string

$text

)

Exceptions

InvalidArgumentException if $text is not compliant.

Implemented in ILIAS\Data\Text\Shape\Markdown.

getMarkup()

ILIAS\Data\Text\Shape::getMarkup

(

)

Implemented in ILIAS\Data\Text\Shape\Markdown.

isRawStringCompliant()

ILIAS\Data\Text\Shape::isRawStringCompliant

(

string

$text

)

Implemented in ILIAS\Data\Text\Shape\Markdown.

Referenced by ILIAS\Data\Text\TextBase\__construct().

Here is the caller graph for this function:

toHTML()

ILIAS\Data\Text\Shape::toHTML

(

Text

$text

)

It should almost never be required to call this directly on shape.

There is an according method on the Text interface, which should be prefered as it guarantees to use the correct Shape. This method still is on Shape for code organisation reasons: Shape binds all transformations between formats together.

Exceptions

LogicException if $text does not match this shape.

toPlainText()

ILIAS\Data\Text\Shape::toPlainText

(

Text

$text

)

It should almost never be required to call this directly on shape.

There is an according method on the Text interface, which should be prefered as it guarantees to use the correct Shape. This method still is on Shape for code organisation reasons: Shape binds all transformations between formats together.

Exceptions

LogicException if $text does not match this shape.

---

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

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