DbInspector::getForeignKey() - Code Metrics - Inspection of "refactors" - crocodic-studio/crudbooster - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1110)

by Iman

created 2018-03-30 11:52 UTC

DbInspector::getForeignKey() A

↳ Parent: DbInspector

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	5
nc	2
nop	2
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0

<?php

namespace crocodicstudio\crudbooster\helpers;

use Cache;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use crocodicstudio\crudbooster\helpers\Cache as CbCache;
use DB;
use Schema;

class DbInspector
{
    /**
     * @param $table
     * @return bool|null|string
     * @throws \Exception
     */
    public static function findPK($table)
    {
        if (! $table) {
            return 'id';
        }

        if (CbCache::get('table_'.$table, 'primary_key')) {
            return CbCache::get('table_'.$table, 'primary_key');
        }
        $table = CRUDBooster::parseSqlTable($table);

        if (! $table['table']) {
            throw new \Exception("parseSqlTable can't determine the table");
        }

        $primary_key = self::findPKname($table);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

        if (! $primary_key) {

            return 'id';
        }
        CbCache::put('table_'.$table, 'primary_key', $primary_key);

        return $primary_key;
    }

    /**
     * @param $table
     * @param $field
     * @return bool
     */
    public static function isColNull($table, $field)
    {
        $cacheKey = 'field_isNull_'.$table.'_'.$field;

        if (Cache::has($cacheKey)) {
            return Cache::get($cacheKey);

        }

        try {
            //MySQL & SQL Server
            $isNULL = DB::select(DB::raw("select IS_NULLABLE from INFORMATION_SCHEMA.COLUMNS where TABLE_NAME='$table' and COLUMN_NAME = '$field'"))[0]->IS_NULLABLE;
            $isNULL = ($isNULL == 'YES') ? true : false;
        } catch (\Exception $e) {
            $isNULL = false;
        }
        Cache::forever($cacheKey, $isNULL);

        return $isNULL;
    }

    /**
     * @param $columns
     * @return string
     */
    public static function colName($columns)
    {
        $name_col_candidate = cbConfig('NAME_FIELDS_CANDIDATE');
        $name_col_candidate = explode(',', $name_col_candidate);
        $name_col = '';
        foreach ($columns as $c) {
            foreach ($name_col_candidate as $cc) {
                if (strpos($c, $cc) !== false) {
                    $name_col = $c;
                    break;
                }
            }
            if ($name_col) {
                break;
            }
        }
        if ($name_col == '') {
            $name_col = 'id';
        }

        return $name_col;
    }

    /**
     * @param $table
     * @return array
     */
    public static function getTableCols($table)
    {
        $table = CRUDBooster::parseSqlTable($table);
        $cols = collect(DB::select('SELECT * FROM information_schema.COLUMNS WHERE TABLE_SCHEMA = :database AND TABLE_NAME = :table', [
            'database' => $table['database'],
            'table' => $table['table'],
        ]))->map(function ($x) {
            return (array) $x;
        })->toArray();

        return array_column($cols, 'COLUMN_NAME');
    }

    /**
     * @param $table
     * @param $field
     * @return mixed
     */
    public static function getFieldTypes($table, $field)
    {
        $field = 'field_type_'.$table.'_'.$field;

        return Cache::rememberForever($field, function () use ($table, $field) {
            try {
                //MySQL & SQL Server
                $typedata = DB::select(DB::raw("select DATA_TYPE from INFORMATION_SCHEMA.COLUMNS where TABLE_NAME='$table' and COLUMN_NAME = '$field'"))[0]->DATA_TYPE;
            } catch (\Exception $e) {
                $typedata = null;
            }

            return $typedata ?: 'varchar';
        });
    }

    /**
     * @param $fieldName
     * @return bool
     */
    public static function isForeignKey($fieldName)
    {
        $cacheKey = 'isForeignKey_'.$fieldName;

        if (Cache::has($cacheKey)) {
            return Cache::get($cacheKey);

        }

        $table = CRUDBooster::getTableForeignKey($fieldName);
        if (! $table) {
            return false;
        }

        $hasTable = Schema::hasTable($table);
        Cache::forever($cacheKey, $hasTable);

        return $hasTable;
    }

    /**
     * @param $table
     * @return null
     */
    private static function getPKforSqlServer($table)
    {
        try {
            $query = "
						SELECT Col.Column_Name,Col.Table_Name from 
						    INFORMATION_SCHEMA.TABLE_CONSTRAINTS Tab, 
						    INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE Col 
						WHERE 
						    Col.Constraint_Name = Tab.Constraint_Name
						    AND Col.Table_Name = Tab.Table_Name
						    AND Constraint_Type = 'PRIMARY KEY'
							AND Col.Table_Name = '$table[table]' 
					";
            $keys = DB::select($query);
            $primary_key = $keys[0]->Column_Name;
        } catch (\Exception $e) {
            $primary_key = null;
        }

        return $primary_key;
    }

    /**
     * @param $table
     * @return null
     */
    private static function findPKname($table)
    {
        if (env('DB_CONNECTION') == 'sqlsrv') {
            return self::getPKforSqlServer($table);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        }
        try {
            $query = "select * from information_schema.COLUMNS where TABLE_SCHEMA = '$table[database]' and TABLE_NAME = '$table[table]' and COLUMN_KEY = 'PRI'";
            $keys = DB::select($query);
            $primary_key = $keys[0]->COLUMN_NAME;
        } catch (\Exception $e) {
            $primary_key = null;
        }

        return $primary_key;
    }

    public static function listTables()
    {
        $multiple_db = cbConfig('MULTIPLE_DATABASE_MODULE') ?: [];
        $db_database = cbConfig('MAIN_DB_DATABASE');

        if ($multiple_db) {
            try {
                $multiple_db[] = cbConfig('MAIN_DB_DATABASE');
                $query_table_schema = implode("','", $multiple_db);
                $tables = DB::select("SELECT CONCAT(TABLE_SCHEMA,'.',TABLE_NAME) FROM INFORMATION_SCHEMA.Tables WHERE TABLE_TYPE = 'BASE TABLE' AND TABLE_SCHEMA != 'mysql' AND TABLE_SCHEMA != 'performance_schema' AND TABLE_SCHEMA != 'information_schema' AND TABLE_SCHEMA != 'phpmyadmin' AND TABLE_SCHEMA IN ('$query_table_schema')");
            } catch (\Exception $e) {
                $tables = [];
            }

            return $tables;
        }

        try {
            $tables = DB::select("SELECT TABLE_NAME FROM INFORMATION_SCHEMA.Tables WHERE TABLE_TYPE = 'BASE TABLE' AND TABLE_SCHEMA = '".$db_database."'");
        } catch (\Exception $e) {
            $tables = [];
        }

        return $tables;
    }

    public static function getForeignKey($parent_table, $child_table)
    {
        $parent_table = CRUDBooster::parseSqlTable($parent_table)['table'];
        $child_table = CRUDBooster::parseSqlTable($child_table)['table'];

        if (\Schema::hasColumn($child_table, 'id_'.$parent_table)) {
            return 'id_'.$parent_table;
        }
        return $parent_table.'_id';
    }
}

1			<?php
2
3			namespace crocodicstudio\crudbooster\helpers;
4
5			use Cache;
			0 ignored issues – show Bug introduced 2018-03-28 13:18 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `crocodicstudio\crudbooster\helpers\Cache`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
6			use crocodicstudio\crudbooster\helpers\Cache as CbCache;
7			use DB;
8			use Schema;
9
10			class DbInspector
11			{
12			/**
13			* @param $table
14			* @return bool\|null\|string
15			* @throws \Exception
16			*/
17			public static function findPK($table)
18			{
19			if (! $table) {
20			return 'id';
21			}
22
23			if (CbCache::get('table_'.$table, 'primary_key')) {
24			return CbCache::get('table_'.$table, 'primary_key');
25			}
26			$table = CRUDBooster::parseSqlTable($table);
27
28			if (! $table['table']) {
29			throw new \Exception("parseSqlTable can't determine the table");
30			}
31
32			$primary_key = self::findPKname($table);
			0 ignored issues – show Bug introduced 2018-03-25 16:05 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$primary_key` is correct as `self::findPKname($table)` targeting `crocodicstudio\crudboost...Inspector::findPKname()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
33
34			if (! $primary_key) {
			0 ignored issues – show introduced 2018-03-30 11:56 UTC by Report Bug Copy Issue Report `$primary_key` is of type `null`, thus it always evaluated to `false`. Loading history...
35			return 'id';
36			}
37			CbCache::put('table_'.$table, 'primary_key', $primary_key);
38
39			return $primary_key;
40			}
41
42			/**
43			* @param $table
44			* @param $field
45			* @return bool
46			*/
47			public static function isColNull($table, $field)
48			{
49			$cacheKey = 'field_isNull_'.$table.'_'.$field;
50
51			if (Cache::has($cacheKey)) {
52			return Cache::get($cacheKey);
			0 ignored issues – show Bug Best Practice introduced 2018-03-26 16:41 UTC by Report Bug Copy Issue Report The expression `return Cache::get($cacheKey)` returns the type `Illuminate\Contracts\Cache\Repository` which is incompatible with the documented return type `boolean`. Loading history...
53			}
54
55			try {
56			//MySQL & SQL Server
57			$isNULL = DB::select(DB::raw("select IS_NULLABLE from INFORMATION_SCHEMA.COLUMNS where TABLE_NAME='$table' and COLUMN_NAME = '$field'"))[0]->IS_NULLABLE;
58			$isNULL = ($isNULL == 'YES') ? true : false;
59			} catch (\Exception $e) {
60			$isNULL = false;
61			}
62			Cache::forever($cacheKey, $isNULL);
63
64			return $isNULL;
65			}
66
67			/**
68			* @param $columns
69			* @return string
70			*/
71			public static function colName($columns)
72			{
73			$name_col_candidate = cbConfig('NAME_FIELDS_CANDIDATE');
74			$name_col_candidate = explode(',', $name_col_candidate);
75			$name_col = '';
76			foreach ($columns as $c) {
77			foreach ($name_col_candidate as $cc) {
78			if (strpos($c, $cc) !== false) {
79			$name_col = $c;
80			break;
81			}
82			}
83			if ($name_col) {
84			break;
85			}
86			}
87			if ($name_col == '') {
88			$name_col = 'id';
89			}
90
91			return $name_col;
92			}
93
94			/**
95			* @param $table
96			* @return array
97			*/
98			public static function getTableCols($table)
99			{
100			$table = CRUDBooster::parseSqlTable($table);
101			$cols = collect(DB::select('SELECT * FROM information_schema.COLUMNS WHERE TABLE_SCHEMA = :database AND TABLE_NAME = :table', [
102			'database' => $table['database'],
103			'table' => $table['table'],
104			]))->map(function ($x) {
105			return (array) $x;
106			})->toArray();
107
108			return array_column($cols, 'COLUMN_NAME');
109			}
110
111			/**
112			* @param $table
113			* @param $field
114			* @return mixed
115			*/
116			public static function getFieldTypes($table, $field)
117			{
118			$field = 'field_type_'.$table.'_'.$field;
119
120			return Cache::rememberForever($field, function () use ($table, $field) {
121			try {
122			//MySQL & SQL Server
123			$typedata = DB::select(DB::raw("select DATA_TYPE from INFORMATION_SCHEMA.COLUMNS where TABLE_NAME='$table' and COLUMN_NAME = '$field'"))[0]->DATA_TYPE;
124			} catch (\Exception $e) {
125			$typedata = null;
126			}
127
128			return $typedata ?: 'varchar';
129			});
130			}
131
132			/**
133			* @param $fieldName
134			* @return bool
135			*/
136			public static function isForeignKey($fieldName)
137			{
138			$cacheKey = 'isForeignKey_'.$fieldName;
139
140			if (Cache::has($cacheKey)) {
141			return Cache::get($cacheKey);
			0 ignored issues – show Bug Best Practice introduced 2018-03-26 16:41 UTC by Report Bug Copy Issue Report The expression `return Cache::get($cacheKey)` returns the type `Illuminate\Contracts\Cache\Repository` which is incompatible with the documented return type `boolean`. Loading history...
142			}
143
144			$table = CRUDBooster::getTableForeignKey($fieldName);
145			if (! $table) {
146			return false;
147			}
148
149			$hasTable = Schema::hasTable($table);
150			Cache::forever($cacheKey, $hasTable);
151
152			return $hasTable;
153			}
154
155			/**
156			* @param $table
157			* @return null
158			*/
159			private static function getPKforSqlServer($table)
160			{
161			try {
162			$query = "
163			SELECT Col.Column_Name,Col.Table_Name from
164			INFORMATION_SCHEMA.TABLE_CONSTRAINTS Tab,
165			INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE Col
166			WHERE
167			Col.Constraint_Name = Tab.Constraint_Name
168			AND Col.Table_Name = Tab.Table_Name
169			AND Constraint_Type = 'PRIMARY KEY'
170			AND Col.Table_Name = '$table[table]'
171			";
172			$keys = DB::select($query);
173			$primary_key = $keys[0]->Column_Name;
174			} catch (\Exception $e) {
175			$primary_key = null;
176			}
177
178			return $primary_key;
179			}
180
181			/**
182			* @param $table
183			* @return null
184			*/
185			private static function findPKname($table)
186			{
187			if (env('DB_CONNECTION') == 'sqlsrv') {
188			return self::getPKforSqlServer($table);
			0 ignored issues – show Bug introduced 2018-03-25 16:05 UTC by Report Bug Copy Issue Report Are you sure the usage of `self::getPKforSqlServer($table)` targeting `crocodicstudio\crudboost...or::getPKforSqlServer()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
189			}
190			try {
191			$query = "select * from information_schema.COLUMNS where TABLE_SCHEMA = '$table[database]' and TABLE_NAME = '$table[table]' and COLUMN_KEY = 'PRI'";
192			$keys = DB::select($query);
193			$primary_key = $keys[0]->COLUMN_NAME;
194			} catch (\Exception $e) {
195			$primary_key = null;
196			}
197
198			return $primary_key;
199			}
200
201			public static function listTables()
202			{
203			$multiple_db = cbConfig('MULTIPLE_DATABASE_MODULE') ?: [];
204			$db_database = cbConfig('MAIN_DB_DATABASE');
205
206			if ($multiple_db) {
207			try {
208			$multiple_db[] = cbConfig('MAIN_DB_DATABASE');
209			$query_table_schema = implode("','", $multiple_db);
210			$tables = DB::select("SELECT CONCAT(TABLE_SCHEMA,'.',TABLE_NAME) FROM INFORMATION_SCHEMA.Tables WHERE TABLE_TYPE = 'BASE TABLE' AND TABLE_SCHEMA != 'mysql' AND TABLE_SCHEMA != 'performance_schema' AND TABLE_SCHEMA != 'information_schema' AND TABLE_SCHEMA != 'phpmyadmin' AND TABLE_SCHEMA IN ('$query_table_schema')");
211			} catch (\Exception $e) {
212			$tables = [];
213			}
214
215			return $tables;
216			}
217
218			try {
219			$tables = DB::select("SELECT TABLE_NAME FROM INFORMATION_SCHEMA.Tables WHERE TABLE_TYPE = 'BASE TABLE' AND TABLE_SCHEMA = '".$db_database."'");
220			} catch (\Exception $e) {
221			$tables = [];
222			}
223
224			return $tables;
225			}
226
227			public static function getForeignKey($parent_table, $child_table)
228			{
229			$parent_table = CRUDBooster::parseSqlTable($parent_table)['table'];
230			$child_table = CRUDBooster::parseSqlTable($child_table)['table'];
231
232			if (\Schema::hasColumn($child_table, 'id_'.$parent_table)) {
233			return 'id_'.$parent_table;
234			}
235			return $parent_table.'_id';
236			}
237			}

crocodic-studio / crudbooster

Pull Request — master (#1110)

DbInspector::getForeignKey() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like