HumHub Documentation (unofficial)

AbstractRichTextConverter extends BaseObject
in package

AbstractYes

AbstractRichTextConverter classes are used to translate the richtext content to other formats. This class is responsible for converting the base richtext format to other formats. Implementations of this interface at least need to implement the `convertToPlaintext()` function. If a format other than plaintext is not supported the implementation should fallback to an encoded version of `convertToPlaintext()`.

Tags
author

Julian Harrer julian.harrer@humhub.com

since
1.8

Table of Contents

Methods

__call()  : mixed
Calls the named method which is not a class method.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of an object property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets value of an object property.
__unset()  : mixed
Sets an object property to null.
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.
convertToHtml()  : string
Converts the given rich-text content to HTML.
convertToMarkdown()  : mixed
Converts the given rich-text content to plain markdown.
convertToPlaintext()  : mixed
Converts the given rich-text content to non html encoded plain text.
convertToShortText()  : mixed
Converts the given rich-text content to html encoded short text preview. The short text should not contain any html elements.
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined.
init()  : mixed
Initializes the object.

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call [[init()]].

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
Parameters
$config : array<string|int, mixed> = []

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

__get()

Returns the value of an object property.

public __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
Return values
mixed —

the property value

__isset()

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

public __isset(string $name) : bool

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set (not null).

__set()

Sets value of an object property.

public __set(string $name, mixed $value) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__unset()

Sets an object property to null.

public __unset(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ]) : bool

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ]) : bool

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

convertToHtml()

Converts the given rich-text content to HTML.

public abstract convertToHtml(mixed $content[, array<string|int, mixed> $options = [] ]) : string

If $minimal = true (default) the HTML result should only support a minimal set HTML text features and avoid embedding complex elements as oembeds or iframes. Minimal output may be used in mails and previews.

If not supported, this function should at least return a HTML encoded version of convertToPlaintext()

The $options array may be used to manipulate the result e.g. by exluding/including richtext features. The supported options may differ between richtext implementations.

Parameters
$content : mixed

richtext content

$options : array<string|int, mixed> = []
Return values
string

convertToMarkdown()

Converts the given rich-text content to plain markdown.

public abstract convertToMarkdown(string $content[, array<string|int, mixed> $options = [] ]) : mixed

If richtext format is already based on markdown, this function is merely responsible for removing richtext specific markdown extensions as oembeds, mentionings, emojis.

If not supported, this function should at least return a HTML encoded version of convertToPlaintext()

The $options array may be used to manipulate the result e.g. by exluding/including richtext features. The supported options may differ between richtext implementations.

Parameters
$content : string
$options : array<string|int, mixed> = []

convertToPlaintext()

Converts the given rich-text content to non html encoded plain text.

public abstract convertToPlaintext(string $content[, array<string|int, mixed> $options = [] ]) : mixed

A proper implementation of this function is mandatory.

The $options array may be used to manipulate the result. The supported options may differ between richtext implementations.

Parameters
$content : string
$options : array<string|int, mixed> = []

convertToShortText()

Converts the given rich-text content to html encoded short text preview. The short text should not contain any html elements.

public abstract convertToShortText(string $content[, array<string|int, mixed> $options = [] ]) : mixed

A proper implementation of this function is mandatory.

The $options array may be used to manipulate the result. This converter should support a maxLength option in order to cut the result. This is used for example in previews of a rich text.

Parameters
$content : string
$options : array<string|int, mixed> = []

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters
$name : string

the method name

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.

public hasProperty(string $name[, bool $checkVars = true ]) : bool

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results