GeneratePhpModel::check() - Code Metrics - Inspection of "Unified duplicated code on TableInformation" - shawe/FSConsoleTools - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ff9e28...8752e2 )

by Francesc

created 2018-05-28 23:04 UTC

GeneratePhpModel::check() C

↳ Parent: GeneratePhpModel

Complexity

Conditions	8
Paths	6

Size

Total Lines	23
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	16
nc	6
nop	0
dl	0
loc	23
rs	6.1403
c	0
b	0
f	0

<?php
/**
 * This file is part of FSConsoleTools
 * Copyright (C) 2018 Francesc Pineda Segarra <[email protected]>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace FacturaScriptsUtils\Console\Command;

use FacturaScriptsUtils\Console\ConsoleAbstract;

if (!\defined('DB_CONNECTION')) {
    \define('DB_CONNECTION', false);
}

/**
 * Class GeneratePhpModel.
 *
 * @author Francesc Pineda Segarra <[email protected]>
 */
class GeneratePhpModel extends ConsoleAbstract
{
    use Common\TableInformation;

    /**
     * Constant values for return, to easy know how execution ends.
     */
    const RETURN_SUCCESS = 0;
    const RETURN_TABLE_NAME_NOT_SET = 1;
    const RETURN_MODEL_NAME_NOT_SET = 2;
    const RETURN_DST_FOLDER_NOT_SET = 3;
    const RETURN_CANT_CREATE_FOLDER = 4;
    const RETURN_TABLE_NOT_EXISTS = 5;
    const RETURN_FAIL_SAVING_FILE = 6;

    /**
     * Start point to run the command.
     *
     * @param array $params
     *
     * @return int
     */
    public function run(...$params): int
    {
        if (!\DB_CONNECTION) {
            echo 'A database connection is needed. Do you set your config.php file?';
        }

        $status = $this->checkOptions($params);
        if ($status !== 0) {
            return $status;
        }

        $status = $this->checkParams($params);
        if ($status !== 0) {
            return $status;
        }

        echo 'Generating Model class file' . \PHP_EOL . \PHP_EOL;
        echo '   Options setted:' . \PHP_EOL;
        echo '      Table name: ' . $this->getTableName() . \PHP_EOL;
        echo '      Model name: ' . $this->getModelName() . \PHP_EOL;
        echo '      Destiny path: ' . $this->getDstFolder() . \PHP_EOL;

        if (!$this->areYouSure()) {
            echo '   Options [TABLE NAME] [MODEL NAME] [DST]' . \PHP_EOL;
            return self::RETURN_SUCCESS;
        }

        $status = $this->check();
        if ($status !== 0) {
            return $status;
        }

        return $this->generateModel();
    }

    /**
     * Return description about this class.
     *
     * @return string
     */
    public function getDescription(): string
    {
        return 'Generate a model class from database table.';
    }

    /**
     * Print help information to the user.
     *
     * @return string
     */
    public function getHelpMsg(): string
    {
        $array = \explode('\\', __CLASS__);
        $class = array_pop($array);
        return 'Use as: php vendor/bin/console ' . $class . ' [OPTIONS]' . \PHP_EOL
            . 'Available options:' . \PHP_EOL
            . '   -h, --help        Show this help.' . \PHP_EOL
            . '   -t, --tables      Show tables.' . \PHP_EOL
            . '   -g, --gen         Generate model.' . \PHP_EOL
            . \PHP_EOL
            . '   OPTION1           Table name' . \PHP_EOL
            . '   OPTION2           Model name' . \PHP_EOL
            . '   OPTION3           Destiny path' . \PHP_EOL
            . \PHP_EOL;
    }

    /**
     * Returns an associative array of available methods for the user.
     * Add more options if you want to add support for custom methods.
     *      [
     *          '-h'        => 'getHelpMsg',
     *          '--help'    => 'getHelpMsg',
     *      ]
     *
     * @return array
     */
    public function getUserMethods(): array
    {
        // Adding extra method
        $methods = parent::getUserMethods();
        $methods['-t'] = 'getTablesMsg';
        $methods['--tables'] = 'getTablesMsg';
        $methods['-g'] = 'generateModel';
        $methods['--gen'] = 'generateModel';
        return $methods;
    }

    /**
     * Check if options are looking for help.
     *
     * @param array $params
     *
     * @return int
     */
    private function checkOptions(array $params = []): int
    {
        if (isset($params[0])) {
            switch ($params[0]) {
                case '-h':
                case '--help':
                    echo $this->getHelpMsg();
                    return -1;
                case '-t':
                case '--tables':
                    $this->setDataBase($params[1]);
                    echo $this->getTablesMsg();
                    return -1;
                case '-g':
                case '--gen':
                    $this->setTableName($params[1] ?? '');
                    $this->setModelName($params[2] ?? '');
                    $this->setDstFolder(\FS_FOLDER . ($params[3] ?? 'Core/Model'));
                    $this->setDataBase($params[4]);
            }
        }
        return 0;
    }

    /**
     * Check if options are looking for help.
     *
     * @param array $params
     *
     * @return int
     */
    private function checkParams(array $params = []): int
    {
        if (!isset($params[0])) {
            echo 'No table name setted.' . \PHP_EOL;
            return -1;
        }
        if (!isset($params[1])) {
            echo 'No model name setted.' . \PHP_EOL;
            return -1;
        }
        return 0;
    }

    /**
     * Launch basic checks.
     *
     * @return int
     */
    private function check(): int
    {
        if ($this->getTableName() === null) {

            echo 'ERROR: Table name not setted.' . \PHP_EOL . \PHP_EOL;
            return self::RETURN_TABLE_NAME_NOT_SET;
        }
        if ($this->getModelName() === null) {

            echo 'ERROR: Model name not setted.' . \PHP_EOL . \PHP_EOL;
            return self::RETURN_MODEL_NAME_NOT_SET;
        }
        if ($this->getDstFolder() === null) {

            echo 'ERROR: Destiny folder not setted.' . \PHP_EOL . \PHP_EOL;
            return self::RETURN_DST_FOLDER_NOT_SET;
        }
        if (!is_file($this->getDstFolder()) && !@mkdir($this->getDstFolder()) && !is_dir($this->getDstFolder())) {
            echo "ERROR: Can't create folder " . $this->getDstFolder() . '.' . \PHP_EOL . \PHP_EOL;
            return self::RETURN_CANT_CREATE_FOLDER;
        }
        if (!\in_array($this->getTableName(), $this->dataBase->getTables(), false)) {
            echo 'ERROR: Table not exists.' . \PHP_EOL . \PHP_EOL;
            return self::RETURN_TABLE_NOT_EXISTS;
        }
        return self::RETURN_SUCCESS;
    }

    /**
     * Generate model file.
     *
     * @return int
     */
    private function generateModel(): int
    {
        $loader = new \Twig_Loader_Filesystem([__DIR__ . '/../Template']);
        $twig = new \Twig_Environment($loader, ['debug' => \FS_DEBUG,]);
        $twig->addExtension(new \Twig_Extension_Debug());
        $txt = $twig->render(
            'Model.php.twig',
            ['fsc' => $this]
        );

        $status = $this->saveFile($this->getDstFolder() . $this->getModelName() . '.php', $txt);
        if (\is_bool($status)) {

            echo "Can't save " . $this->getDstFolder() . $this->getModelName() . '.php"' . \PHP_EOL;
            return $status;
        }
        echo 'Finished! Look at "' . $this->getDstFolder() . '"' . \PHP_EOL;
        return self::RETURN_SUCCESS;
    }
}


1			<?php
2			/**
3			* This file is part of FSConsoleTools
4			* Copyright (C) 2018 Francesc Pineda Segarra <[email protected]>
5			*
6			* This program is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU Lesser General Public License as
8			* published by the Free Software Foundation, either version 3 of the
9			* License, or (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU Lesser General Public License for more details.
15			*
16			* You should have received a copy of the GNU Lesser General Public License
17			* along with this program. If not, see <http://www.gnu.org/licenses/>.
18			*/
19
20			namespace FacturaScriptsUtils\Console\Command;
21
22			use FacturaScriptsUtils\Console\ConsoleAbstract;
23
24			if (!\defined('DB_CONNECTION')) {
25			\define('DB_CONNECTION', false);
26			}
27
28			/**
29			* Class GeneratePhpModel.
30			*
31			* @author Francesc Pineda Segarra <[email protected]>
32			*/
33			class GeneratePhpModel extends ConsoleAbstract
34			{
35			use Common\TableInformation;
36
37			/**
38			* Constant values for return, to easy know how execution ends.
39			*/
40			const RETURN_SUCCESS = 0;
41			const RETURN_TABLE_NAME_NOT_SET = 1;
42			const RETURN_MODEL_NAME_NOT_SET = 2;
43			const RETURN_DST_FOLDER_NOT_SET = 3;
44			const RETURN_CANT_CREATE_FOLDER = 4;
45			const RETURN_TABLE_NOT_EXISTS = 5;
46			const RETURN_FAIL_SAVING_FILE = 6;
47
48			/**
49			* Start point to run the command.
50			*
51			* @param array $params
52			*
53			* @return int
54			*/
55			public function run(...$params): int
56			{
57			if (!\DB_CONNECTION) {
58			echo 'A database connection is needed. Do you set your config.php file?';
59			}
60
61			$status = $this->checkOptions($params);
62			if ($status !== 0) {
63			return $status;
64			}
65
66			$status = $this->checkParams($params);
67			if ($status !== 0) {
68			return $status;
69			}
70
71			echo 'Generating Model class file' . \PHP_EOL . \PHP_EOL;
72			echo ' Options setted:' . \PHP_EOL;
73			echo ' Table name: ' . $this->getTableName() . \PHP_EOL;
74			echo ' Model name: ' . $this->getModelName() . \PHP_EOL;
75			echo ' Destiny path: ' . $this->getDstFolder() . \PHP_EOL;
76
77			if (!$this->areYouSure()) {
78			echo ' Options [TABLE NAME] [MODEL NAME] [DST]' . \PHP_EOL;
79			return self::RETURN_SUCCESS;
80			}
81
82			$status = $this->check();
83			if ($status !== 0) {
84			return $status;
85			}
86
87			return $this->generateModel();
88			}
89
90			/**
91			* Return description about this class.
92			*
93			* @return string
94			*/
95			public function getDescription(): string
96			{
97			return 'Generate a model class from database table.';
98			}
99
100			/**
101			* Print help information to the user.
102			*
103			* @return string
104			*/
105			public function getHelpMsg(): string
106			{
107			$array = \explode('\\', __CLASS__);
108			$class = array_pop($array);
109			return 'Use as: php vendor/bin/console ' . $class . ' [OPTIONS]' . \PHP_EOL
110			. 'Available options:' . \PHP_EOL
111			. ' -h, --help Show this help.' . \PHP_EOL
112			. ' -t, --tables Show tables.' . \PHP_EOL
113			. ' -g, --gen Generate model.' . \PHP_EOL
114			. \PHP_EOL
115			. ' OPTION1 Table name' . \PHP_EOL
116			. ' OPTION2 Model name' . \PHP_EOL
117			. ' OPTION3 Destiny path' . \PHP_EOL
118			. \PHP_EOL;
119			}
120
121			/**
122			* Returns an associative array of available methods for the user.
123			* Add more options if you want to add support for custom methods.
124			* [
125			* '-h' => 'getHelpMsg',
126			* '--help' => 'getHelpMsg',
127			* ]
128			*
129			* @return array
130			*/
131			public function getUserMethods(): array
132			{
133			// Adding extra method
134			$methods = parent::getUserMethods();
135			$methods['-t'] = 'getTablesMsg';
136			$methods['--tables'] = 'getTablesMsg';
137			$methods['-g'] = 'generateModel';
138			$methods['--gen'] = 'generateModel';
139			return $methods;
140			}
141
142			/**
143			* Check if options are looking for help.
144			*
145			* @param array $params
146			*
147			* @return int
148			*/
149			private function checkOptions(array $params = []): int
150			{
151			if (isset($params[0])) {
152			switch ($params[0]) {
153			case '-h':
154			case '--help':
155			echo $this->getHelpMsg();
156			return -1;
157			case '-t':
158			case '--tables':
159			$this->setDataBase($params[1]);
160			echo $this->getTablesMsg();
161			return -1;
162			case '-g':
163			case '--gen':
164			$this->setTableName($params[1] ?? '');
165			$this->setModelName($params[2] ?? '');
166			$this->setDstFolder(\FS_FOLDER . ($params[3] ?? 'Core/Model'));
167			$this->setDataBase($params[4]);
168			}
169			}
170			return 0;
171			}
172
173			/**
174			* Check if options are looking for help.
175			*
176			* @param array $params
177			*
178			* @return int
179			*/
180			private function checkParams(array $params = []): int
181			{
182			if (!isset($params[0])) {
183			echo 'No table name setted.' . \PHP_EOL;
184			return -1;
185			}
186			if (!isset($params[1])) {
187			echo 'No model name setted.' . \PHP_EOL;
188			return -1;
189			}
190			return 0;
191			}
192
193			/**
194			* Launch basic checks.
195			*
196			* @return int
197			*/
198			private function check(): int
199			{
200			if ($this->getTableName() === null) {
			0 ignored issues – show introduced 2018-05-28 23:06 UTC by Report Bug Copy Issue Report The condition `$this->getTableName() === null` is always `false`. Loading history...
201			echo 'ERROR: Table name not setted.' . \PHP_EOL . \PHP_EOL;
202			return self::RETURN_TABLE_NAME_NOT_SET;
203			}
204			if ($this->getModelName() === null) {
			0 ignored issues – show introduced 2018-05-28 23:06 UTC by Report Bug Copy Issue Report The condition `$this->getModelName() === null` is always `false`. Loading history...
205			echo 'ERROR: Model name not setted.' . \PHP_EOL . \PHP_EOL;
206			return self::RETURN_MODEL_NAME_NOT_SET;
207			}
208			if ($this->getDstFolder() === null) {
			0 ignored issues – show introduced 2018-05-28 23:06 UTC by Report Bug Copy Issue Report The condition `$this->getDstFolder() === null` is always `false`. Loading history...
209			echo 'ERROR: Destiny folder not setted.' . \PHP_EOL . \PHP_EOL;
210			return self::RETURN_DST_FOLDER_NOT_SET;
211			}
212			if (!is_file($this->getDstFolder()) && !@mkdir($this->getDstFolder()) && !is_dir($this->getDstFolder())) {
213			echo "ERROR: Can't create folder " . $this->getDstFolder() . '.' . \PHP_EOL . \PHP_EOL;
214			return self::RETURN_CANT_CREATE_FOLDER;
215			}
216			if (!\in_array($this->getTableName(), $this->dataBase->getTables(), false)) {
217			echo 'ERROR: Table not exists.' . \PHP_EOL . \PHP_EOL;
218			return self::RETURN_TABLE_NOT_EXISTS;
219			}
220			return self::RETURN_SUCCESS;
221			}
222
223			/**
224			* Generate model file.
225			*
226			* @return int
227			*/
228			private function generateModel(): int
229			{
230			$loader = new \Twig_Loader_Filesystem([__DIR__ . '/../Template']);
231			$twig = new \Twig_Environment($loader, ['debug' => \FS_DEBUG,]);
232			$twig->addExtension(new \Twig_Extension_Debug());
233			$txt = $twig->render(
234			'Model.php.twig',
235			['fsc' => $this]
236			);
237
238			$status = $this->saveFile($this->getDstFolder() . $this->getModelName() . '.php', $txt);
239			if (\is_bool($status)) {
			0 ignored issues – show introduced 2018-05-28 21:26 UTC by Report Bug Copy Issue Report The condition `is_bool($status)` is always `false`. Loading history...
240			echo "Can't save " . $this->getDstFolder() . $this->getModelName() . '.php"' . \PHP_EOL;
241			return $status;
242			}
243			echo 'Finished! Look at "' . $this->getDstFolder() . '"' . \PHP_EOL;
244			return self::RETURN_SUCCESS;
245			}
246			}
247

shawe / FSConsoleTools

Push — master ( ff9e28...8752e2 )

GeneratePhpModel::check() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like