Yiisoft\Mailer\MessageBodyTemplate

Complexity

Total Complexity

4

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getTextLayout()	0	3	1
A	getHtmlLayout()	0	3	1
A	__construct()	0	8	1
A	getViewPath()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Mailer;

use Yiisoft\View\ViewContextInterface;

/**
 * Stores the path to the view file directory and the layout view names.
 */
final class MessageBodyTemplate implements ViewContextInterface
{
    /**
     * @var string The directory containing view files for composing mail messages.
     */
    private string $viewPath;

    /**
     * @var string The HTML layout view name.
     *
     * It is the layout used to render HTML mail body. If the value is empty string, no layout will be applied.
     *
     * The property can take the following values:
     *
     * - a relative view name: a view file relative to {@see MessageBodyRenderer::$viewPath}, e.g., 'layouts/html'.
     * - an empty string: the layout is disabled.
     */
    private string $htmlLayout;

    /**
     * @var string The TEXT layout view name.
     *
     * This is the layout used to render TEXT mail body. If the value is empty string, no layout will be applied.
     *
     * The property can take the following values:
     *
     * - a relative view name: a view file relative to {@see MessageBodyRenderer::$viewPath}, e.g., 'layouts/text'.
     * - an empty string: the layout is disabled.
     */
    private string $textLayout;

    /**
     * @param string $viewPath The directory containing view files for composing mail messages.
     * @param string $htmlLayout The HTML layout view name. It is the layout used to render HTML mail body.
     * @param string $textLayout The TEXT layout view name. This is the layout used to render TEXT mail body.
     */
    public function __construct(
        string $viewPath,
        string $htmlLayout = 'layouts/html',
        string $textLayout = 'layouts/text'
    ) {
        $this->viewPath = $viewPath;
        $this->htmlLayout = $htmlLayout;
        $this->textLayout = $textLayout;
    }

    /** Returns the directory containing view files for composing mail messages.
     *
     * @return string The directory containing view files for composing mail messages.
     */
    public function getViewPath(): string
    {
        return $this->viewPath;
    }

    /**
     * Returns the HTML layout view name.
     *
     * @return string The HTML layout view name.
     */
    public function getHtmlLayout(): string
    {
        return $this->htmlLayout;
    }

    /**
     * Returns the TEXT layout view name.
     *
     * @return string The TEXT layout view name.
     */
    public function getTextLayout(): string
    {
        return $this->textLayout;
    }
}