ymaker\email\templates\gii\Generator

Complexity

Total Complexity

9

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	attributeLabels()	0	7	1
A	getName()	0	3	1
A	requiredTemplates()	0	3	1
A	getDescription()	0	3	1
A	init()	0	9	2
A	getMigrationAlias()	0	3	1
A	generate()	0	15	1
A	rules()	0	6	1

<?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\gii;

use Yii;
use yii\gii\CodeFile;

/**
 * This generator will be generate a email template.
 *
 * @author Volodymyr Kupriienko <vldmr.kuprienko@gmail.com>
 * @since 1.1
 */
class Generator extends \yii\gii\Generator
{
    /**
     * Email template key.
     *
     * @var string
     */
    public $key;
    /**
     * Subject of email letter.
     *
     * @var string
     */
    public $subject;
    /**
     * Body of email letter.
     *
     * @var string
     */
    public $body;
    /**
     * Hints for user.
     *
     * @var string
     */
    public $hint;
    /**
     * @var string
     */
    public $migrationName;


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

        if (null === $this->migrationName) {
            $this->migrationName = 'm' . \gmdate('ymd_His') . '_add_email_template';
        }

        $this->hint = 'All tokens wrapped in {} will be replaced by real data';
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return 'Email template generator';
    }

    /**
     * {@inheritdoc}
     */
    public function getDescription()
    {
        return 'This generator generates a migration for adding of email template.';
    }

    /**
     * {@inheritdoc}
     */
    public function rules()
    {
        return \array_merge(parent::rules(), [
            [['migrationName'], 'safe'],
            [['key', 'subject', 'body'], 'required'],
            [['hint'], 'string', 'max' => 500],
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function attributeLabels()
    {
        return \array_merge(parent::attributeLabels(), [
            'key'       => 'Template key',
            'subject'   => 'Letter subject',
            'body'      => 'Letter body',
            'hint'      => 'Hints for user',
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function requiredTemplates()
    {
        return ['email-template.php'];
    }

    /**
     * {@inheritdoc}
     */
    public function generate()
    {
        $params = [
            'key'       => $this->key,
            'subject'   => $this->subject,
            'body'      => $this->body,
            'hint'      => $this->hint,
        ];

        $templateFile = new CodeFile(
            $this->getMigrationAlias(),
            $this->render('email-template.php', $params)
        );

        return [$templateFile];
    }

    /**
     * @return bool|string
     */
    protected function getMigrationAlias()
    {
        return Yii::getAlias('@console/migrations/' . $this->migrationName . '.php');
    }
}