HumHub Documentation (unofficial)

ProsemirrorRichText extends AbstractRichText

in package

• Application

The ProsemirrorRichText is a [Prosemirror](https://prosemirror.net) and [Markdown-it](https://github.com/markdown-it/markdown-it) based rich text implementation.

RichText::output($text, [
    'preset' => 'myPreset',
    'pluginOptions' => [
        'anchors' => true
    ]
]);

// or with specific settings
RichText::output($text, [
    'preset' => 'myPreset',
    'pluginOptions' => [
        'anchors' => ['permalink' => true]
    ]
]);

Tags

author

Julian Harrer julian.harrer@humhub.com

see

https://github.com/humhub/humhub-prosemirror

for more information about the prosemirror-richtext client implementation

see

https://prosemirror.net/docs/

Prosemirror documentation

see

https://github.com/markdown-it/markdown-it

markdown-it repository

since

1.3

Table of Contents

Constants

EVENT_AFTER_OUTPUT  = 'afterOutput'

EVENT_AFTER_RUN  = 'afterRun'

EVENT_BEFORE_OUTPUT  = 'beforeOutput'

EVENT_BEFORE_RUN  = 'beforeRun'

EVENT_CREATE  = 'create'

EVENT_INIT  = 'init'

EVENT_POST_PROCESS  = 'postProcess'

FORMAT_HTML  = 'html'

Converter output format for html output

FORMAT_MARKDOWN  = 'markdown'

Converter output format for markdown output

FORMAT_PLAINTEXT  = 'plaintext'

Converter output format for plaintext output

FORMAT_SHORTTEXT  = 'shorttext'

Short text format used in previews as notifications and activities.

Properties

$autoIdPrefix  : string

$behaviors  : array<string|int, Behavior>

$container  : string

$content  : string

$edit  : bool

$encode  : bool

$events  : mixed

Event action handler.

$exclude  : array<string|int, mixed>

$fadeIn  : bool|string|int

If set to true or 'fast', 'slow' or a integer duration in milliseconds the jsWidget will fade in the root element after initialization.

$id  : string

Defines the select input field id

$id  : string|null

$include  : array<string|int, mixed>

$init  : mixed

Auto init flag.

$jsWidget  : mixed

$options  : mixed

$pluginOptions  : array<string|int, mixed>

$preset  : string

$record  : mixed

$render  : bool

$text  : string

$view  : View

$view  : View

$viewPath  : string

$visible  : bool

Used to hide/show the actual input element.

$widgetLayout  : string

$converterClass  : string

$editorClass  : string

$extensions  : array<string|int, string>

$_behaviors  : array<string|int, Behavior>|null

$_events  : array<string|int, mixed>

$_eventWildcards  : array<string|int, mixed>

$_id  : mixed

$_view  : mixed

Methods

__call()  : mixed

Calls the named method which is not a class method.

__clone()  : mixed

This method is called after the object is created by cloning an existing one.

__construct()  : mixed

Constructor.

__get()  : mixed

Returns the value of a component property.

__isset()  : bool

Checks if a property is set, i.e. defined and not null.

__set()  : mixed

Sets the value of a component property.

__unset()  : mixed

Sets a component property to be null.

addExtension()  : mixed

afterRun()  : mixed

This method is invoked right after a widget is executed.

attachBehavior()  : Behavior

Attaches a behavior to this component.

attachBehaviors()  : mixed

Attaches a list of behaviors to the component.

beforeRun()  : bool

This method is invoked right before the widget is executed.

begin()  : static

Begins a widget.

behaviors()  : array<string|int, mixed>

Returns a list of behaviors that this component should behave as.

canGetProperty()  : bool

Returns a value indicating whether a property can be read.

canSetProperty()  : bool

Returns a value indicating whether a property can be set.

className()  : string

Returns the fully qualified name of this class.

convert()  : string

Converts the richtext content to a given output format.

detachBehavior()  : Behavior|null

Detaches a behavior from the component.

detachBehaviors()  : mixed

Detaches all behaviors from the component.

editorWidget()  : string

end()  : static

Ends a widget.

ensureBehaviors()  : mixed

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.

getBehavior()  : Behavior|null

Returns the named behavior object.

getBehaviors()  : array<string|int, Behavior>

Returns all behaviors attached to this component.

getConverter()  : AbstractRichTextConverter

getConverterClass()  : string

getData()  : mixed

Returns an array of data-* attributes to configure your clientside js widget.

getEditorClass()  : string

getExtensions()  : array<string|int, RichTextExtension>

getId()  : string

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).

getLayoutViewParams()  : array<string|int, mixed>

Returns an array of view parameter used if [[layout]] is set.

getView()  : View

Returns the view object that can be used to render views or view files.

getViewPath()  : string

Returns the directory containing the view files for this widget.

hasEventHandlers()  : bool

Returns a value indicating whether there is any handler attached to the named event.

hasMethod()  : bool

Returns a value indicating whether a method is defined.

hasProperty()  : bool

Returns a value indicating whether a property is defined for this component.

init()  : mixed

Initializes the object.

off()  : bool

Detaches an existing event handler from this component.

on()  : mixed

Attaches an event handler to an event.

output()  : string

Renders the given text by means of the given config.

postProcess()  : array<string|int, mixed>

Used for the post-processing of the rich text, normally called within [[ContentActiveRecord::afterSave()]] of the related [[ContentActiveRecord]].

preview()  : string

Renders the given text in minimal render mode truncated by the `maxLength` parameter.

process()  : mixed

Process is a wrapper for the run method

render()  : string

Renders a view.

renderFile()  : string

Renders a view file.

run()  : string

Default implementation of JsWidget.

setDefaultOptions()  : mixed

Sets some default data options required by all widgets as the widget implementation and the widget events and initialization trigger.

setId()  : mixed

Sets the ID of the widget.

setView()  : mixed

Sets the view object to be used by this widget.

trigger()  : mixed

Triggers an event.

widget()  : string

Creates a widget instance and runs it.

getAttributes()  : mixed

Returns all html attributes for used by this widget and will normally inserted in the widgets root html element.

getOptions()  : array<string|int, mixed>

Assembles all widget attributes and data settings of this widget.

attachBehaviorInternal()  : Behavior

Attaches a behavior to this component.

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

function ($event)

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});