Class humhub\modules\content\widgets\richtext\RichTextField

Inheritancehumhub\modules\content\widgets\richtext\RichTextField » humhub\modules\content\widgets\richtext\AbstractRichTextEditor » humhub\modules\ui\form\widgets\JsInputWidget » humhub\widgets\JsWidget » humhub\components\Widget » yii\base\Widget

The RichTextField widget will render a rich text input element.

This class acts as wrapper around the actual humhub\modules\content\widgets\richtext\AbstractRichTextEditor implementation, which can either be set by the widget configuration class or globally by the richText configuration parameter.

The following line adds a rich text input field rendered by the globally configured rich text to a form:

$form->field($model, 'richTextField')->widget(RichTextField::class);

See also humhub\modules\content\widgets\richtext\RichText for more information about the usage of rich texts.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attribute string The model attribute that this widget is associated with. humhub\modules\ui\form\widgets\JsInputWidget
$container string Html container element. humhub\widgets\JsWidget
$content string Html content. humhub\widgets\JsWidget
$disabled boolean humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$disabledText string humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$events [] humhub\widgets\JsWidget
$exclude array humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$fadeIn boolean|string|integer humhub\widgets\JsWidget
$focus boolean humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$form \yii\widgets\ActiveForm humhub\modules\ui\form\widgets\JsInputWidget
$id string humhub\widgets\JsWidget
$include array humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$init mixed humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$jsWidget string humhub\widgets\JsWidget
$label boolean Defines if the default label should be rendered. humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$layout string Defines the style/layout of the richtext humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$mentioningUrl string humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$model \yii\base\Model The data model that this widget is associated with. humhub\modules\ui\form\widgets\JsInputWidget
$name string The input name. humhub\modules\ui\form\widgets\JsInputWidget
$options array The HTML attributes for the input tag. humhub\modules\ui\form\widgets\JsInputWidget
$placeholder string humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$pluginOptions array humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$preset string Richtext feature preset e. humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$render boolean If set to false this widget won't be rendered humhub\components\Widget
$renderer [] Renderer class definition humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$value string The input value. humhub\modules\ui\form\widgets\JsInputWidget
$visible boolean humhub\modules\content\widgets\richtext\AbstractRichTextEditor
$widgetLayout string Defines an optional layout humhub\components\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
beforeRun() Initializes the widget. humhub\modules\ui\form\widgets\JsInputWidget
getData() Returns an array of data-* attributes to configure your clientside js widget. humhub\modules\content\widgets\richtext\AbstractRichTextEditor
getId() Returns the html id of this widget, if no id is set this function will generate an id if $autoGenerate is set to true (default). humhub\widgets\JsWidget
getInputAttributes() humhub\modules\content\widgets\richtext\AbstractRichTextEditor
getLabel() humhub\modules\content\widgets\richtext\AbstractRichTextEditor
getLayoutViewParams() Returns an array of view parameter used if \humhub\components\layout is set. humhub\components\Widget
getMentioningUrl() humhub\modules\content\widgets\richtext\AbstractRichTextEditor
prepend() This method can be overwritten in order to prepend content after the actual rich text content. humhub\modules\content\widgets\richtext\AbstractRichTextEditor
process() Process is a wrapper for the run method humhub\components\Widget
run() humhub\modules\content\widgets\richtext\AbstractRichTextEditor
setDefaultOptions() Sets some default data options required by all widgets as the widget implementation and the widget events and initialization trigger. humhub\widgets\JsWidget
widget() Creates a widget instance and runs it. humhub\modules\content\widgets\richtext\RichTextField

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
editOutput() Returns the content formatted for editing by means of the configured $renderer. humhub\modules\content\widgets\richtext\AbstractRichTextEditor
getAttributes() Returns all html attributes for used by this widget and will normally inserted in the widgets root html element. humhub\widgets\JsWidget
getOptions() Assembles all widget attributes and data settings of this widget. humhub\widgets\JsWidget
getValue() humhub\modules\ui\form\widgets\JsInputWidget
hasModel() humhub\modules\ui\form\widgets\JsInputWidget

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_CREATE humhub\libs\WidgetCreateEvent An event raised before creating a widget. humhub\components\Widget

Method Details

widget() public static method

Creates a widget instance and runs it.

The widget rendering result is returned by this method.

public static string widget ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

return string

The rendering result of the widget.

throws Exception