yii\mail\Template

Complexity

Total Complexity

12

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

96.43%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getViewPath()	0	4	1
A	render()	0	8	2
D	compose()	0	34	9

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\mail;

use Yii;
use yii\base\Object;
use yii\base\ViewContextInterface;

/**
 * Template composes the message from view templates, ensuring isolated view rendering. It allows
 * changing of the rendering options such as layout during composing of the particular message without
 * affecting other messages.
 *
 * An instance of this class serves as a view context during the mail template rendering and is available
 * inside a view template file via [[\yii\base\View::context]].
 *
 * @see BaseMailer::compose()
 *
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.1
 */
class Template extends Object implements ViewContextInterface

The class yii\base\Object has been deprecated with message: since 2.0.13, the class name `Object` is invalid since PHP 7.2, use [[BaseObject]] instead.

{
    /**
     * @var MessageInterface related mail message instance.
     */
    public $message;
    /**
     * @var \yii\base\View view instance used for rendering.
     */
    public $view;
    /**
     * @var string path to the directory containing view files.
     */
    public $viewPath;
    /**
     * @var string|array name of the view to use as a template. The value could be:
     *
     * - a string that contains either a view name or a path alias for rendering HTML body of the email.
     *   The text body in this case is generated by applying `strip_tags()` to the HTML body.
     * - an array with 'html' and/or 'text' elements. The 'html' element refers to a view name or a path alias
     *   for rendering the HTML body, while 'text' element is for rendering the text body. For example,
     *   `['html' => 'contact-html', 'text' => 'contact-text']`.
     */
    public $viewName;
    /**
     * @var string|false HTML layout view name. It is the layout used to render HTML mail body.
     * The property can take the following values:
     *
     * - a relative view name: a view file relative to [[viewPath]], e.g., 'layouts/html'.
     * - a path alias: an absolute view file path specified as a path alias, e.g., '@app/mail/html'.
     * - a bool false: the layout is disabled.
     */
    public $htmlLayout = false;
    /**
     * @var string|false text layout view name. This is the layout used to render TEXT mail body.
     * Please refer to [[htmlLayout]] for possible values that this property can take.
     */
    public $textLayout = false;


    /**
     * @inheritdoc
     */
    public function getViewPath()
    {
        return $this->viewPath;
    }

    /**
     * Composes the given mail message according to this template.
     * @param MessageInterface $message the message to be composed.
     * @param array $params the parameters (name-value pairs) that will be extracted and made available in the view file.
     */
    public function compose(MessageInterface $message, $params = [])
    {
        $this->message = $message;

        if (is_array($this->viewName)) {
            if (isset($this->viewName['html'])) {
                $html = $this->render($this->viewName['html'], $params, $this->htmlLayout);
            }
            if (isset($this->viewName['text'])) {
                $text = $this->render($this->viewName['text'], $params, $this->textLayout);
            }
        } else {
            $html = $this->render($this->viewName, $params, $this->htmlLayout);
        }

        if (isset($html)) {
            $this->message->setHtmlBody($html);
        }
        if (isset($text)) {
            $this->message->setTextBody($text);
        } elseif (isset($html)) {
            if (preg_match('~<body[^>]*>(.*?)</body>~is', $html, $match)) {
                $html = $match[1];
            }
            // remove style and script
            $html = preg_replace('~<((style|script))[^>]*>(.*?)</\1>~is', '', $html);
            // strip all HTML tags and decode HTML entities
            $text = html_entity_decode(strip_tags($html), ENT_QUOTES | ENT_HTML5, Yii::$app ? Yii::$app->charset : 'UTF-8');
            // improve whitespace
            $text = preg_replace("~^[ \t]+~m", '', trim($text));
            $text = preg_replace('~\R\R+~mu', "\n\n", $text);
            $this->message->setTextBody($text);
        }
    }

    /**
     * Renders the view specified with optional parameters and layout.
     * The view will be rendered using the [[view]] component.
     * @param string $view a view name or a path alias of the view file.
     * @param array $params the parameters (name-value pairs) that will be extracted and made available in the view file.
     * @param string|bool $layout layout view name or a path alias. If the value is false, no layout will be applied.
     * @return string the rendering result.
     */
    public function render($view, $params = [], $layout = false)
    {
        $output = $this->view->render($view, $params, $this);
        if ($layout === false) {
            return $output;
        }
        return $this->view->render($layout, ['content' => $output], $this);

It seems like $layout defined by parameter $layout on line 123 can also be of type boolean; however, yii\base\View::render() does only seem to accept string, maybe add an additional type check?

    }
}