Class humhub\components\rendering\MailLayoutRenderer

Inheritancehumhub\components\rendering\MailLayoutRenderer » humhub\components\rendering\LayoutRenderer » humhub\components\rendering\ViewPathRenderer » yii\base\BaseObject
Implementshumhub\components\rendering\Renderer
Subclasseshumhub\modules\activity\components\ActivityMailRenderer
Available since version1.2

MailLayoutRenderer extends the LayoutRenderer with a renderText function.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getTextLayout() Returns the $textLayout for the given $viewable. humhub\components\rendering\MailLayoutRenderer
getViewFile() Returnes the viewFile of the given Viewable. humhub\components\rendering\ViewPathRenderer
getViewPath() Returns the directory containing the view files for this event. humhub\components\rendering\ViewPathRenderer
render() If a $layout is given the result will embed the rendered viewFile into the given $layout. humhub\components\rendering\LayoutRenderer
renderText() Used for rendering text mail content, by embedding the rendered view into a $textLayout and removing all html elemtns. humhub\components\rendering\MailLayoutRenderer
renderView() Helper function for rendering a Viewable with the given viewParams. humhub\components\rendering\ViewPathRenderer

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getLayout() Returns the layout file path. humhub\components\rendering\LayoutRenderer
suffix() Checks if the given $viewName has a file suffix or not. humhub\components\rendering\ViewPathRenderer

Property Details

$subPath public property
public $subPath 'mails'
$textLayout public property

Layout file path

public string $textLayout null

Method Details

getTextLayout() public method

Returns the $textLayout for the given $viewable.

public \humhub\components\rendering\type getTextLayout ( humhub\components\rendering\Viewable $viewable )
$viewable humhub\components\rendering\Viewable
renderText() public method

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

public \humhub\components\rendering\type renderText ( humhub\components\rendering\Viewable $viewable, $params = [] )
$viewable humhub\components\rendering\Viewable
$params