Arrilot\BitrixMigrations\TemplatesCollection

Complexity

Total Complexity

18

Size/Duplication

Total Lines	222
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
B	registerBasicTemplates()	0	56	2
A	registerAutoTemplates()	0	27	2
A	all()	0	4	1
A	registerTemplate()	0	8	1
A	getTemplatePath()	0	4	1
A	selectTemplate()	0	12	3
A	normalizeTemplateDuringRegistration()	0	16	5
A	registerTemplateAliases()	0	10	2

<?php

namespace Arrilot\BitrixMigrations;

use InvalidArgumentException;
use RuntimeException;

class TemplatesCollection
{
    /**
     * Path to directory where basic templates are.
     *
     * @var string
     */
    protected $dir;

    /**
     * Array of available migration file templates.
     *
     * @var array
     */
    protected $templates = [];

    /**
     * Constructor.
     */
    public function __construct()
    {
        $this->dir = dirname(__DIR__).'/templates';

        $this->registerTemplate([
            'name'        => 'default',
            'path'        => $this->dir.'/default.template',
            'description' => 'Default migration template',
        ]);
    }

    /**
     * Register basic templates.
     */
    public function registerBasicTemplates()
    {
        $templates = [
            [
                'name'        => 'add_iblock',
                'path'        => $this->dir.'/add_iblock.template',
                'description' => 'Add iblock',
            ],
            [
                'name'        => 'add_iblock_type',
                'path'        => $this->dir.'/add_iblock_type.template',
                'description' => 'Add iblock type',
            ],
            [
                'name'        => 'add_iblock_element_property',
                'path'        => $this->dir.'/add_iblock_element_property.template',
                'description' => 'Add iblock element property',
                'aliases'     => [
                    'add_iblock_prop',
                    'add_iblock_element_prop',
                    'add_element_prop',
                    'add_element_property',
                ],
            ],
            [
                'name'        => 'add_uf',
                'path'        => $this->dir.'/add_uf.template',
                'description' => 'Add user field (for sections, users e.t.c)',
            ],
            [
                'name'        => 'add_table',
                'path'        => $this->dir.'/add_table.template',
                'description' => 'Create table',
                'aliases'     => [
                    'create_table',
                ],
            ],
            [
                'name'        => 'delete_table',
                'path'        => $this->dir.'/delete_table.template',
                'description' => 'Drop table',
                'aliases'     => [
                    'drop_table',
                ],
            ],
            [
                'name'        => 'query',
                'path'        => $this->dir.'/query.template',
                'description' => 'Simple database query',
            ],
        ];

        foreach ($templates as $template) {
            $this->registerTemplate($template);
        }
    }

    /**
     * Register templates for automigrations.
     */
    public function registerAutoTemplates()
    {
        $templates = [
            'add_iblock',
            'update_iblock',
            'delete_iblock',
            'add_iblock_element_property',
            'update_iblock_element_property',
            'delete_iblock_element_property',
            'add_uf',
            'update_uf',
            'delete_uf',
            'add_hlblock',
            'update_hlblock',
            'delete_hlblock',
            'add_group',
            'update_group',
            'delete_group',
        ];

        foreach ($templates as $template) {
            $this->registerTemplate([
                'name' => 'auto_'.$template,
                'path' => $this->dir.'/auto/'.$template.'.template',
            ]);
        }
    }

    /**
     * Getter for registered templates.
     *
     * @return array
     */
    public function all()
    {
        return $this->templates;
    }

    /**
     * Dynamically register migration template.
     *
     * @param array $template
     *
     * @return void
     */
    public function registerTemplate($template)
    {
        $template = $this->normalizeTemplateDuringRegistration($template);

        $this->templates[$template['name']] = $template;

        $this->registerTemplateAliases($template, $template['aliases']);
    }

    /**
     * Path to the file where a template is located.
     *
     * @param string $name
     *
     * @return string
     */
    public function getTemplatePath($name)
    {
        return $this->templates[$name]['path'];
    }

    /**
     * Find out template name from user input.
     *
     * @param string|null $template
     *
     * @return string
     */
    public function selectTemplate($template)
    {
        if (is_null($template)) {
            return 'default';
        }

        if (!array_key_exists($template, $this->templates)) {
            throw new RuntimeException("Template \"{$template}\" is not registered");
        }

        return $template;
    }

    /**
     * Check template fields and normalize them.
     *
     * @param $template
     *
     * @return array
     */
    protected function normalizeTemplateDuringRegistration($template)
    {
        if (empty($template['name'])) {
            throw new InvalidArgumentException('Impossible to register a template without "name"');
        }

        if (empty($template['path'])) {
            throw new InvalidArgumentException('Impossible to register a template without "path"');
        }

        $template['description'] = isset($template['description']) ? $template['description'] : '';
        $template['aliases'] = isset($template['aliases']) ? $template['aliases'] : [];
        $template['is_alias'] = false;

        return $template;
    }

    /**
     * Register template aliases.
     *
     * @param array $template
     * @param array $aliases
     *
     * @return void
     */
    protected function registerTemplateAliases($template, array $aliases = [])
    {
        foreach ($aliases as $alias) {
            $template['is_alias'] = true;
            $template['name'] = $alias;
            $template['aliases'] = [];

            $this->templates[$template['name']] = $template;
        }
    }
}