Roave\EmailTemplates\Options\TemplateServiceOptions

Complexity

Total Complexity

10

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

80%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	isAlwaysUpdateParameters()	0	4	1
A	setAlwaysUpdateParameters()	0	4	1
A	setDefaultBody()	0	4	1
A	getDefaultBody()	0	4	1
A	setDefaultSubject()	0	4	1
A	getDefaultSubject()	0	4	1
A	setEngine()	0	4	1
A	getEngine()	0	4	1
A	setPredefinedParams()	0	4	1
A	getPredefinedParams()	0	4	1

<?php
/**
 * Copyright (c) 2014 Roave, LLC.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the names of the copyright holders nor the names of the
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @author Antoine Hedgecock
 *
 * @copyright 2014 Roave, LLC
 * @license http://www.opensource.org/licenses/bsd-license.php  BSD License
 */

namespace Roave\EmailTemplates\Options;

use Zend\Stdlib\AbstractOptions;

/**
 * Class TemplateServiceOptions
 *
 * Contains all the available configuration for the template service
 *
 * @property string $engine
 * @property string $defaultSubject
 * @property string $defaultBody
 */
class TemplateServiceOptions extends AbstractOptions
{
    /**
     * The name of the engine to use for rendering
     *
     * @var string
     */
    protected $engine = 'twig';

    /**
     * @var bool
     */
    protected $alwaysUpdateParameters = false;

    /**
     * Default subject set on all template on initial creation
     *
     * @var string
     */
    protected $defaultSubject = 'Subject has not yet been set';

    /**
     * Default body set on all templates on initial creation
     *
     * @var string
     */
    protected $defaultBody = 'This is the default message for the template with id: %s,locale: %s';

    /**
     * Set predefined parameters that will exist in all templates
     *
     * @var array
     */
    protected $predefinedParams = [];

    /**
     * @return bool
     */
    public function isAlwaysUpdateParameters(): bool
    {
        return $this->alwaysUpdateParameters;
    }

    /**
     * @param bool $alwaysUpdateParameters
     */
    public function setAlwaysUpdateParameters(bool $alwaysUpdateParameters): void
    {
        $this->alwaysUpdateParameters = $alwaysUpdateParameters;
    }

    /**
     * @param string $defaultBody
     */
    public function setDefaultBody(string $defaultBody): void
    {
        $this->defaultBody = $defaultBody;
    }

    /**
     * @return string
     */
    public function getDefaultBody(): string
    {
        return $this->defaultBody;
    }

    /**
     * @param string $defaultSubject
     */
    public function setDefaultSubject(string $defaultSubject): void
    {
        $this->defaultSubject = $defaultSubject;
    }

    /**
     * @return string
     */
    public function getDefaultSubject(): string
    {
        return $this->defaultSubject;
    }

    /**
     * @param string $engine
     */
    public function setEngine(string $engine): void
    {
        $this->engine = $engine;
    }

    /**
     * @return string
     */
    public function getEngine(): string
    {
        return $this->engine;
    }

    /**
     * @param array $predefinedParams
     */
    public function setPredefinedParams(array $predefinedParams): void
    {
        $this->predefinedParams = $predefinedParams;
    }

    /**
     * @return array
     */
    public function getPredefinedParams(): array
    {
        return $this->predefinedParams;
    }
}