FindObjectsFromSqlQueryFactory::compute() - Code Metrics - Inspection of "Feature: raw sql" - thecodingmachine/database.tdbm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 4.3 (#149)

by Dorian

created 2017-06-15 13:44 UTC

FindObjectsFromSqlQueryFactory::compute() B

↳ Parent: FindObjectsFromSqlQueryFactory

Complexity

Conditions	7
Paths	16

Size

Total Lines	65
Code Lines	40

Duplication

Lines	25
Ratio	38.46 %

Importance

Changes

Metric	Value
dl	25
loc	65
rs	7.1439
c	0
b	0
f	0
cc	7
eloc	40
nc	16
nop	0

How to fix Long Method

<?php

namespace Mouf\Database\TDBM\QueryFactory;

use Doctrine\Common\Cache\Cache;
use Doctrine\DBAL\Schema\ForeignKeyConstraint;
use Doctrine\DBAL\Schema\Schema;
use Mouf\Database\SchemaAnalyzer\SchemaAnalyzer;
use Mouf\Database\TDBM\OrderByAnalyzer;
use Mouf\Database\TDBM\TDBMException;
use Mouf\Database\TDBM\TDBMService;

/**
 * This class is in charge of creating the MagicQuery SQL based on parameters passed to findObjectsFromSql method.
 */
class FindObjectsFromSqlQueryFactory extends AbstractQueryFactory
{
    private $mainTable;
    private $from;
    private $filterString;
    private $cache;
    private $cachePrefix;

    public function __construct(string $mainTable, string $from, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, SchemaAnalyzer $schemaAnalyzer, Cache $cache, string $cachePrefix)
    {
        parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
        $this->mainTable = $mainTable;
        $this->from = $from;
        $this->filterString = $filterString;
        $this->schemaAnalyzer = $schemaAnalyzer;

        $this->cache = $cache;
        $this->cachePrefix = $cachePrefix;
    }

    protected function compute()
    {
        $connection = $this->tdbmService->getConnection();

        $columnsList = null;

        $allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($this->mainTable);

        list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);

        $sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM '.$this->from;

        // Let's compute the COUNT.
        $pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
        $pkColumnNames = array_map(function ($pkColumn) {

            return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
        }, $pkColumnNames);

        $countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM '.$this->from;

        // Add joins on inherited tables if necessary
        if (count($allFetchedTables) > 1) {
            $joinSql = '';
            $parentFks = $this->getParentRelationshipForeignKeys($this->mainTable);
            foreach ($parentFks as $fk) {

                $joinSql .= sprintf(' JOIN %s ON (%s.%s = %s.%s)',
                    $connection->quoteIdentifier($fk->getForeignTableName()),
                    $connection->quoteIdentifier($fk->getLocalTableName()),
                    $connection->quoteIdentifier($fk->getLocalColumns()[0]),
                    $connection->quoteIdentifier($fk->getForeignTableName()),
                    $connection->quoteIdentifier($fk->getForeignColumns()[0])
                );
            }

            $childrenFks = $this->getChildrenRelationshipForeignKeys($this->mainTable);
            foreach ($childrenFks as $fk) {

                $joinSql .= sprintf(' LEFT JOIN %s ON (%s.%s = %s.%s)',
                    $connection->quoteIdentifier($fk->getLocalTableName()),
                    $connection->quoteIdentifier($fk->getForeignTableName()),
                    $connection->quoteIdentifier($fk->getForeignColumns()[0]),
                    $connection->quoteIdentifier($fk->getLocalTableName()),
                    $connection->quoteIdentifier($fk->getLocalColumns()[0])
                );
            }

            $sql .= $joinSql;
        }

        if (!empty($this->filterString)) {

            $sql .= ' WHERE '.$this->filterString;
            $countSql .= ' WHERE '.$this->filterString;
        }

        if (!empty($orderString)) {
            $sql .= ' ORDER BY '.$orderString;
        }

        if (stripos($countSql, 'GROUP BY') !== false) {
            throw new TDBMException('Unsupported use of GROUP BY in SQL request.');
        }

        $this->magicSql = $sql;
        $this->magicSqlCount = $countSql;
        $this->columnDescList = $columnDescList;
    }

    /**
     * @param string $tableName
     *
     * @return ForeignKeyConstraint[]
     */
    private function getParentRelationshipForeignKeys($tableName)
    {
        return $this->fromCache($this->cachePrefix.'_parentrelationshipfks_'.$tableName, function () use ($tableName) {
            return $this->getParentRelationshipForeignKeysWithoutCache($tableName);
        });
    }

    /**
     * @param string $tableName
     *
     * @return ForeignKeyConstraint[]
     */
    private function getParentRelationshipForeignKeysWithoutCache($tableName)
    {
        $parentFks = [];
        $currentTable = $tableName;
        while ($currentFk = $this->schemaAnalyzer->getParentRelationship($currentTable)) {

            $currentTable = $currentFk->getForeignTableName();
            $parentFks[] = $currentFk;
        }

        return $parentFks;
    }

    /**
     * @param string $tableName
     *
     * @return ForeignKeyConstraint[]
     */
    private function getChildrenRelationshipForeignKeys(string $tableName) : array
    {
        return $this->fromCache($this->cachePrefix.'_childrenrelationshipfks_'.$tableName, function () use ($tableName) {
            return $this->getChildrenRelationshipForeignKeysWithoutCache($tableName);
        });
    }

    /**
     * @param string $tableName
     *
     * @return ForeignKeyConstraint[]
     */
    private function getChildrenRelationshipForeignKeysWithoutCache(string $tableName) : array
    {
        $children = $this->schemaAnalyzer->getChildrenRelationships($tableName);


        if (!empty($children)) {
            $fksTables = array_map(function (ForeignKeyConstraint $fk) {
                return $this->getChildrenRelationshipForeignKeys($fk->getLocalTableName());
            }, $children);

            $fks = array_merge($children, call_user_func_array('array_merge', $fksTables));

            return $fks;
        } else {
            return [];
        }
    }

    /**
     * Returns an item from cache or computes it using $closure and puts it in cache.
     *
     * @param string   $key
     * @param callable $closure
     *
     * @return mixed
     */
    protected function fromCache(string $key, callable $closure)

    {
        $item = $this->cache->fetch($key);
        if ($item === false) {
            $item = $closure();
            $this->cache->save($key, $item);
        }

        return $item;
    }
}


1		<?php
2
3		namespace Mouf\Database\TDBM\QueryFactory;
4
5		use Doctrine\Common\Cache\Cache;
6		use Doctrine\DBAL\Schema\ForeignKeyConstraint;
7		use Doctrine\DBAL\Schema\Schema;
8		use Mouf\Database\SchemaAnalyzer\SchemaAnalyzer;
9		use Mouf\Database\TDBM\OrderByAnalyzer;
10		use Mouf\Database\TDBM\TDBMException;
11		use Mouf\Database\TDBM\TDBMService;
12
13		/**
14		* This class is in charge of creating the MagicQuery SQL based on parameters passed to findObjectsFromSql method.
15		*/
16		class FindObjectsFromSqlQueryFactory extends AbstractQueryFactory
17		{
18		private $mainTable;
19		private $from;
20		private $filterString;
21		private $cache;
22		private $cachePrefix;
23
24		public function __construct(string $mainTable, string $from, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, SchemaAnalyzer $schemaAnalyzer, Cache $cache, string $cachePrefix)
25		{
26		parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
27		$this->mainTable = $mainTable;
28		$this->from = $from;
29		$this->filterString = $filterString;
30		$this->schemaAnalyzer = $schemaAnalyzer;
		0 ignored issues – show Bug introduced 2016-09-29 10:13 UTC by Report Bug Copy Issue Report The property `schemaAnalyzer` does not seem to exist. Did you mean `schema`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
31		$this->cache = $cache;
32		$this->cachePrefix = $cachePrefix;
33		}
34
35		protected function compute()
36		{
37		$connection = $this->tdbmService->getConnection();
38
39		$columnsList = null;
40
41		$allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($this->mainTable);
42
43		list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);
44
45		$sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM '.$this->from;
46
47		// Let's compute the COUNT.
48		$pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
49	View Code Duplication	$pkColumnNames = array_map(function ($pkColumn) {
		0 ignored issues – show Duplication introduced 2016-09-29 10:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
50		return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
51		}, $pkColumnNames);
52
53		$countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM '.$this->from;
54
55		// Add joins on inherited tables if necessary
56		if (count($allFetchedTables) > 1) {
57		$joinSql = '';
58		$parentFks = $this->getParentRelationshipForeignKeys($this->mainTable);
59	View Code Duplication	foreach ($parentFks as $fk) {
		0 ignored issues – show Duplication introduced 2016-04-27 13:02 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
60		$joinSql .= sprintf(' JOIN %s ON (%s.%s = %s.%s)',
61		$connection->quoteIdentifier($fk->getForeignTableName()),
62		$connection->quoteIdentifier($fk->getLocalTableName()),
63		$connection->quoteIdentifier($fk->getLocalColumns()[0]),
64		$connection->quoteIdentifier($fk->getForeignTableName()),
65		$connection->quoteIdentifier($fk->getForeignColumns()[0])
66		);
67		}
68
69		$childrenFks = $this->getChildrenRelationshipForeignKeys($this->mainTable);
70	View Code Duplication	foreach ($childrenFks as $fk) {
		0 ignored issues – show Duplication introduced 2016-09-29 10:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
71		$joinSql .= sprintf(' LEFT JOIN %s ON (%s.%s = %s.%s)',
72		$connection->quoteIdentifier($fk->getLocalTableName()),
73		$connection->quoteIdentifier($fk->getForeignTableName()),
74		$connection->quoteIdentifier($fk->getForeignColumns()[0]),
75		$connection->quoteIdentifier($fk->getLocalTableName()),
76		$connection->quoteIdentifier($fk->getLocalColumns()[0])
77		);
78		}
79
80		$sql .= $joinSql;
81		}
82
83	View Code Duplication	if (!empty($this->filterString)) {
		0 ignored issues – show Duplication introduced 2016-09-29 10:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
84		$sql .= ' WHERE '.$this->filterString;
85		$countSql .= ' WHERE '.$this->filterString;
86		}
87
88		if (!empty($orderString)) {
89		$sql .= ' ORDER BY '.$orderString;
90		}
91
92		if (stripos($countSql, 'GROUP BY') !== false) {
93		throw new TDBMException('Unsupported use of GROUP BY in SQL request.');
94		}
95
96		$this->magicSql = $sql;
97		$this->magicSqlCount = $countSql;
98		$this->columnDescList = $columnDescList;
99		}
100
101		/**
102		* @param string $tableName
103		*
104		* @return ForeignKeyConstraint[]
105		*/
106		private function getParentRelationshipForeignKeys($tableName)
107		{
108		return $this->fromCache($this->cachePrefix.'_parentrelationshipfks_'.$tableName, function () use ($tableName) {
109		return $this->getParentRelationshipForeignKeysWithoutCache($tableName);
110		});
111		}
112
113		/**
114		* @param string $tableName
115		*
116		* @return ForeignKeyConstraint[]
117		*/
118		private function getParentRelationshipForeignKeysWithoutCache($tableName)
119		{
120		$parentFks = [];
121		$currentTable = $tableName;
122		while ($currentFk = $this->schemaAnalyzer->getParentRelationship($currentTable)) {
		0 ignored issues – show Bug introduced 2016-09-29 10:13 UTC by Report Bug Copy Issue Report The property `schemaAnalyzer` does not seem to exist. Did you mean `schema`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
123		$currentTable = $currentFk->getForeignTableName();
124		$parentFks[] = $currentFk;
125		}
126
127		return $parentFks;
128		}
129
130		/**
131		* @param string $tableName
132		*
133		* @return ForeignKeyConstraint[]
134		*/
135		private function getChildrenRelationshipForeignKeys(string $tableName) : array
136		{
137		return $this->fromCache($this->cachePrefix.'_childrenrelationshipfks_'.$tableName, function () use ($tableName) {
138		return $this->getChildrenRelationshipForeignKeysWithoutCache($tableName);
139		});
140		}
141
142		/**
143		* @param string $tableName
144		*
145		* @return ForeignKeyConstraint[]
146		*/
147		private function getChildrenRelationshipForeignKeysWithoutCache(string $tableName) : array
148		{
149		$children = $this->schemaAnalyzer->getChildrenRelationships($tableName);
		0 ignored issues – show Bug introduced 2016-09-29 10:13 UTC by Report Bug Copy Issue Report The property `schemaAnalyzer` does not seem to exist. Did you mean `schema`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
150
151		if (!empty($children)) {
152		$fksTables = array_map(function (ForeignKeyConstraint $fk) {
153		return $this->getChildrenRelationshipForeignKeys($fk->getLocalTableName());
154		}, $children);
155
156		$fks = array_merge($children, call_user_func_array('array_merge', $fksTables));
157
158		return $fks;
159		} else {
160		return [];
161		}
162		}
163
164		/**
165		* Returns an item from cache or computes it using $closure and puts it in cache.
166		*
167		* @param string $key
168		* @param callable $closure
169		*
170		* @return mixed
171		*/
172	View Code Duplication	protected function fromCache(string $key, callable $closure)
		0 ignored issues – show Duplication introduced 2016-09-29 10:13 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
173		{
174		$item = $this->cache->fetch($key);
175		if ($item === false) {
176		$item = $closure();
177		$this->cache->save($key, $item);
178		}
179
180		return $item;
181		}
182		}
183

thecodingmachine / database.tdbm

Pull Request — 4.3 (#149)

FindObjectsFromSqlQueryFactory::compute() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like