FormCommand::checkColumn() - Code Metrics - Inspection of "add a command:form filed generator" - z-song/laravel-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2262)

unknown

created 2018-08-02 09:32 UTC

FormCommand::checkColumn() A

↳ Parent: FormCommand

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	3
nop	2
dl	0
loc	9
rs	9.9666
c	0
b	0
f	0

<?php

namespace Encore\Admin\Console;

use Illuminate\Console\Command;
use Symfony\Component\Console\Input\InputOption;

class FormCommand extends Command
{
    /**
     * The console command name.
     *
     * @var string
     */
    protected $name = 'admin:form';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'laravel-admin form filed generator';

    /**
     * Execute the console command.
     *
     * @return bool
     */
    public function handle()
    {
        $modelName = $this->option('model');
        if (empty($modelName) || !class_exists($modelName)) {
            $this->error('Model does not exists !');
            return false;
        }

        // use doctrine/dbal
        $model = $this->laravel->make($modelName);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $table = $model->getConnection()->getTablePrefix() . $model->getTable();
        $schema = $model->getConnection()->getDoctrineSchemaManager($table);

        if (!method_exists($schema, 'getDatabasePlatform')) {
            $this->error('You need to require doctrine/dbal: ~2.3 in your own composer.json to get database columns. ');
            $this->info('Using install command: composer require doctrine/dbal');
            return false;

        }

        // custom mapping the types that doctrine/dbal does not support
        $databasePlatform = $schema->getDatabasePlatform();
        $databasePlatform->registerDoctrineTypeMapping('enum', 'string');
        $databasePlatform->registerDoctrineTypeMapping('geometry', 'string');
        $databasePlatform->registerDoctrineTypeMapping('geometrycollection', 'string');
        $databasePlatform->registerDoctrineTypeMapping('linestring', 'string');
        $databasePlatform->registerDoctrineTypeMapping('multilinestring', 'string');
        $databasePlatform->registerDoctrineTypeMapping('multipoint', 'string');
        $databasePlatform->registerDoctrineTypeMapping('multipolygon', 'string');
        $databasePlatform->registerDoctrineTypeMapping('point', 'string');
        $databasePlatform->registerDoctrineTypeMapping('polygon', 'string');
        $databasePlatform->registerDoctrineTypeMapping('multipolygon', 'string');
        $databasePlatform->registerDoctrineTypeMapping('multipolygon', 'string');

        $database = null;
        if (strpos($table, '.')) {
            list($database, $table) = explode('.', $table);
        }
        $columns = $schema->listTableColumns($table, $database);

        $adminForm = '';
        if ($columns) {
            foreach ($columns as $column) {
                $name = $column->getName();
                if (in_array($name, ['id', 'created_at', 'deleted_at'])) {
                    continue;
                }
                $type = $column->getType()->getName();
                $comment = $column->getComment();
                $default = $column->getDefault();

                switch ($type) {
                    case 'boolean':
                    case 'bool':
                        $fieldType = 'switch';
                        break;
                    case 'json':
                    case 'array':
                    case 'object':
                        $fieldType = 'text';
                        break;
                    case 'string':
                        switch ($name) {
                            case $this->checkColumn($name, ['email']):
                                $fieldType = 'email';
                                break;
                            case $this->checkColumn($name, ['password', 'pwd']):
                                $fieldType = 'password';
                                break;
                            case $this->checkColumn($name, ['url', 'link', 'src', 'href']):
                                $fieldType = 'url';
                                break;
                            case $this->checkColumn($name, ['ip']):
                                $fieldType = 'ip';
                                break;
                            case $this->checkColumn($name, ['mobile', 'phone']):
                                $fieldType = 'mobile';
                                break;
                            case $this->checkColumn($name, ['color', 'rgb']):
                                $fieldType = 'color';
                                break;
                            case $this->checkColumn($name, ['image', 'img', 'avatar']) :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
                                $fieldType = 'image';
                                break;
                            case $this->checkColumn($name, ['file', 'attachment']) :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
                                $fieldType = 'file';
                                break;
                            default:
                                $fieldType = 'text';
                        }
                        break;
                    case 'integer':
                    case 'bigint':
                    case 'smallint':
                    case 'timestamp':
                        $fieldType = 'number';
                        break;
                    case 'decimal':
                    case 'float':
                    case 'real':
                        $fieldType = 'decimal';
                        break;
                    case 'datetime':
                        $fieldType = 'datetime';
                        $default = "date('Y-m-d H:i:s')";
                        break;
                    case 'date':
                        $fieldType = 'date';
                        $default = "date('Y-m-d')";
                        break;
                    case 'text':
                    case 'blob':
                        $fieldType = 'textarea';
                        $default = "''";
                        break;
                    default:
                        $fieldType = 'text';
                }

                $adminForm .= "\$form->{$fieldType}('{$name}', '{$comment}')->default('{$default}');\n";
            }
            $this->alert("laravel-admin form filed generator for {$modelName}:");
            $this->info($adminForm);
        }

    }

    /**
     * Check if the table column contains the specified keywords of the array.
     *
     * @param string $haystack
     * @param array $needle
     * @return bool
     */
    private function checkColumn(string $haystack, array $needle)
    {
        foreach ($needle as $value) {
            if (strstr($haystack, $value) !== false) {
                return true;
            }
        }
        return false;
    }


    /**
     * Get the console command options.
     *
     * @return array
     */
    protected function getOptions()
    {
        return [
            ['model', null, InputOption::VALUE_REQUIRED,
                'The eloquent model that should be use as controller data source.',],
        ];
    }
}


1			<?php
2
3			namespace Encore\Admin\Console;
4
5			use Illuminate\Console\Command;
6			use Symfony\Component\Console\Input\InputOption;
7
8			class FormCommand extends Command
9			{
10			/**
11			* The console command name.
12			*
13			* @var string
14			*/
15			protected $name = 'admin:form';
16
17			/**
18			* The console command description.
19			*
20			* @var string
21			*/
22			protected $description = 'laravel-admin form filed generator';
23
24			/**
25			* Execute the console command.
26			*
27			* @return bool
28			*/
29			public function handle()
30			{
31			$modelName = $this->option('model');
32			if (empty($modelName) \|\| !class_exists($modelName)) {
33			$this->error('Model does not exists !');
34			return false;
35			}
36
37			// use doctrine/dbal
38			$model = $this->laravel->make($modelName);
			0 ignored issues – show Bug introduced 2018-08-02 05:44 UTC by Report Bug Copy Issue Report It seems like `$modelName` defined by `$this->option('model')` on line `31` can also be of type `array`; however, `Illuminate\Contracts\Container\Container::make()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
39			$table = $model->getConnection()->getTablePrefix() . $model->getTable();
40			$schema = $model->getConnection()->getDoctrineSchemaManager($table);
41
42			if (!method_exists($schema, 'getDatabasePlatform')) {
43			$this->error('You need to require doctrine/dbal: ~2.3 in your own composer.json to get database columns. ');
44			$this->info('Using install command: composer require doctrine/dbal');
45			return false;
46
47			}
48
49			// custom mapping the types that doctrine/dbal does not support
50			$databasePlatform = $schema->getDatabasePlatform();
51			$databasePlatform->registerDoctrineTypeMapping('enum', 'string');
52			$databasePlatform->registerDoctrineTypeMapping('geometry', 'string');
53			$databasePlatform->registerDoctrineTypeMapping('geometrycollection', 'string');
54			$databasePlatform->registerDoctrineTypeMapping('linestring', 'string');
55			$databasePlatform->registerDoctrineTypeMapping('multilinestring', 'string');
56			$databasePlatform->registerDoctrineTypeMapping('multipoint', 'string');
57			$databasePlatform->registerDoctrineTypeMapping('multipolygon', 'string');
58			$databasePlatform->registerDoctrineTypeMapping('point', 'string');
59			$databasePlatform->registerDoctrineTypeMapping('polygon', 'string');
60			$databasePlatform->registerDoctrineTypeMapping('multipolygon', 'string');
61			$databasePlatform->registerDoctrineTypeMapping('multipolygon', 'string');
62
63			$database = null;
64			if (strpos($table, '.')) {
65			list($database, $table) = explode('.', $table);
66			}
67			$columns = $schema->listTableColumns($table, $database);
68
69			$adminForm = '';
70			if ($columns) {
71			foreach ($columns as $column) {
72			$name = $column->getName();
73			if (in_array($name, ['id', 'created_at', 'deleted_at'])) {
74			continue;
75			}
76			$type = $column->getType()->getName();
77			$comment = $column->getComment();
78			$default = $column->getDefault();
79
80			switch ($type) {
81			case 'boolean':
82			case 'bool':
83			$fieldType = 'switch';
84			break;
85			case 'json':
86			case 'array':
87			case 'object':
88			$fieldType = 'text';
89			break;
90			case 'string':
91			switch ($name) {
92			case $this->checkColumn($name, ['email']):
93			$fieldType = 'email';
94			break;
95			case $this->checkColumn($name, ['password', 'pwd']):
96			$fieldType = 'password';
97			break;
98			case $this->checkColumn($name, ['url', 'link', 'src', 'href']):
99			$fieldType = 'url';
100			break;
101			case $this->checkColumn($name, ['ip']):
102			$fieldType = 'ip';
103			break;
104			case $this->checkColumn($name, ['mobile', 'phone']):
105			$fieldType = 'mobile';
106			break;
107			case $this->checkColumn($name, ['color', 'rgb']):
108			$fieldType = 'color';
109			break;
110			case $this->checkColumn($name, ['image', 'img', 'avatar']) :
			0 ignored issues – show Coding Style introduced 2018-08-02 05:44 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
111			$fieldType = 'image';
112			break;
113			case $this->checkColumn($name, ['file', 'attachment']) :
			0 ignored issues – show Coding Style introduced 2018-08-02 05:44 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
114			$fieldType = 'file';
115			break;
116			default:
117			$fieldType = 'text';
118			}
119			break;
120			case 'integer':
121			case 'bigint':
122			case 'smallint':
123			case 'timestamp':
124			$fieldType = 'number';
125			break;
126			case 'decimal':
127			case 'float':
128			case 'real':
129			$fieldType = 'decimal';
130			break;
131			case 'datetime':
132			$fieldType = 'datetime';
133			$default = "date('Y-m-d H:i:s')";
134			break;
135			case 'date':
136			$fieldType = 'date';
137			$default = "date('Y-m-d')";
138			break;
139			case 'text':
140			case 'blob':
141			$fieldType = 'textarea';
142			$default = "''";
143			break;
144			default:
145			$fieldType = 'text';
146			}
147
148			$adminForm .= "\$form->{$fieldType}('{$name}', '{$comment}')->default('{$default}');\n";
149			}
150			$this->alert("laravel-admin form filed generator for {$modelName}:");
151			$this->info($adminForm);
152			}
153
154			}
155
156			/**
157			* Check if the table column contains the specified keywords of the array.
158			*
159			* @param string $haystack
160			* @param array $needle
161			* @return bool
162			*/
163			private function checkColumn(string $haystack, array $needle)
164			{
165			foreach ($needle as $value) {
166			if (strstr($haystack, $value) !== false) {
167			return true;
168			}
169			}
170			return false;
171			}
172
173
174			/**
175			* Get the console command options.
176			*
177			* @return array
178			*/
179			protected function getOptions()
180			{
181			return [
182			['model', null, InputOption::VALUE_REQUIRED,
183			'The eloquent model that should be use as controller data source.',],
184			];
185			}
186			}
187

z-song / laravel-admin

Pull Request — master (#2262)

FormCommand::checkColumn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like