HumHub Documentation (unofficial)

MailRenderer extends DefaultViewPathRenderer
in package

MailRenderer extends the DefaultViewPathRenderer with a renderText method.

The $defaultTextView and/or $defaultTextViewPath can be set to define a fallback view or search view path.

Tags
author

buddha

since
1.2

Table of Contents

Properties

$defaultTextView  : string
$defaultTextViewPath  : string
$defaultView  : string
$defaultViewPath  : string
$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
$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.
getViewFile()  : string
Returns the view file for 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
Renders the viewable by searching the viewable's viewName within the given viewPath.
renderText()  : string
Renders the text mail content for the given $viewable.
renderView()  : type
Helper function for rendering a Viewable with the given viewParams.
suffix()  : string
Checks if the given $viewName has a file suffix or not.

Properties

$defaultTextView

public string $defaultTextView

fallback text view.

$defaultTextViewPath

public string $defaultTextViewPath

fallback text view path.

$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 = 'mails'
Tags
inheritdoc

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.

getViewFile()

Returns the view file for the given Viewable.

public getViewFile(Viewable $viewable) : string

If there was no relative view file found, this function will search for the view file within the $defaultPath or return the $defaultView at last resort.

Parameters
$viewable : Viewable
Return values
string —

view file of this notification

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

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.

render()

Renders the viewable by searching the viewable's viewName within the given viewPath.

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

If no viewPath is given this function uses '../views/viewName' as view file path.

Parameters
$viewable : Viewable
$params : mixed = []
Tags
throws
ViewNotFoundException

if the view file does not exist

Return values
string

renderText()

Renders the text mail content for the given $viewable.

public renderText(Viewable $viewable[, array<string|int, mixed> $params = [] ]) : string
Parameters
$viewable : Viewable
$params : array<string|int, 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

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.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results