Class humhub\components\rendering\MailLayoutRenderer
| Inheritance | humhub\components\rendering\MailLayoutRenderer » humhub\components\rendering\LayoutRenderer » humhub\components\rendering\ViewPathRenderer » yii\base\BaseObject |
|---|---|
| Implements | humhub\components\rendering\Renderer |
| Subclasses | humhub\modules\activity\components\ActivityMailRenderer |
| Available since version | 1.2 |
MailLayoutRenderer extends the LayoutRenderer with a renderText function.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $layout | string | Layout file path | humhub\components\rendering\LayoutRenderer |
| $parent | boolean | If set to true the renderer will search in the parents view directory for the view. | humhub\components\rendering\ViewPathRenderer |
| $subPath | humhub\components\rendering\MailLayoutRenderer | ||
| $textLayout | string | Layout file path | humhub\components\rendering\MailLayoutRenderer |
| $viewPath | string | View path | humhub\components\rendering\ViewPathRenderer |
Public Methods
| Method | Description | Defined 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
| Method | Description | Defined 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
Layout file path
Method Details
Returns the $textLayout for the given $viewable.
| public \humhub\components\rendering\type getTextLayout ( humhub\components\rendering\Viewable $viewable ) | ||
| $viewable | humhub\components\rendering\Viewable | |
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 | ||