CreateController::__construct() - Code Metrics - Inspection of "Created generate:controller command" - slickframework/mvc - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (bff1a4)

by Filipe

created 2016-08-23 20:57 UTC

CreateController::__construct() A

↳ Parent: CreateController

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	2

<?php

/**
 * This file is part of slick/mvc package
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\Mvc\Console\Command\Task;

use Slick\Common\Base;
use Slick\Mvc\Console\Command\TaskInterface;
use Slick\Mvc\Console\MetaDataGenerator\Composer;
use Slick\Mvc\Console\MetaDataGenerator\ConsoleAwareMethods;
use Slick\Mvc\Console\MetaDataGenerator\Controller;
use Slick\Template\Template;
use Slick\Template\TemplateEngineInterface;
use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Question\ConfirmationQuestion;

/**
 * Class CreateController
 *
 * @package Slick\Mvc\Console\Command\Task
 * @author  Filipe Silva <[email protected]>
 *
 * @property string $controllerName
 * @property string $namespace
 * @property string $sourcePath
 * @property string $basePath
 */
class CreateController extends Base implements TaskInterface
{
    /**
     * @readwrite
     * @var string
     */
    protected $entityName;

    /**
     * @readwrite
     * @var string
     */
    protected $controllerName;

    /**
     * @readwrite
     * @var string
     */
    protected $namespace;

    /**
     * @readwrite
     * @var string
     */
    protected $sourcePath;

    /**
     * @var string
     */
    protected $basePath;

    /**
     * @var string
     */
    protected $controllerFile;

    /**
     * For input/output getters and setters
     */
    use ConsoleAwareMethods;

    /**
     * @var Controller
     */
    protected $controllerMetaData;

    /**
     * @var TemplateEngineInterface
     */
    protected $templateEngine;

    /**
     * @var QuestionHelper
     */
    protected $questionHelper;

    protected $template = 'controller.twig';

    /**
     * Runs this task
     *
     * @return boolean
     */
    public function run()
    {
        if (!$this->overrideFile()) {
            $this->output->writeln("<info>File was skipped. The controller was not created.</info>");
            return true;
        }
        $data = $this->getControllerMetaData()->getData();
        $data = array_merge(
            $data,
            [
                'controllerName' => $this->controllerName,
                'namespace' => $this->namespace,
                'basePath' => $this->getBasePath()
            ]
        );
        $content = $this->getTemplateEngine()
            ->parse($this->template)
            ->process($data);
        file_put_contents($this->getControllerFile(), $content);
        return true;
    }

    /**
     * Gets controllerMetaData property
     *
     * @return Controller
     */
    public function getControllerMetaData()
    {
        if (null == $this->controllerMetaData) {
            $controller = new Controller();
            $this->configureController($controller);
            $this->setControllerMetaData($controller);
        }
        return $this->controllerMetaData;
    }

    /**
     * Sets controllerMetaData property
     *
     * @param Controller $controllerMetaData
     *
     * @return CreateController
     */
    public function setControllerMetaData(Controller $controllerMetaData)
    {
        $this->controllerMetaData = $controllerMetaData;
        return $this;
    }

    /**
     * Gets templateEngine property
     *
     * @return TemplateEngineInterface
     */
    public function getTemplateEngine()
    {
        if (null == $this->templateEngine) {
            Template::addPath(dirname(dirname(__DIR__)).'/templates');
            $template = (new Template())->initialize();
            $this->setTemplateEngine($template);
        }
        return $this->templateEngine;
    }

    /**
     * Sets templateEngine property
     *
     * @param TemplateEngineInterface $templateEngine
     *
     * @return CreateController
     */
    public function setTemplateEngine(TemplateEngineInterface $templateEngine)
    {
        $this->templateEngine = $templateEngine;
        return $this;
    }

    /**
     * Gets basePath property
     *
     * @return string
     */
    public function getBasePath()
    {
        if (null == $this->basePath) {
            $this->basePath = strtolower($this->controllerName);
        }
        return $this->basePath;
    }

    /**
     * Gets controllerFile property
     *
     * @return string
     */
    public function getControllerFile()
    {
        if (null == $this->controllerFile) {
            $this->setControllerFile(
                "{$this->sourcePath}/{$this->namespace}/" .
                "{$this->controllerName}.php"
            );
        }
        return $this->controllerFile;
    }

    /**
     * Sets controllerFile property
     *
     * @param string $controllerFile
     *
     * @return CreateController
     */
    public function setControllerFile($controllerFile)
    {
        $this->controllerFile = $controllerFile;
        return $this;
    }

    /**
     * Gets questionHelper property
     *
     * @return QuestionHelper
     */
    public function getQuestionHelper()
    {
        if (null == $this->questionHelper) {
            $this->setQuestionHelper($this->getCommand()->getHelper('question'));

        }
        return $this->questionHelper;
    }

    /**
     * Sets questionHelper property
     *
     * @param QuestionHelper $questionHelper
     *
     * @return CreateController
     */
    public function setQuestionHelper(QuestionHelper $questionHelper)
    {
        $this->questionHelper = $questionHelper;
        return $this;
    }

    /**
     * Configures the controller generator
     *
     * @param Controller $controller
     */
    protected function configureController(Controller $controller)
    {
        $controller->setInput($this->getInput())
            ->setOutput($this->getOutput())
            ->setCommand($this->getCommand());
        $composer = new Composer();
        $controller->add($composer);
    }

    /**
     * Check controller file existence and ask if can be overridden
     *
     * @return bool
     */
    protected function overrideFile()
    {
        if (!is_file($this->getControllerFile())) {
            return true;
        }

        $question = new ConfirmationQuestion(
            "\nThe file <comment>{$this->controllerFile}</comment> already " .
            "exists. Override it (y,N)? ",
            false,
            '/^(y|yes)/i'
        );
        return (boolean) $this->getQuestionHelper()->ask(
            $this->input,
            $this->output,
            $question
        );
    }
}

1		<?php
2
3		/**
4		* This file is part of slick/mvc package
5		*
6		* For the full copyright and license information, please view the LICENSE
7		* file that was distributed with this source code.
8		*/
9
10		namespace Slick\Mvc\Console\Command\Task;
11
12		use Slick\Common\Base;
13		use Slick\Mvc\Console\Command\TaskInterface;
14		use Slick\Mvc\Console\MetaDataGenerator\Composer;
15		use Slick\Mvc\Console\MetaDataGenerator\ConsoleAwareMethods;
16		use Slick\Mvc\Console\MetaDataGenerator\Controller;
17		use Slick\Template\Template;
18		use Slick\Template\TemplateEngineInterface;
19		use Symfony\Component\Console\Helper\QuestionHelper;
20		use Symfony\Component\Console\Question\ConfirmationQuestion;
21
22		/**
23		* Class CreateController
24		*
25		* @package Slick\Mvc\Console\Command\Task
26		* @author Filipe Silva <[email protected]>
27		*
28		* @property string $controllerName
29		* @property string $namespace
30		* @property string $sourcePath
31		* @property string $basePath
32		*/
33		class CreateController extends Base implements TaskInterface
34		{
35		/**
36		* @readwrite
37		* @var string
38		*/
39		protected $entityName;
40
41		/**
42		* @readwrite
43		* @var string
44		*/
45		protected $controllerName;
46
47		/**
48		* @readwrite
49		* @var string
50		*/
51		protected $namespace;
52
53		/**
54		* @readwrite
55		* @var string
56		*/
57		protected $sourcePath;
58
59		/**
60		* @var string
61		*/
62		protected $basePath;
63
64		/**
65		* @var string
66		*/
67		protected $controllerFile;
68
69		/**
70		* For input/output getters and setters
71		*/
72		use ConsoleAwareMethods;
73
74		/**
75		* @var Controller
76		*/
77		protected $controllerMetaData;
78
79		/**
80		* @var TemplateEngineInterface
81		*/
82		protected $templateEngine;
83
84		/**
85		* @var QuestionHelper
86		*/
87		protected $questionHelper;
88
89		protected $template = 'controller.twig';
90
91		/**
92		* Runs this task
93		*
94		* @return boolean
95		*/
96	6	public function run()
97		{
98	6	if (!$this->overrideFile()) {
99	2	$this->output->writeln("<info>File was skipped. The controller was not created.</info>");
100	2	return true;
101		}
102	4	$data = $this->getControllerMetaData()->getData();
103	4	$data = array_merge(
104	2	$data,
105		[
106	4	'controllerName' => $this->controllerName,
107	4	'namespace' => $this->namespace,
108	4	'basePath' => $this->getBasePath()
109	2	]
110	2	);
111	4	$content = $this->getTemplateEngine()
112	4	->parse($this->template)
113	4	->process($data);
114	4	file_put_contents($this->getControllerFile(), $content);
115	4	return true;
116		}
117
118		/**
119		* Gets controllerMetaData property
120		*
121		* @return Controller
122		*/
123	6	public function getControllerMetaData()
124		{
125	6	if (null == $this->controllerMetaData) {
126	6	$controller = new Controller();
127	6	$this->configureController($controller);
128	6	$this->setControllerMetaData($controller);
129	3	}
130	6	return $this->controllerMetaData;
131		}
132
133		/**
134		* Sets controllerMetaData property
135		*
136		* @param Controller $controllerMetaData
137		*
138		* @return CreateController
139		*/
140	6	public function setControllerMetaData(Controller $controllerMetaData)
141		{
142	6	$this->controllerMetaData = $controllerMetaData;
143	6	return $this;
144		}
145
146		/**
147		* Gets templateEngine property
148		*
149		* @return TemplateEngineInterface
150		*/
151	6	public function getTemplateEngine()
152		{
153	6	if (null == $this->templateEngine) {
154	6	Template::addPath(dirname(dirname(__DIR__)).'/templates');
155	6	$template = (new Template())->initialize();
156	6	$this->setTemplateEngine($template);
157	3	}
158	6	return $this->templateEngine;
159		}
160
161		/**
162		* Sets templateEngine property
163		*
164		* @param TemplateEngineInterface $templateEngine
165		*
166		* @return CreateController
167		*/
168	6	public function setTemplateEngine(TemplateEngineInterface $templateEngine)
169		{
170	6	$this->templateEngine = $templateEngine;
171	6	return $this;
172		}
173
174		/**
175		* Gets basePath property
176		*
177		* @return string
178		*/
179	6	public function getBasePath()
180		{
181	6	if (null == $this->basePath) {
182	6	$this->basePath = strtolower($this->controllerName);
183	3	}
184	6	return $this->basePath;
185		}
186
187		/**
188		* Gets controllerFile property
189		*
190		* @return string
191		*/
192	16	public function getControllerFile()
193		{
194	16	if (null == $this->controllerFile) {
195	16	$this->setControllerFile(
196	16	"{$this->sourcePath}/{$this->namespace}/" .
197	16	"{$this->controllerName}.php"
198	8	);
199	8	}
200	16	return $this->controllerFile;
201		}
202
203		/**
204		* Sets controllerFile property
205		*
206		* @param string $controllerFile
207		*
208		* @return CreateController
209		*/
210	16	public function setControllerFile($controllerFile)
211		{
212	16	$this->controllerFile = $controllerFile;
213	16	return $this;
214		}
215
216		/**
217		* Gets questionHelper property
218		*
219		* @return QuestionHelper
220		*/
221	6	public function getQuestionHelper()
222		{
223	6	if (null == $this->questionHelper) {
224	6	$this->setQuestionHelper($this->getCommand()->getHelper('question'));
		0 ignored issues – show Compatibility introduced 2016-08-23 20:54 UTC by Report Bug Copy Issue Report `$this->getCommand()->getHelper('question')` of type `object<Symfony\Component...Helper\HelperInterface>` is not a sub-type of `object<Symfony\Component...\Helper\QuestionHelper>`. It seems like you assume a concrete implementation of the interface `Symfony\Component\Console\Helper\HelperInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
225	3	}
226	6	return $this->questionHelper;
227		}
228
229		/**
230		* Sets questionHelper property
231		*
232		* @param QuestionHelper $questionHelper
233		*
234		* @return CreateController
235		*/
236	6	public function setQuestionHelper(QuestionHelper $questionHelper)
237		{
238	6	$this->questionHelper = $questionHelper;
239	6	return $this;
240		}
241
242		/**
243		* Configures the controller generator
244		*
245		* @param Controller $controller
246		*/
247	6	protected function configureController(Controller $controller)
248		{
249	6	$controller->setInput($this->getInput())
250	6	->setOutput($this->getOutput())
251	6	->setCommand($this->getCommand());
252	6	$composer = new Composer();
253	6	$controller->add($composer);
254	6	}
255
256		/**
257		* Check controller file existence and ask if can be overridden
258		*
259		* @return bool
260		*/
261	6	protected function overrideFile()
262		{
263	6	if (!is_file($this->getControllerFile())) {
264	2	return true;
265		}
266
267	4	$question = new ConfirmationQuestion(
268	4	"\nThe file <comment>{$this->controllerFile}</comment> already " .
269	4	"exists. Override it (y,N)? ",
270	4	false,
271	2	'/^(y\|yes)/i'
272	2	);
273	4	return (boolean) $this->getQuestionHelper()->ask(
274	4	$this->input,
275	4	$this->output,
276		$question
277	2	);
278		}
279		}

slickframework / mvc

Branch — master (bff1a4)

CreateController::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like