Abstract Class humhub\modules\content\widgets\richtext\AbstractRichText

AbstractRichText serves as the base class for rich text implementations.

A rich text Widget is used for rendering the output of a rich text and usually is related to an humhub\modules\content\widgets\richtext\AbstractRichTextEditor implementation defined by $editorClass and an humhub\modules\content\widgets\richtext\AbstractRichTextProcessor implementation for post-processing rich texts defined by $processorClass.

In order for some features as the Mentionings to work a rich text should only be used for humhub\modules\content\components\ContentActiveRecord or humhub\modules\content\components\ContentAddonActiveRecord models.

A rich text can implement the following core features:

• $preset defines a preset of plugins and settings
• $include and exclude specific plugins
• $pluginOptions configure specific plugins
• $minimal rendering mode used e.g. for activities and mails, should truncate the input by means of the \humhub\modules\content\widgets\richtext\maxLenght option
• $edit rendering mode used for rendering the rich text in a format interpretable by the editor

Common rich text plugins are Mentionings, Oembed and text formatting features.

It's up to the implementation which features or plugins are supported.

After saving the related record of a rich text the postProcess() function should be called manually in order to parse the rich text e.g. for Mentionings or other features etc. This usually happens in the humhub\modules\content\components\ContentActiveRecord::afterSave() function of the record.

Furthermore the output() function can be used as convenience function to render a given text.

$richText = RichText::output($text, $options) ?>

Note: Subclasses provided by third party modules should ideally be compatible with the default implementation in order to be able to switch the RichText implementation without loosing the semantic.