MakeTaskCommand::getTaskBody() - Code Metrics - Inspection of "Add task generation command" - platine-php/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 8c6533...39e219 )

by nguereza

created 2022-10-17 11:54 UTC

MakeTaskCommand::getTaskBody() A

↳ Parent: MakeTaskCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	10
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	21
rs	9.9332

<?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 MakeEntityCommand.php
 *
 *  The Make Entity 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;
use Platine\Framework\Task\Cron;

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

    /**
     * The name of task
     * @var string
     */
    protected string $name = '';

    /**
     * The task execution expression
     * @var string
     */
    protected string $expression = '* * * * *';

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

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


        $io = $this->io();
        $this->name = $io->prompt('Enter the task name', null);


        $expression = $io->prompt('Enter the cron expression', '* * * * *');
        while (Cron::parse($expression) === 0) {
            $expression = $io->prompt('Invalid expression, please enter the cron expression', '* * * * *');
        }
        $this->expression = $expression;
    }

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

        /**
        * @class %classname%
        * @package %namespace%
        */
        class %classname% implements TaskInterface
        {
            
            /**
            * {@inheritdoc}
            */
            public function run(): void
            {
                
            }
        
            %task_body%
        }
        
        EOF;
    }

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

        return $this->getTaskBody($content);
    }

    /**
     * Return the task body
     * @param string $content
     * @return string
     */
    protected function getTaskBody(string $content): string
    {
        $result = <<<EOF
            /**
            * {@inheritdoc}
            */
            public function expression(): string
            {
                return '$this->expression';
            }
                    
            /**
            * {@inheritdoc}
            */
            public function name(): string
            {
                return '$this->name';
            }
        EOF;

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


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 MakeEntityCommand.php
34			*
35			* The Make Entity 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			use Platine\Framework\Task\Cron;
56
57			/**
58			* @class MakeTaskCommand
59			* @package Platine\Framework\Console\Command
60			*/
61			class MakeTaskCommand extends MakeCommand
62			{
63			/**
64			* {@inheritdoc}
65			*/
66			protected string $type = 'task';
67
68			/**
69			* The name of task
70			* @var string
71			*/
72			protected string $name = '';
73
74			/**
75			* The task execution expression
76			* @var string
77			*/
78			protected string $expression = '* * * * *';
79
80			/**
81			* Create new instance
82			* @param Application $application
83			* @param Filesystem $filesystem
84			*/
85			public function __construct(
86			Application $application,
87			Filesystem $filesystem
88			) {
89			parent::__construct($application, $filesystem);
90			$this->setName('make:task')
91			->setDescription('Command to generate new task class');
92			}
93
94			/**
95			* {@inheritdoc}
96			*/
97			public function interact(Reader $reader, Writer $writer): void
98			{
99			parent::interact($reader, $writer);
100
101
102			$io = $this->io();
103			$this->name = $io->prompt('Enter the task name', null);
104
105
106			$expression = $io->prompt('Enter the cron expression', '* * * * *');
107			while (Cron::parse($expression) === 0) {
108			$expression = $io->prompt('Invalid expression, please enter the cron expression', '* * * * *');
109			}
110			$this->expression = $expression;
111			}
112
113			/**
114			* {@inheritdoc}
115			*/
116			public function getClassTemplate(): string
117			{
118			return <<<EOF
119			<?php
120
121			declare(strict_types=1);
122
123			namespace %namespace%;
124
125			use Platine\Framework\Task\TaskInterface;
126
127			%uses%
128
129			/**
130			* @class %classname%
131			* @package %namespace%
132			*/
133			class %classname% implements TaskInterface
134			{
135
136			/**
137			* {@inheritdoc}
138			*/
139			public function run(): void
140			{
141
142			}
143
144			%task_body%
145			}
146
147			EOF;
148			}
149
150			/**
151			* {@inheritdoc}
152			*/
153			protected function createClass(): string
154			{
155			$content = parent::createClass();
156
157			return $this->getTaskBody($content);
158			}
159
160			/**
161			* Return the task body
162			* @param string $content
163			* @return string
164			*/
165			protected function getTaskBody(string $content): string
166			{
167			$result = <<<EOF
168			/**
169			* {@inheritdoc}
170			*/
171			public function expression(): string
172			{
173			return '$this->expression';
174			}
175
176			/**
177			* {@inheritdoc}
178			*/
179			public function name(): string
180			{
181			return '$this->name';
182			}
183			EOF;
184
185			return str_replace('%task_body%', $result, $content);
186			}
187			}
188

platine-php / framework

Push — develop ( 8c6533...39e219 )

MakeTaskCommand::getTaskBody() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like