DoctrineDatabase::getLanguageMask() - Code Metrics - Inspection of "EZP-31420: Moved deleting translation logic from S..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp-31420-merge-up ( ec14fb...141a64 )

unknown

created 2020-05-08 17:59 UTC

DoctrineDatabase::getLanguageMask() A

↳ Parent: DoctrineDatabase

Complexity

Conditions	5
Paths	16

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	16
nop	1
dl	0
loc	21
rs	9.2728
c	0
b	0
f	0

<?php

/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\Search\Legacy\Content\Location\Gateway;

use eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter;
use eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\SortClauseConverter;
use eZ\Publish\Core\Search\Legacy\Content\Location\Gateway;
use eZ\Publish\Core\Persistence\Database\DatabaseHandler;
use eZ\Publish\API\Repository\Values\Content\Query;
use eZ\Publish\API\Repository\Values\Content\Query\Criterion;
use eZ\Publish\SPI\Persistence\Content\Language\Handler as LanguageHandler;
use PDO;

/**
 * Location gateway implementation using the Doctrine database.
 */
class DoctrineDatabase extends Gateway
{
    /**
     * 2^30, since PHP_INT_MAX can cause overflows in DB systems, if PHP is run
     * on 64 bit systems.
     */
    const MAX_LIMIT = 1073741824;

    /**
     * Database handler.
     *
     * @var \eZ\Publish\Core\Persistence\Database\DatabaseHandler
     */
    protected $handler;

    /** @var \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter */
    private $criteriaConverter;

    /** @var \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\SortClauseConverter */
    private $sortClauseConverter;

    /**
     * Language handler.
     *
     * @var \eZ\Publish\SPI\Persistence\Content\Language\Handler
     */
    protected $languageHandler;

    /**
     * Construct from database handler.
     *
     * @param \eZ\Publish\Core\Persistence\Database\DatabaseHandler $handler
     * @param \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter $criteriaConverter
     * @param \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\SortClauseConverter $sortClauseConverter
     * @param \eZ\Publish\SPI\Persistence\Content\Language\Handler $languageHandler
     */
    public function __construct(
        DatabaseHandler $handler,
        CriteriaConverter $criteriaConverter,
        SortClauseConverter $sortClauseConverter,
        LanguageHandler $languageHandler
    ) {
        $this->handler = $handler;
        $this->criteriaConverter = $criteriaConverter;
        $this->sortClauseConverter = $sortClauseConverter;
        $this->languageHandler = $languageHandler;
    }

    /**
     * Returns total count and data for all Locations satisfying the parameters.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
     * @param int $offset
     * @param int $limit
     * @param \eZ\Publish\API\Repository\Values\Content\Query\SortClause[]|null $sortClauses
     * @param array $languageFilter
     * @param bool $doCount
     *
     * @return mixed[][]
     */
    public function find(
        Criterion $criterion,
        $offset,
        $limit,
        array $sortClauses = null,
        array $languageFilter = [],
        $doCount = true
    ) {
        $count = $doCount ? $this->getTotalCount($criterion, $languageFilter) : null;

        if (!$doCount && $limit === 0) {
            throw new \RuntimeException('Invalid query. Cannot disable count and request 0 items at the same time.');
        }

        if ($limit === 0 || ($count !== null && $count <= $offset)) {

            return ['count' => $count, 'rows' => []];
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        $selectQuery = $this->handler->createSelectQuery();
        $selectQuery->select(
            'ezcontentobject_tree.*',
            $this->handler->quoteColumn('language_mask', 'ezcontentobject'),
            $this->handler->quoteColumn('initial_language_id', 'ezcontentobject')
        );

        if ($sortClauses !== null) {
            $this->sortClauseConverter->applySelect($selectQuery, $sortClauses);
        }

        $selectQuery
            ->from($this->handler->quoteTable('ezcontentobject_tree'))
            ->innerJoin(
                'ezcontentobject',
                'ezcontentobject_tree.contentobject_id',
                'ezcontentobject.id'
            )
            ->innerJoin(
                'ezcontentobject_version',
                'ezcontentobject.id',
                'ezcontentobject_version.contentobject_id'
            );

        if ($sortClauses !== null) {
            $this->sortClauseConverter->applyJoin($selectQuery, $sortClauses, $languageFilter);
        }

        $selectQuery->where(
            $this->criteriaConverter->convertCriteria($selectQuery, $criterion, $languageFilter),
            $selectQuery->expr->eq(
                'ezcontentobject.status',
                //ContentInfo::STATUS_PUBLISHED
                $selectQuery->bindValue(1, null, PDO::PARAM_INT)
            ),
            $selectQuery->expr->eq(
                'ezcontentobject_version.status',
                //VersionInfo::STATUS_PUBLISHED
                $selectQuery->bindValue(1, null, PDO::PARAM_INT)
            ),
            $selectQuery->expr->neq(
                $this->handler->quoteColumn('depth', 'ezcontentobject_tree'),
                $selectQuery->bindValue(0, null, PDO::PARAM_INT)
            )
        );

        // If not main-languages query
        if (!empty($languageFilter['languages'])) {

            $selectQuery->where(
                $selectQuery->expr->gt(
                    $selectQuery->expr->bitAnd(
                        $this->handler->quoteColumn('language_mask', 'ezcontentobject'),
                        $selectQuery->bindValue(
                            $this->getLanguageMask($languageFilter),
                            null,
                            PDO::PARAM_INT
                        )
                    ),
                    $selectQuery->bindValue(0, null, PDO::PARAM_INT)
                )
            );
        }

        if ($sortClauses !== null) {
            $this->sortClauseConverter->applyOrderBy($selectQuery);
        }

        $selectQuery->limit($limit, $offset);

        $statement = $selectQuery->prepare();
        $statement->execute();

        return [
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            'count' => $count,
            'rows' => $statement->fetchAll(PDO::FETCH_ASSOC),
        ];
    }

    /**
     * Returns total results count for $criterion and $sortClauses.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
     * @param array $languageFilter
     *
     * @return array
     */
    protected function getTotalCount(Criterion $criterion, array $languageFilter)
    {
        $query = $this->handler->createSelectQuery();
        $query
            ->select($query->alias($query->expr->count('*'), 'count'))
            ->from($this->handler->quoteTable('ezcontentobject_tree'))
            ->innerJoin(
                'ezcontentobject',
                'ezcontentobject_tree.contentobject_id',
                'ezcontentobject.id'
            )
            ->innerJoin(
                'ezcontentobject_version',
                'ezcontentobject.id',
                'ezcontentobject_version.contentobject_id'
            );

        $query->where(
            $this->criteriaConverter->convertCriteria($query, $criterion, $languageFilter),
            $query->expr->eq(
                'ezcontentobject.status',
                //ContentInfo::STATUS_PUBLISHED
                $query->bindValue(1, null, PDO::PARAM_INT)
            ),
            $query->expr->eq(
                'ezcontentobject_version.status',
                //VersionInfo::STATUS_PUBLISHED
                $query->bindValue(1, null, PDO::PARAM_INT)
            ),
            $query->expr->neq(
                $this->handler->quoteColumn('depth', 'ezcontentobject_tree'),
                $query->bindValue(0, null, PDO::PARAM_INT)
            )
        );

        // If not main-languages query
        if (!empty($languageFilter['languages'])) {

            $query->where(
                $query->expr->gt(
                    $query->expr->bitAnd(
                        $this->handler->quoteColumn('language_mask', 'ezcontentobject'),
                        $query->bindValue(
                            $this->getLanguageMask($languageFilter),
                            null,
                            PDO::PARAM_INT
                        )
                    ),
                    $query->bindValue(0, null, PDO::PARAM_INT)
                )
            );
        }

        $statement = $query->prepare();
        $statement->execute();

        return (int)$statement->fetchColumn();
    }

    /**
     * Generates a language mask from the given $languageFilter.
     *
     * @param array $languageFilter
     *
     * @return int
     */
    protected function getLanguageMask(array $languageFilter)
    {
        if (!isset($languageFilter['languages'])) {
            $languageFilter['languages'] = [];
        }

        if (!isset($languageFilter['useAlwaysAvailable'])) {
            $languageFilter['useAlwaysAvailable'] = true;
        }

        $mask = 0;
        if ($languageFilter['useAlwaysAvailable']) {
            $mask |= 1;
        }

        foreach ($languageFilter['languages'] as $languageCode) {
            $mask |= $this->languageHandler->loadByLanguageCode($languageCode)->id;
        }

        return $mask;
    }
}


1		<?php
2
3		/**
4		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
5		* @license For full copyright and license information view LICENSE file distributed with this source code.
6		*/
7		namespace eZ\Publish\Core\Search\Legacy\Content\Location\Gateway;
8
9		use eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter;
10		use eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\SortClauseConverter;
11		use eZ\Publish\Core\Search\Legacy\Content\Location\Gateway;
12		use eZ\Publish\Core\Persistence\Database\DatabaseHandler;
13		use eZ\Publish\API\Repository\Values\Content\Query;
14		use eZ\Publish\API\Repository\Values\Content\Query\Criterion;
15		use eZ\Publish\SPI\Persistence\Content\Language\Handler as LanguageHandler;
16		use PDO;
17
18		/**
19		* Location gateway implementation using the Doctrine database.
20		*/
21		class DoctrineDatabase extends Gateway
22		{
23		/**
24		* 2^30, since PHP_INT_MAX can cause overflows in DB systems, if PHP is run
25		* on 64 bit systems.
26		*/
27		const MAX_LIMIT = 1073741824;
28
29		/**
30		* Database handler.
31		*
32		* @var \eZ\Publish\Core\Persistence\Database\DatabaseHandler
33		*/
34		protected $handler;
35
36		/** @var \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter */
37		private $criteriaConverter;
38
39		/** @var \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\SortClauseConverter */
40		private $sortClauseConverter;
41
42		/**
43		* Language handler.
44		*
45		* @var \eZ\Publish\SPI\Persistence\Content\Language\Handler
46		*/
47		protected $languageHandler;
48
49		/**
50		* Construct from database handler.
51		*
52		* @param \eZ\Publish\Core\Persistence\Database\DatabaseHandler $handler
53		* @param \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter $criteriaConverter
54		* @param \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\SortClauseConverter $sortClauseConverter
55		* @param \eZ\Publish\SPI\Persistence\Content\Language\Handler $languageHandler
56		*/
57	View Code Duplication	public function __construct(
58		DatabaseHandler $handler,
59		CriteriaConverter $criteriaConverter,
60		SortClauseConverter $sortClauseConverter,
61		LanguageHandler $languageHandler
62		) {
63		$this->handler = $handler;
64		$this->criteriaConverter = $criteriaConverter;
65		$this->sortClauseConverter = $sortClauseConverter;
66		$this->languageHandler = $languageHandler;
67		}
68
69		/**
70		* Returns total count and data for all Locations satisfying the parameters.
71		*
72		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
73		* @param int $offset
74		* @param int $limit
75		* @param \eZ\Publish\API\Repository\Values\Content\Query\SortClause[]\|null $sortClauses
76		* @param array $languageFilter
77		* @param bool $doCount
78		*
79		* @return mixed[][]
80		*/
81		public function find(
82		Criterion $criterion,
83		$offset,
84		$limit,
85		array $sortClauses = null,
86		array $languageFilter = [],
87		$doCount = true
88		) {
89		$count = $doCount ? $this->getTotalCount($criterion, $languageFilter) : null;
90
91		if (!$doCount && $limit === 0) {
92		throw new \RuntimeException('Invalid query. Cannot disable count and request 0 items at the same time.');
93		}
94
95	View Code Duplication	if ($limit === 0 \|\| ($count !== null && $count <= $offset)) {
		0 ignored issues – show Duplication introduced 2015-11-21 14:37 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...
96		return ['count' => $count, 'rows' => []];
		0 ignored issues – show Bug Best Practice introduced 2019-06-23 15:40 UTC by Report Bug Copy Issue Report The return type of `return array('count' => ...nt, 'rows' => array());` (`array<string,integer\|null\|array>`) is incompatible with the return type declared by the abstract method `eZ\Publish\Core\Search\L...\Location\Gateway::find` of type `array[]`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
97		}
98
99		$selectQuery = $this->handler->createSelectQuery();
100		$selectQuery->select(
101		'ezcontentobject_tree.*',
102		$this->handler->quoteColumn('language_mask', 'ezcontentobject'),
103		$this->handler->quoteColumn('initial_language_id', 'ezcontentobject')
104		);
105
106		if ($sortClauses !== null) {
107		$this->sortClauseConverter->applySelect($selectQuery, $sortClauses);
108		}
109
110		$selectQuery
111		->from($this->handler->quoteTable('ezcontentobject_tree'))
112		->innerJoin(
113		'ezcontentobject',
114		'ezcontentobject_tree.contentobject_id',
115		'ezcontentobject.id'
116		)
117		->innerJoin(
118		'ezcontentobject_version',
119		'ezcontentobject.id',
120		'ezcontentobject_version.contentobject_id'
121		);
122
123		if ($sortClauses !== null) {
124		$this->sortClauseConverter->applyJoin($selectQuery, $sortClauses, $languageFilter);
125		}
126
127		$selectQuery->where(
128		$this->criteriaConverter->convertCriteria($selectQuery, $criterion, $languageFilter),
129		$selectQuery->expr->eq(
130		'ezcontentobject.status',
131		//ContentInfo::STATUS_PUBLISHED
132		$selectQuery->bindValue(1, null, PDO::PARAM_INT)
133		),
134		$selectQuery->expr->eq(
135		'ezcontentobject_version.status',
136		//VersionInfo::STATUS_PUBLISHED
137		$selectQuery->bindValue(1, null, PDO::PARAM_INT)
138		),
139		$selectQuery->expr->neq(
140		$this->handler->quoteColumn('depth', 'ezcontentobject_tree'),
141		$selectQuery->bindValue(0, null, PDO::PARAM_INT)
142		)
143		);
144
145		// If not main-languages query
146	View Code Duplication	if (!empty($languageFilter['languages'])) {
		0 ignored issues – show Duplication introduced 2020-05-08 18:39 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...
147		$selectQuery->where(
148		$selectQuery->expr->gt(
149		$selectQuery->expr->bitAnd(
150		$this->handler->quoteColumn('language_mask', 'ezcontentobject'),
151		$selectQuery->bindValue(
152		$this->getLanguageMask($languageFilter),
153		null,
154		PDO::PARAM_INT
155		)
156		),
157		$selectQuery->bindValue(0, null, PDO::PARAM_INT)
158		)
159		);
160		}
161
162		if ($sortClauses !== null) {
163		$this->sortClauseConverter->applyOrderBy($selectQuery);
164		}
165
166		$selectQuery->limit($limit, $offset);
167
168		$statement = $selectQuery->prepare();
169		$statement->execute();
170
171		return [
		0 ignored issues – show Bug Best Practice introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The return type of `return array('count' => ...ll(\PDO::FETCH_ASSOC));` (`array<string,null\|integer\|array>`) is incompatible with the return type declared by the abstract method `eZ\Publish\Core\Search\L...\Location\Gateway::find` of type `array[]`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
172		'count' => $count,
173		'rows' => $statement->fetchAll(PDO::FETCH_ASSOC),
174		];
175		}
176
177		/**
178		* Returns total results count for $criterion and $sortClauses.
179		*
180		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
181		* @param array $languageFilter
182		*
183		* @return array
184		*/
185		protected function getTotalCount(Criterion $criterion, array $languageFilter)
186		{
187		$query = $this->handler->createSelectQuery();
188		$query
189		->select($query->alias($query->expr->count('*'), 'count'))
190		->from($this->handler->quoteTable('ezcontentobject_tree'))
191		->innerJoin(
192		'ezcontentobject',
193		'ezcontentobject_tree.contentobject_id',
194		'ezcontentobject.id'
195		)
196		->innerJoin(
197		'ezcontentobject_version',
198		'ezcontentobject.id',
199		'ezcontentobject_version.contentobject_id'
200		);
201
202		$query->where(
203		$this->criteriaConverter->convertCriteria($query, $criterion, $languageFilter),
204		$query->expr->eq(
205		'ezcontentobject.status',
206		//ContentInfo::STATUS_PUBLISHED
207		$query->bindValue(1, null, PDO::PARAM_INT)
208		),
209		$query->expr->eq(
210		'ezcontentobject_version.status',
211		//VersionInfo::STATUS_PUBLISHED
212		$query->bindValue(1, null, PDO::PARAM_INT)
213		),
214		$query->expr->neq(
215		$this->handler->quoteColumn('depth', 'ezcontentobject_tree'),
216		$query->bindValue(0, null, PDO::PARAM_INT)
217		)
218		);
219
220		// If not main-languages query
221	View Code Duplication	if (!empty($languageFilter['languages'])) {
		0 ignored issues – show Duplication introduced 2020-05-08 18:39 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...
222		$query->where(
223		$query->expr->gt(
224		$query->expr->bitAnd(
225		$this->handler->quoteColumn('language_mask', 'ezcontentobject'),
226		$query->bindValue(
227		$this->getLanguageMask($languageFilter),
228		null,
229		PDO::PARAM_INT
230		)
231		),
232		$query->bindValue(0, null, PDO::PARAM_INT)
233		)
234		);
235		}
236
237		$statement = $query->prepare();
238		$statement->execute();
239
240		return (int)$statement->fetchColumn();
241		}
242
243		/**
244		* Generates a language mask from the given $languageFilter.
245		*
246		* @param array $languageFilter
247		*
248		* @return int
249		*/
250		protected function getLanguageMask(array $languageFilter)
251		{
252		if (!isset($languageFilter['languages'])) {
253		$languageFilter['languages'] = [];
254		}
255
256		if (!isset($languageFilter['useAlwaysAvailable'])) {
257		$languageFilter['useAlwaysAvailable'] = true;
258		}
259
260		$mask = 0;
261		if ($languageFilter['useAlwaysAvailable']) {
262		$mask \|= 1;
263		}
264
265		foreach ($languageFilter['languages'] as $languageCode) {
266		$mask \|= $this->languageHandler->loadByLanguageCode($languageCode)->id;
267		}
268
269		return $mask;
270		}
271		}
272

ezsystems / ezpublish-kernel

Push — ezp-31420-merge-up ( ec14fb...141a64 )

DoctrineDatabase::getLanguageMask() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like