ymaker\email\templates\Module

Complexity

Total Complexity

9

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setRepository()	0	3	1
A	setLanguageProvider()	0	3	1
A	registerDependencies()	0	5	1
A	getIssueUrl()	0	3	1
A	t()	0	3	1
A	getRepoUrl()	0	3	1
A	init()	0	13	3

<?php
/**
 * @link https://github.com/yiimaker/yii2-email-templates
 * @copyright Copyright (c) 2017-2019 Yii Maker
 * @license BSD 3-Clause License
 */

namespace ymaker\email\templates;

use Yii;
use yii\base\InvalidConfigException;
use ymaker\email\templates\repositories\EmailTemplatesRepository;
use ymaker\email\templates\repositories\EmailTemplatesRepositoryInterface;
use motion\i18n\LanguageProviderInterface;

/**
 * Module for CRUD operations under email templates in backend.
 *
 * @property array $repository
 * @property array $languageProvider
 *
 * @author Volodymyr Kupriienko <vldmr.kuprienko@gmail.com>
 * @since 1.0
 */
class Module extends \yii\base\Module
{
    /**
     * {{@inheritdoc}}
     */
    public $controllerNamespace = 'ymaker\email\templates\controllers';

    /**
     * Service for controller.
     *
     * @see \ymaker\email\templates\repositories\EmailTemplatesRepositoryInterface
     *
     * @var array
     *
     * @since 4.0
     */
    protected $repository;
    /**
     * Language provider for internationalization.
     *
     * @see \motion\i18n\LanguageProviderInterface
     *
     * @var array
     */
    protected $languageProvider;


    /**
     * @param array $repository
     *
     * @since 4.0
     */
    public function setRepository(array $repository)
    {
        $this->repository = $repository;
    }

    /**
     * @param array $provider
     *
     * @since 2.0
     */
    public function setLanguageProvider(array $provider)
    {
        $this->languageProvider = $provider;
    }

    /**
     * {{@inheritdoc}}
     */
    public function init()
    {
        parent::init();

        if (null === $this->repository) {
            $this->repository = ['class' => EmailTemplatesRepository::class];
        }

        if (null === $this->languageProvider) {
            throw new InvalidConfigException('You should configure the language provider');
        }

        $this->registerDependencies();
    }

    /**
     * Register dependencies to DI container.
     */
    protected function registerDependencies()
    {
        Yii::$container->setDefinitions([
            EmailTemplatesRepositoryInterface::class => $this->repository,
            LanguageProviderInterface::class => $this->languageProvider,
        ]);
    }

    /**
     * Module wrapper for `Yii::t()` method.
     *
     * @param string        $message
     * @param array         $params
     * @param null|string   $language
     *
     * @return string
     */
    public static function t($message, $params = [], $language = null)
    {
        return Yii::t('back/email-templates', $message, $params, $language);
    }

    /**
     * Returns url to repository for creation of new issue.
     *
     * @return string
     *
     * @since 3.0
     */
    final public static function getIssueUrl()
    {
        return self::getRepoUrl() . '/issues/new';
    }

    /**
     * Returns url of official repository.
     *
     * @return string
     *
     * @since 3.0
     */
    final public static function getRepoUrl()
    {
        return 'https://github.com/yiimaker/yii2-email-templates';
    }
}