Platine\Framework\Console\Command\MakeDatabaseConfigCommand

Complexity

Total Complexity

7

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	createClass()	0	11	2
A	getDataTypeMaps()	0	10	1
A	getClassTemplate()	0	3	1
A	getMethodTemplate()	0	3	1
A	__construct()	0	9	1
A	getConfigMethod()	0	13	1

<?php

/**
 * Platine PHP
 *
 * Platine Framework is a lightweight, high-performance, simple and elegant
 * PHP Web framework
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine PHP
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

declare(strict_types=1);

namespace Platine\Framework\Console\Command;

use Platine\Filesystem\Filesystem;
use Platine\Framework\App\Application;
use Platine\Framework\Config\AppDatabaseConfig;
use Platine\Framework\Console\MakeCommand;
use Platine\Orm\Entity;
use Platine\Stdlib\Helper\Str;

/**
 * @class MakeDatabaseConfigCommand
 * @package Platine\Framework\Console\Command
 */
class MakeDatabaseConfigCommand extends MakeCommand
{
    /**
     * {@inheritdoc}
     */
    protected string $type = 'database config';

    /**
     * Create new instance
     * @param Application $application
     * @param Filesystem $filesystem
     * @param AppDatabaseConfig $dbConfig
     */
    public function __construct(
        Application $application,
        Filesystem $filesystem,
        protected AppDatabaseConfig $dbConfig,
    ) {
        parent::__construct($application, $filesystem);

        $this->setName('make:dbconfig')
               ->setDescription('Command to generate class that hold database configuration value');
    }

    /**
     * {@inheritdoc}
     */
    public function getClassTemplate(): string
    {
        return <<<EOF
        <?php
        
        declare(strict_types=1);
        
        namespace %namespace%;
        
        use Platine\Framework\Config\AppDatabaseConfig;
        %uses%

        /**
        * +=+=+ NOTE: THIS IS THE GENERATED CLASS DO NOT MODIFY IT +=+=+
        *
        * @class %classname%
        * @package %namespace%
        * @template TDbConfigurationEntity as \Platine\App\Model\Entity\Configuration
        */
        class %classname%
        {
            /**
            * Create new instance
            * @param AppDatabaseConfig<TDbConfigurationEntity> \$dbConfig
            */
            public function __construct(protected AppDatabaseConfig \$dbConfig)
            {
            }
        
            %config_content%
        }
        
        EOF;
    }

    /**
     * Generate the method of the given entity
     * @param Entity $entity
     * @return string
     */
    protected function getConfigMethod(Entity $entity): string
    {
        $types = $this->getDataTypeMaps();
        $methodTemplate = $this->getMethodTemplate();
        $methodName = Str::camel(sprintf('%s_%s', $entity->module, $entity->name), false);

        $strMethodName = str_replace('%method_name%', $methodName, $methodTemplate);
        $strType = str_replace('%type%', $types[$entity->type][0], $strMethodName);
        $strDefault = str_replace('%default_value%', $types[$entity->type][1], $strType);
        $strModule = str_replace('%module%', $entity->module, $strDefault);
        $strKey = str_replace('%key%', $entity->name, $strModule);

        return $strKey;
    }

    /**
     * {@inheritdoc}
     */
    protected function createClass(): string
    {
        $content = parent::createClass();

        $methods = '';
        $results = $this->dbConfig->getLoader()->all();
        foreach ($results as $row) {
            $methods .= $this->getConfigMethod($row);
        }

        return str_replace('%config_content%', $methods, $content);
    }

    /**
     * Return the data type mapping
     * @return array<string, array{0:string, 1:string}>
     */
    protected function getDataTypeMaps(): array
    {
        return [
            'integer' => ['int', '0'],
            'double' => ['float', '0.0'],
            'float' => ['float', '0.0'],
            'array' => ['array', '[]'],
            'object' => ['object', 'null'],
            'boolean' => ['bool', 'false'],
            'string' => ['string', '\'\''],
        ];
    }

    /**
     * Return the configuration method template
     * @return string
     */
    public function getMethodTemplate(): string
    {
        return <<<EOF
        /**
            * Return the configuration value for module "%module%" and key "%key%"
            * @param %type%|null \$default the default value
            *
            * @return %type% the configuration value if exist or default
            */
            public function get%method_name%(?%type% \$default = %default_value%): %type%
            {
                return \$this->dbConfig->get('%module%.%key%', \$default);
            }
            
            
        EOF;
    }
}