Field::handle() - Code Metrics - Inspection of "EZP-30936: Moved from array to updateStruct" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp-30936-edit-content-new-req... ( 953d44...df9d75 )

unknown

created 2019-11-26 09:47 UTC

Field::handle() A

↳ Parent: Field

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	3
nop	4
dl	0
loc	46
rs	9.1781
c	0
b	0
f	0

<?php

/**
 * File containing the DoctrineDatabase field criterion handler class.
 *
 * @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\Common\Gateway\CriterionHandler;

use eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter;
use eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler\FieldValue\Converter as FieldValueConverter;
use eZ\Publish\Core\Persistence\Database\DatabaseHandler;
use eZ\Publish\API\Repository\Values\Content\Query\Criterion;
use eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\ConverterRegistry as Registry;
use eZ\Publish\Core\Base\Exceptions\InvalidArgumentException;
use eZ\Publish\Core\Persistence\TransformationProcessor;
use eZ\Publish\Core\Persistence\Database\SelectQuery;
use eZ\Publish\SPI\Persistence\Content\Type\Handler as ContentTypeHandler;
use eZ\Publish\SPI\Persistence\Content\Language\Handler as LanguageHandler;

/**
 * Field criterion handler.
 */
class Field extends FieldBase
{
    /**
     * Field converter registry.
     *
     * @var \eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\ConverterRegistry
     */
    protected $fieldConverterRegistry;

    /**
     * Field value converter.
     *
     * @var \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler\FieldValue\Converter
     */
    protected $fieldValueConverter;

    /**
     * Transformation processor.
     *
     * @var \eZ\Publish\Core\Persistence\TransformationProcessor
     */
    protected $transformationProcessor;

    public function __construct(
        DatabaseHandler $dbHandler,
        ContentTypeHandler $contentTypeHandler,
        LanguageHandler $languageHandler,
        Registry $fieldConverterRegistry,
        FieldValueConverter $fieldValueConverter,
        TransformationProcessor $transformationProcessor
    ) {
        parent::__construct($dbHandler, $contentTypeHandler, $languageHandler);

        $this->fieldConverterRegistry = $fieldConverterRegistry;
        $this->fieldValueConverter = $fieldValueConverter;
        $this->transformationProcessor = $transformationProcessor;
    }

    /**
     * Check if this criterion handler accepts to handle the given criterion.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
     *
     * @return bool
     */
    public function accept(Criterion $criterion)
    {
        return $criterion instanceof Criterion\Field;
    }

    /**
     * Returns relevant field information for the specified field.
     *
     * The returned information is returned as an array of the attribute
     * identifier and the sort column, which should be used.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException If no searchable fields are found for the given $fieldIdentifier.
     * @throws \RuntimeException if no converter is found
     *
     * @param string $fieldIdentifier
     *
     * @return array
     *
     * @throws \eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Exception\NotFound
     */
    protected function getFieldsInformation($fieldIdentifier)
    {
        $fieldMapArray = [];
        $fieldMap = $this->contentTypeHandler->getSearchableFieldMap();

        foreach ($fieldMap as $contentTypeIdentifier => $fieldIdentifierMap) {
            // First check if field exists in the current ContentType, there is nothing to do if it doesn't
            if (!isset($fieldIdentifierMap[$fieldIdentifier])) {
                continue;
            }

            $fieldTypeIdentifier = $fieldIdentifierMap[$fieldIdentifier]['field_type_identifier'];
            $fieldMapArray[$fieldTypeIdentifier]['ids'][] = $fieldIdentifierMap[$fieldIdentifier]['field_definition_id'];
            if (!isset($fieldMapArray[$fieldTypeIdentifier]['column'])) {

                $fieldMapArray[$fieldTypeIdentifier]['column'] = $this->fieldConverterRegistry->getConverter($fieldTypeIdentifier)->getIndexColumn();
            }
        }

        if (empty($fieldMapArray)) {
            throw new InvalidArgumentException(
                '$criterion->target',
                "No searchable fields found for the given criterion target '{$fieldIdentifier}'."
            );
        }

        return $fieldMapArray;
    }

    /**
     * Generate query expression for a Criterion this handler accepts.
     *
     * accept() must be called before calling this method.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\NotImplementedException If no searchable fields are found for the given criterion target.
     *
     * @param \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter $converter
     * @param \eZ\Publish\Core\Persistence\Database\SelectQuery $query
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
     * @param array $languageSettings
     *
     * @return \eZ\Publish\Core\Persistence\Database\Expression
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException
     * @throws \eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Exception\NotFound
     */
    public function handle(
        CriteriaConverter $converter,
        SelectQuery $query,
        Criterion $criterion,
        array $languageSettings
    ) {
        $fieldsInformation = $this->getFieldsInformation($criterion->target);

        $subSelect = $query->subSelect();
        $subSelect->select(
            $this->dbHandler->quoteColumn('contentobject_id')
        )->from(
            $this->dbHandler->quoteTable('ezcontentobject_attribute')
        );

        $whereExpressions = [];

        foreach ($fieldsInformation as $fieldTypeIdentifier => $fieldsInfo) {
            if ($fieldsInfo['column'] === false) {
                continue;
            }

            $filter = $this->fieldValueConverter->convertCriteria(
                $fieldTypeIdentifier,
                $subSelect,
                $criterion,
                $fieldsInfo['column']
            );

            $whereExpressions[] = $subSelect->expr->lAnd(
                $subSelect->expr->in(
                    $this->dbHandler->quoteColumn('contentclassattribute_id'),
                    $fieldsInfo['ids']
                ),
                $filter
            );
        }

        return $this->getInExpressionWithFieldConditions(
            $query,
            $subSelect,
            $languageSettings,
            $whereExpressions,
            $fieldsInformation
        );
    }
}


1		<?php
2
3		/**
4		* File containing the DoctrineDatabase field criterion handler class.
5		*
6		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7		* @license For full copyright and license information view LICENSE file distributed with this source code.
8		*/
9		namespace eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler;
10
11		use eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter;
12		use eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler\FieldValue\Converter as FieldValueConverter;
13		use eZ\Publish\Core\Persistence\Database\DatabaseHandler;
14		use eZ\Publish\API\Repository\Values\Content\Query\Criterion;
15		use eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\ConverterRegistry as Registry;
16		use eZ\Publish\Core\Base\Exceptions\InvalidArgumentException;
17		use eZ\Publish\Core\Persistence\TransformationProcessor;
18		use eZ\Publish\Core\Persistence\Database\SelectQuery;
19		use eZ\Publish\SPI\Persistence\Content\Type\Handler as ContentTypeHandler;
20		use eZ\Publish\SPI\Persistence\Content\Language\Handler as LanguageHandler;
21
22		/**
23		* Field criterion handler.
24		*/
25		class Field extends FieldBase
26		{
27		/**
28		* Field converter registry.
29		*
30		* @var \eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\ConverterRegistry
31		*/
32		protected $fieldConverterRegistry;
33
34		/**
35		* Field value converter.
36		*
37		* @var \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler\FieldValue\Converter
38		*/
39		protected $fieldValueConverter;
40
41		/**
42		* Transformation processor.
43		*
44		* @var \eZ\Publish\Core\Persistence\TransformationProcessor
45		*/
46		protected $transformationProcessor;
47
48		public function __construct(
49		DatabaseHandler $dbHandler,
50		ContentTypeHandler $contentTypeHandler,
51		LanguageHandler $languageHandler,
52		Registry $fieldConverterRegistry,
53		FieldValueConverter $fieldValueConverter,
54		TransformationProcessor $transformationProcessor
55		) {
56		parent::__construct($dbHandler, $contentTypeHandler, $languageHandler);
57
58		$this->fieldConverterRegistry = $fieldConverterRegistry;
59		$this->fieldValueConverter = $fieldValueConverter;
60		$this->transformationProcessor = $transformationProcessor;
61		}
62
63		/**
64		* Check if this criterion handler accepts to handle the given criterion.
65		*
66		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
67		*
68		* @return bool
69		*/
70		public function accept(Criterion $criterion)
71		{
72		return $criterion instanceof Criterion\Field;
73		}
74
75		/**
76		* Returns relevant field information for the specified field.
77		*
78		* The returned information is returned as an array of the attribute
79		* identifier and the sort column, which should be used.
80		*
81		* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException If no searchable fields are found for the given $fieldIdentifier.
82		* @throws \RuntimeException if no converter is found
83		*
84		* @param string $fieldIdentifier
85		*
86		* @return array
87		*
88		* @throws \eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Exception\NotFound
89		*/
90		protected function getFieldsInformation($fieldIdentifier)
91		{
92		$fieldMapArray = [];
93		$fieldMap = $this->contentTypeHandler->getSearchableFieldMap();
94
95		foreach ($fieldMap as $contentTypeIdentifier => $fieldIdentifierMap) {
96		// First check if field exists in the current ContentType, there is nothing to do if it doesn't
97		if (!isset($fieldIdentifierMap[$fieldIdentifier])) {
98		continue;
99		}
100
101		$fieldTypeIdentifier = $fieldIdentifierMap[$fieldIdentifier]['field_type_identifier'];
102		$fieldMapArray[$fieldTypeIdentifier]['ids'][] = $fieldIdentifierMap[$fieldIdentifier]['field_definition_id'];
103	View Code Duplication	if (!isset($fieldMapArray[$fieldTypeIdentifier]['column'])) {
		0 ignored issues – show Duplication introduced 2019-11-22 09:59 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...
104		$fieldMapArray[$fieldTypeIdentifier]['column'] = $this->fieldConverterRegistry->getConverter($fieldTypeIdentifier)->getIndexColumn();
105		}
106		}
107
108		if (empty($fieldMapArray)) {
109		throw new InvalidArgumentException(
110		'$criterion->target',
111		"No searchable fields found for the given criterion target '{$fieldIdentifier}'."
112		);
113		}
114
115		return $fieldMapArray;
116		}
117
118		/**
119		* Generate query expression for a Criterion this handler accepts.
120		*
121		* accept() must be called before calling this method.
122		*
123		* @throws \eZ\Publish\API\Repository\Exceptions\NotImplementedException If no searchable fields are found for the given criterion target.
124		*
125		* @param \eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter $converter
126		* @param \eZ\Publish\Core\Persistence\Database\SelectQuery $query
127		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
128		* @param array $languageSettings
129		*
130		* @return \eZ\Publish\Core\Persistence\Database\Expression
131		*
132		* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException
133		* @throws \eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Exception\NotFound
134		*/
135		public function handle(
136		CriteriaConverter $converter,
137		SelectQuery $query,
138		Criterion $criterion,
139		array $languageSettings
140		) {
141		$fieldsInformation = $this->getFieldsInformation($criterion->target);
142
143		$subSelect = $query->subSelect();
144		$subSelect->select(
145		$this->dbHandler->quoteColumn('contentobject_id')
146		)->from(
147		$this->dbHandler->quoteTable('ezcontentobject_attribute')
148		);
149
150		$whereExpressions = [];
151
152		foreach ($fieldsInformation as $fieldTypeIdentifier => $fieldsInfo) {
153		if ($fieldsInfo['column'] === false) {
154		continue;
155		}
156
157		$filter = $this->fieldValueConverter->convertCriteria(
158		$fieldTypeIdentifier,
159		$subSelect,
160		$criterion,
161		$fieldsInfo['column']
162		);
163
164		$whereExpressions[] = $subSelect->expr->lAnd(
165		$subSelect->expr->in(
166		$this->dbHandler->quoteColumn('contentclassattribute_id'),
167		$fieldsInfo['ids']
168		),
169		$filter
170		);
171		}
172
173		return $this->getInExpressionWithFieldConditions(
174		$query,
175		$subSelect,
176		$languageSettings,
177		$whereExpressions,
178		$fieldsInformation
179		);
180		}
181		}
182

ezsystems / ezpublish-kernel

Push — ezp-30936-edit-content-new-req... ( 953d44...df9d75 )

Field::handle() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like