HumHub Documentation (unofficial)

ActivityMailRenderer extends MailLayoutRenderer
in package

Application

MailRenderer for Activity models

Properties

$layout : mixed
$parent : bool: Can be used to search the parent's view folder (e.g. the modules base view folder) for the view file.
$subPath : mixed
$textLayout : string
$viewPath : string

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.
getTextLayout() : string: Returns the $textLayout for the given $viewable.
getViewFile() : string|null: Returnes the viewFile of the given Viewable.
getViewPath() : string: Returns the directory containing the view files for this event.
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.
render() : string: If a $layout is given the result will embed the rendered viewFile into the given $layout.
renderText() : string: Used for rendering text mail content, by embedding the rendered view into a $textLayout and removing all html elemtns.
renderView() : type: Helper function for rendering a Viewable with the given viewParams.
getLayout() : string: Returns the layout file path.
suffix() : string: Checks if the given $viewName has a file suffix or not.

$layout


    public
        mixed
    $layout
     = '@activity/views/layouts/mail.php'

$parent

Can be used to search the parent's view folder (e.g. the modules base view folder) for the view file.


    public
        bool
    $parent
     = false

Otherwise this renderer searches for a direct views subdirectory.

This field is ignored if $viewPath is given.

if set to true the renderer will search in the parents view directory for the view.

$subPath


    public
        mixed
    $subPath
     = 'mail'

$textLayout


    public
        string
    $textLayout
     = '@activity/views/layouts/mail_plaintext.php'

Layout file path

$viewPath


    public
        string
    $viewPath

view path

__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

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

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

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

__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

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

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

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

getTextLayout()

Returns the $textLayout for the given $viewable.


    public
                    getTextLayout(Viewable $viewable) : string

Parameters

$viewable : Viewable

Return values

string

getViewFile()

Returnes the viewFile of the given Viewable.


    public
                    getViewFile(Viewable $viewable) : string|null

Parameters

$viewable : Viewable

Return values

string|null —

the view filename or null when not exists

getViewPath()

Returns the directory containing the view files for this event.


    public
                    getViewPath(Viewable $viewable[, bool $useSubPath = true ]) : string

The default implementation returns the 'views' subdirectory under the directory containing the notification class file.

Parameters

$viewable : Viewable: The viewable
$useSubPath : bool = true: use the subpath if provided

Return values

string —

the directory containing the view files for this notification.

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

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.

render()

If a $layout is given the result will embed the rendered viewFile into the given $layout.


    public
                    render(Viewable $viewable[, array<string|int, mixed> $params = [] ]) : string

Parameters

$viewable : Viewable
$params : array<string|int, mixed> = []

Return values

string

renderText()

Used for rendering text mail content, by embedding the rendered view into a $textLayout and removing all html elemtns.


    public
                    renderText(Viewable $viewable[, mixed $params = [] ]) : string

Parameters

$viewable : Viewable
$params : mixed = []

Return values

string

renderView()

Helper function for rendering a Viewable with the given viewParams.


    public
                    renderView(Viewable $viewable, type $viewParams) : type

Parameters

$viewable : Viewable
$viewParams : type

Return values

type

getLayout()

Returns the layout file path.


    protected
                    getLayout(Viewable $viewable) : string

Subclasses may use the $viewable to determine the layout path.

Parameters

$viewable : Viewable

Return values

string

suffix()

Checks if the given $viewName has a file suffix or not.


    protected
                    suffix(string $viewName) : string

If the viewName does not have a suffix we assume a php file and append '.php'.

Parameters

$viewName : string

Return values

string —

vieName with suffix.

ActivityMailRenderer extends MailLayoutRenderer in package Application

Tags

Table of Contents

Properties

Methods

Properties

$layout

Tags

$parent

$subPath

Tags

$textLayout

Tags

$viewPath

Methods

__call()

Parameters

Tags

Return values

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

getTextLayout()

Parameters

Return values

getViewFile()

Parameters

Return values

getViewPath()

Parameters

Return values

hasMethod()

Parameters

Return values

hasProperty()

Parameters

Tags

Return values

init()

render()

Parameters

Return values

renderText()

Parameters

Return values

renderView()

Parameters

Return values

getLayout()

ActivityMailRenderer extends MailLayoutRenderer
in package

Application