MakeProviderCommand::getBootBody() - Code Metrics - Inspection of "Add make command for action, entity, event, listen..." - platine-php/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( ac3052...955933 )

by nguereza

created 2022-02-08 11:40 UTC

MakeProviderCommand::getBootBody() A

↳ Parent: MakeProviderCommand

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	13
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	17
rs	9.8333

<?php

/**
 * Platine Framework
 *
 * 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 Framework
 *
 * 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.
 */

/**
 *  @file MakeProviderCommand.php
 *
 *  The Make provider Command class
 *
 *  @package    Platine\Framework\Console\Command
 *  @author Platine Developers team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   http://www.iacademy.cf
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Framework\Console\Command;

use Platine\Console\Input\Reader;
use Platine\Console\Output\Writer;
use Platine\Filesystem\Filesystem;
use Platine\Framework\App\Application;
use Platine\Framework\Console\MakeCommand;

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

    /**
     * Whether to use boot method
     * @var bool
     */
    protected bool $useBoot = false;

    /**
     * Whether to add routes in the provider
     * @var bool
     */
    protected bool $addRoutes = false;

    /**
     * Create new instance
     * @param Application $application
     * @param Filesystem $filesystem
     */
    public function __construct(
        Application $application,
        Filesystem $filesystem
    ) {
        parent::__construct($application, $filesystem);
        $this->setName('make:provider')
               ->setDescription('Command to generate new service provider class');
    }

    /**
     * {@inheritdoc}
     */
    public function interact(Reader $reader, Writer $writer): void
    {
        parent::interact($reader, $writer);
        $io = $this->io();

        $this->useBoot = $io->confirm('Use bootstrap feature ?', 'n');
        $this->addRoutes = $io->confirm('Add routes ?', 'n');
    }

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

        /**
        * @class %classname%
        * @package %namespace%
        */
        class %classname% extends ServiceProvider
        {
            /**
            * {@inheritdoc}
            */
           public function register(): void
           {
            
           }
            
            %boot_body%
            %add_routes_body%
        }
        
        EOF;
    }

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

        $useBoot = $this->getBootBody($content);

        return $this->getAddRoutesBody($useBoot);
    }

    /**
     * Return the boot method body
     * @param string $content
     * @return string
     */
    protected function getBootBody(string $content): string
    {
        $result = '';
        if ($this->useBoot) {
            $result = <<<EOF
            /**
                * {@inheritdoc}
                */
               public function boot(): void
               {
                    
               }
                
            EOF;
        }

        return str_replace('%boot_body%', $result, $content);
    }

    /**
     * Return the add routes method body
     * @param string $content
     * @return string
     */
    protected function getAddRoutesBody(string $content): string
    {
        $result = '';
        if ($this->addRoutes) {
            $result = <<<EOF
            /**
                * {@inheritdoc}
                */
               public function addRoutes(Router \$router): void
               {
                    
               }
                
            EOF;
        }

        return str_replace('%add_routes_body%', $result, $content);
    }

    /**
     * {@inheritdoc}
     */
    protected function getUsesContent(): string
    {
        if (!$this->addRoutes) {
            return '';
        }

        return <<<EOF
        use Platine\Route\Router; 
        
        EOF;
    }
}


1			<?php
2
3			/**
4			* Platine Framework
5			*
6			* Platine Framework is a lightweight, high-performance, simple and elegant
7			* PHP Web framework
8			*
9			* This content is released under the MIT License (MIT)
10			*
11			* Copyright (c) 2020 Platine Framework
12			*
13			* Permission is hereby granted, free of charge, to any person obtaining a copy
14			* of this software and associated documentation files (the "Software"), to deal
15			* in the Software without restriction, including without limitation the rights
16			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17			* copies of the Software, and to permit persons to whom the Software is
18			* furnished to do so, subject to the following conditions:
19			*
20			* The above copyright notice and this permission notice shall be included in all
21			* copies or substantial portions of the Software.
22			*
23			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29			* SOFTWARE.
30			*/
31
32			/**
33			* @file MakeProviderCommand.php
34			*
35			* The Make provider Command class
36			*
37			* @package Platine\Framework\Console\Command
38			* @author Platine Developers team
39			* @copyright Copyright (c) 2020
40			* @license http://opensource.org/licenses/MIT MIT License
41			* @link http://www.iacademy.cf
42			* @version 1.0.0
43			* @filesource
44			*/
45
46			declare(strict_types=1);
47
48			namespace Platine\Framework\Console\Command;
49
50			use Platine\Console\Input\Reader;
51			use Platine\Console\Output\Writer;
52			use Platine\Filesystem\Filesystem;
53			use Platine\Framework\App\Application;
54			use Platine\Framework\Console\MakeCommand;
55
56			/**
57			* @class MakeProviderCommand
58			* @package Platine\Framework\Console\Command
59			*/
60			class MakeProviderCommand extends MakeCommand
61			{
62			/**
63			* {@inheritdoc}
64			*/
65			protected string $type = 'provider';
66
67			/**
68			* Whether to use boot method
69			* @var bool
70			*/
71			protected bool $useBoot = false;
72
73			/**
74			* Whether to add routes in the provider
75			* @var bool
76			*/
77			protected bool $addRoutes = false;
78
79			/**
80			* Create new instance
81			* @param Application $application
82			* @param Filesystem $filesystem
83			*/
84			public function __construct(
85			Application $application,
86			Filesystem $filesystem
87			) {
88			parent::__construct($application, $filesystem);
89			$this->setName('make:provider')
90			->setDescription('Command to generate new service provider class');
91			}
92
93			/**
94			* {@inheritdoc}
95			*/
96			public function interact(Reader $reader, Writer $writer): void
97			{
98			parent::interact($reader, $writer);
99			$io = $this->io();
100
101			$this->useBoot = $io->confirm('Use bootstrap feature ?', 'n');
102			$this->addRoutes = $io->confirm('Add routes ?', 'n');
103			}
104
105			/**
106			* {@inheritdoc}
107			*/
108			public function getClassTemplate(): string
109			{
110			return <<<EOF
111			<?php
112
113			declare(strict_types=1);
114
115			namespace %namespace%;
116
117			use Platine\Framework\Service\ServiceProvider;
118			%uses%
119
120			/**
121			* @class %classname%
122			* @package %namespace%
123			*/
124			class %classname% extends ServiceProvider
125			{
126			/**
127			* {@inheritdoc}
128			*/
129			public function register(): void
130			{
131
132			}
133
134			%boot_body%
135			%add_routes_body%
136			}
137
138			EOF;
139			}
140
141			/**
142			* {@inheritdoc}
143			*/
144			protected function createClass(): string
145			{
146			$content = parent::createClass();
147
148			$useBoot = $this->getBootBody($content);
149
150			return $this->getAddRoutesBody($useBoot);
151			}
152
153			/**
154			* Return the boot method body
155			* @param string $content
156			* @return string
157			*/
158			protected function getBootBody(string $content): string
159			{
160			$result = '';
161			if ($this->useBoot) {
162			$result = <<<EOF
163			/**
164			* {@inheritdoc}
165			*/
166			public function boot(): void
167			{
168
169			}
170
171			EOF;
172			}
173
174			return str_replace('%boot_body%', $result, $content);
175			}
176
177			/**
178			* Return the add routes method body
179			* @param string $content
180			* @return string
181			*/
182			protected function getAddRoutesBody(string $content): string
183			{
184			$result = '';
185			if ($this->addRoutes) {
186			$result = <<<EOF
187			/**
188			* {@inheritdoc}
189			*/
190			public function addRoutes(Router \$router): void
191			{
192
193			}
194
195			EOF;
196			}
197
198			return str_replace('%add_routes_body%', $result, $content);
199			}
200
201			/**
202			* {@inheritdoc}
203			*/
204			protected function getUsesContent(): string
205			{
206			if (!$this->addRoutes) {
207			return '';
208			}
209
210			return <<<EOF
211			use Platine\Route\Router;
212
213			EOF;
214			}
215			}
216

platine-php / framework

Push — develop ( ac3052...955933 )

MakeProviderCommand::getBootBody() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like