SearchService - Code Metrics - Inspection of "Merge branch '6.7' into 6.12" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 6.12 ( 945ca3...d0ab56 )

by André

created 2017-11-16 13:27 UTC

SearchService C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	363
Duplicated Lines	7.44 %

Coupling/Cohesion

Components	1
Dependencies	16

Importance

Changes

Metric	Value
dl	27
loc	363
rs	6.9799
c	0
b	0
f	0
wmc	43
lcom	1
cbo	16

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	1
B	findContent()	0	28	6
A	findContentInfo()	0	11	2
B	internalFindContentInfo()	3	31	6
A	validateContentCriteria()	0	14	4
A	validateContentSortClauses()	0	8	3
B	findSingle()	0	18	5
A	suggest()	0	3	1
C	findLocations()	3	46	9
A	addPermissionsCriterion()	21	21	4
A	supports()	0	8	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like SearchService often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use SearchService, and based on these observations, apply Extract Interface, too.

<?php

/**
 * File containing the eZ\Publish\Core\Repository\SearchService 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\Repository;

use eZ\Publish\API\Repository\SearchService as SearchServiceInterface;
use eZ\Publish\API\Repository\PermissionCriterionResolver;
use eZ\Publish\API\Repository\Values\Content\Query\Criterion;
use eZ\Publish\API\Repository\Values\Content\Query\Criterion\LogicalAnd;
use eZ\Publish\API\Repository\Values\Content\Query\Criterion\LogicalOperator;
use eZ\Publish\API\Repository\Values\Content\Query\Criterion\Location as LocationCriterion;
use eZ\Publish\API\Repository\Values\Content\Query\SortClause\Location as LocationSortClause;
use eZ\Publish\API\Repository\Values\Content\Query;
use eZ\Publish\API\Repository\Values\Content\LocationQuery;
use eZ\Publish\API\Repository\Repository as RepositoryInterface;
use eZ\Publish\API\Repository\Values\Content\Search\SearchResult;
use eZ\Publish\API\Repository\Exceptions\NotFoundException as APINotFoundException;
use eZ\Publish\API\Repository\Exceptions\UnauthorizedException as APIUnauthorizedException;
use eZ\Publish\Core\Base\Exceptions\NotFoundException;
use eZ\Publish\Core\Base\Exceptions\InvalidArgumentException;
use eZ\Publish\Core\Base\Exceptions\InvalidArgumentType;
use eZ\Publish\SPI\Search\Capable;
use eZ\Publish\Core\Search\Common\BackgroundIndexer;
use eZ\Publish\SPI\Search\Handler;

/**
 * Search service.
 */
class SearchService implements SearchServiceInterface
{
    /**
     * @var \eZ\Publish\Core\Repository\Repository
     */
    protected $repository;

    /**
     * @var \eZ\Publish\SPI\Search\Handler
     */
    protected $searchHandler;

    /**
     * @var array
     */
    protected $settings;

    /**
     * @var \eZ\Publish\Core\Repository\Helper\DomainMapper
     */
    protected $domainMapper;

    /**
     * @var \eZ\Publish\API\Repository\PermissionCriterionResolver
     */
    protected $permissionCriterionResolver;

    /**
     * @var \eZ\Publish\Core\Search\Common\BackgroundIndexer
     */
    protected $backgroundIndexer;

    /**
     * Setups service with reference to repository object that created it & corresponding handler.
     *
     * @param \eZ\Publish\API\Repository\Repository $repository
     * @param \eZ\Publish\SPI\Search\Handler $searchHandler
     * @param \eZ\Publish\Core\Repository\Helper\DomainMapper $domainMapper
     * @param \eZ\Publish\API\Repository\PermissionCriterionResolver $permissionCriterionResolver
     * @param \eZ\Publish\Core\Search\Common\BackgroundIndexer $backgroundIndexer
     * @param array $settings
     */
    public function __construct(
        RepositoryInterface $repository,
        Handler $searchHandler,
        Helper\DomainMapper $domainMapper,
        PermissionCriterionResolver $permissionCriterionResolver,
        BackgroundIndexer $backgroundIndexer,
        array $settings = array()
    ) {
        $this->repository = $repository;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        $this->searchHandler = $searchHandler;
        $this->domainMapper = $domainMapper;
        // Union makes sure default settings are ignored if provided in argument
        $this->settings = $settings + array(
            //'defaultSetting' => array(),
        );
        $this->permissionCriterionResolver = $permissionCriterionResolver;
        $this->backgroundIndexer = $backgroundIndexer;
    }

    /**
     * Finds content objects for the given query.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if query is not valid
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query $query
     * @param array $languageFilter Configuration for specifying prioritized languages query will be performed on.
     *        Currently supports: <code>array("languages" => array(<language1>,..), "useAlwaysAvailable" => bool)</code>
     *                            useAlwaysAvailable defaults to true to avoid exceptions on missing translations.
     * @param bool $filterOnUserPermissions if true only the objects which the user is allowed to read are returned.
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Search\SearchResult
     */
    public function findContent(Query $query, array $languageFilter = array(), $filterOnUserPermissions = true)
    {
        $contentService = $this->repository->getContentService();
        $result = $this->internalFindContentInfo($query, $languageFilter, $filterOnUserPermissions);
        foreach ($result->searchHits as $key => $hit) {
            try {
                // As we get ContentInfo from SPI, we need to load full content (avoids getting stale content data)
                $hit->valueObject = $contentService->internalLoadContent(

                    $hit->valueObject->id,
                    (!empty($languageFilter['languages']) ? $languageFilter['languages'] : null),
                    null,
                    false,
                    (isset($languageFilter['useAlwaysAvailable']) ? $languageFilter['useAlwaysAvailable'] : true)
                );
            } catch (APINotFoundException $e) {
                // Most likely stale data, so we register content for background re-indexing.
                $this->backgroundIndexer->registerContent($hit->valueObject);
                unset($result->searchHits[$key]);
                --$result->totalCount;
            } catch (APIUnauthorizedException $e) {
                // Most likely stale cached permission criterion, as ttl is only a few seconds we don't react to this
                unset($result->searchHits[$key]);
                --$result->totalCount;
            }
        }

        return $result;
    }

    /**
     * Finds contentInfo objects for the given query.
     *
     * @see SearchServiceInterface::findContentInfo()
     *
     * @since 5.4.5
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if query is not valid
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query $query
     * @param array $languageFilter - a map of filters for the returned fields.
     *        Currently supports: <code>array("languages" => array(<language1>,..), "useAlwaysAvailable" => bool)</code>
     *                            useAlwaysAvailable defaults to true to avoid exceptions on missing translations.
     * @param bool $filterOnUserPermissions if true (default) only the objects which is the user allowed to read are returned.
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Search\SearchResult
     */
    public function findContentInfo(Query $query, array $languageFilter = array(), $filterOnUserPermissions = true)
    {
        $result = $this->internalFindContentInfo($query, $languageFilter, $filterOnUserPermissions);
        foreach ($result->searchHits as $hit) {
            $hit->valueObject = $this->domainMapper->buildContentInfoDomainObject(
                $hit->valueObject
            );
        }

        return $result;
    }

    /**
     * Finds SPI content info objects for the given query.
     *
     * Internal for use by {@link findContent} and {@link findContentInfo}.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if query is not valid
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query $query
     * @param array $languageFilter - a map of filters for the returned fields.
     *        Currently supports: <code>array("languages" => array(<language1>,..), "useAlwaysAvailable" => bool)</code>
     *                            useAlwaysAvailable defaults to true to avoid exceptions on missing translations.
     * @param bool $filterOnUserPermissions if true only the objects which is the user allowed to read are returned.
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Search\SearchResult With "raw" SPI contentInfo objects in result
     */
    protected function internalFindContentInfo(Query $query, array $languageFilter = array(), $filterOnUserPermissions = true)
    {
        if (!is_int($query->offset)) {
            throw new InvalidArgumentType(
                '$query->offset',
                'integer',
                $query->offset
            );
        }

        if (!is_int($query->limit)) {
            throw new InvalidArgumentType(
                '$query->limit',
                'integer',
                $query->limit
            );
        }

        $query = clone $query;
        $query->filter = $query->filter ?: new Criterion\MatchAll();

        $this->validateContentCriteria(array($query->query), '$query');
        $this->validateContentCriteria(array($query->filter), '$query');
        $this->validateContentSortClauses($query);

        if ($filterOnUserPermissions && !$this->addPermissionsCriterion($query->filter)) {

            return new SearchResult(array('time' => 0, 'totalCount' => 0));
        }

        return $this->searchHandler->findContent($query, $languageFilter);
    }

    /**
     * Checks that $criteria does not contain Location criterions.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion[] $criteria
     * @param string $argumentName
     */
    protected function validateContentCriteria(array $criteria, $argumentName)
    {
        foreach ($criteria as $criterion) {
            if ($criterion instanceof LocationCriterion) {
                throw new InvalidArgumentException(
                    $argumentName,
                    'Location criterions cannot be used in Content search'
                );
            }
            if ($criterion instanceof LogicalOperator) {
                $this->validateContentCriteria($criterion->criteria, $argumentName);
            }
        }
    }

    /**
     * Checks that $query does not contain Location sort clauses.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query $query
     */
    protected function validateContentSortClauses(Query $query)
    {
        foreach ($query->sortClauses as $sortClause) {
            if ($sortClause instanceof LocationSortClause) {
                throw new InvalidArgumentException('$query', 'Location sort clauses cannot be used in Content search');
            }
        }
    }

    /**
     * Performs a query for a single content object.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if the object was not found by the query or due to permissions
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if criterion is not valid
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if there is more than one result matching the criterions
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $filter
     * @param array $languageFilter Configuration for specifying prioritized languages query will be performed on.
     *        Currently supports: <code>array("languages" => array(<language1>,..), "useAlwaysAvailable" => bool)</code>
     *                            useAlwaysAvailable defaults to true to avoid exceptions on missing translations.
     * @param bool $filterOnUserPermissions if true only the objects which is the user allowed to read are returned.
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Content
     */
    public function findSingle(Criterion $filter, array $languageFilter = array(), $filterOnUserPermissions = true)
    {
        $this->validateContentCriteria(array($filter), '$filter');

        if ($filterOnUserPermissions && !$this->addPermissionsCriterion($filter)) {
            throw new NotFoundException('Content', '*');
        }

        $contentInfo = $this->searchHandler->findSingle($filter, $languageFilter);

        return $this->repository->getContentService()->internalLoadContent(

            $contentInfo->id,
            (!empty($languageFilter['languages']) ? $languageFilter['languages'] : null),
            null,
            false,
            (isset($languageFilter['useAlwaysAvailable']) ? $languageFilter['useAlwaysAvailable'] : true)
        );
    }

    /**
     * Suggests a list of values for the given prefix.
     *
     * @param string $prefix
     * @param string[] $fieldPaths
     * @param int $limit
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $filter
     */
    public function suggest($prefix, $fieldPaths = array(), $limit = 10, Criterion $filter = null)
    {
    }

    /**
     * Finds Locations for the given query.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if query is not valid
     *
     * @param \eZ\Publish\API\Repository\Values\Content\LocationQuery $query
     * @param array $languageFilter Configuration for specifying prioritized languages query will be performed on.
     *        Currently supports: <code>array("languages" => array(<language1>,..), "useAlwaysAvailable" => bool)</code>
     *                            useAlwaysAvailable defaults to true to avoid exceptions on missing translations
     * @param bool $filterOnUserPermissions if true only the objects which is the user allowed to read are returned.
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Search\SearchResult
     */
    public function findLocations(LocationQuery $query, array $languageFilter = array(), $filterOnUserPermissions = true)
    {
        if (!is_int($query->offset)) {
            throw new InvalidArgumentType(
                '$query->offset',
                'integer',
                $query->offset
            );
        }

        if (!is_int($query->limit)) {
            throw new InvalidArgumentType(
                '$query->limit',
                'integer',
                $query->limit
            );
        }

        $query = clone $query;
        $query->filter = $query->filter ?: new Criterion\MatchAll();

        if ($filterOnUserPermissions && !$this->addPermissionsCriterion($query->filter)) {

            return new SearchResult(array('time' => 0, 'totalCount' => 0));
        }

        $result = $this->searchHandler->findLocations($query, $languageFilter);

        foreach ($result->searchHits as $key => $hit) {
            try {
                $hit->valueObject = $this->domainMapper->buildLocationDomainObject(
                    $hit->valueObject
                );
            } catch (APINotFoundException $e) {
                // Most likely stale data, so we register content for background re-indexing.
                $this->backgroundIndexer->registerLocation($hit->valueObject);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                unset($result->searchHits[$key]);
                --$result->totalCount;
            } catch (APIUnauthorizedException $e) {
                // Most likely stale cached permission criterion, as ttl is only a few seconds we don't react to this
                unset($result->searchHits[$key]);
                --$result->totalCount;
            }
        }

        return $result;
    }

    /**
     * Adds content, read Permission criteria if needed and return false if no access at all.
     *
     * @uses \eZ\Publish\API\Repository\PermissionCriterionResolver::getPermissionsCriterion()
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
     *
     * @return bool|\eZ\Publish\API\Repository\Values\Content\Query\Criterion
     */
    protected function addPermissionsCriterion(Criterion &$criterion)
    {
        $permissionCriterion = $this->permissionCriterionResolver->getPermissionsCriterion('content', 'read');
        if ($permissionCriterion === true || $permissionCriterion === false) {
            return $permissionCriterion;
        }

        // Merge with original $criterion
        if ($criterion instanceof LogicalAnd) {
            $criterion->criteria[] = $permissionCriterion;
        } else {
            $criterion = new LogicalAnd(
                array(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    $criterion,
                    $permissionCriterion,
                )
            );
        }

        return true;
    }

    public function supports($capabilityFlag)
    {
        if ($this->searchHandler instanceof Capable) {
            return $this->searchHandler->supports($capabilityFlag);
        }

        return false;
    }
}


1		<?php
2
3		/**
4		* File containing the eZ\Publish\Core\Repository\SearchService 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\Repository;
10
11		use eZ\Publish\API\Repository\SearchService as SearchServiceInterface;
12		use eZ\Publish\API\Repository\PermissionCriterionResolver;
13		use eZ\Publish\API\Repository\Values\Content\Query\Criterion;
14		use eZ\Publish\API\Repository\Values\Content\Query\Criterion\LogicalAnd;
15		use eZ\Publish\API\Repository\Values\Content\Query\Criterion\LogicalOperator;
16		use eZ\Publish\API\Repository\Values\Content\Query\Criterion\Location as LocationCriterion;
17		use eZ\Publish\API\Repository\Values\Content\Query\SortClause\Location as LocationSortClause;
18		use eZ\Publish\API\Repository\Values\Content\Query;
19		use eZ\Publish\API\Repository\Values\Content\LocationQuery;
20		use eZ\Publish\API\Repository\Repository as RepositoryInterface;
21		use eZ\Publish\API\Repository\Values\Content\Search\SearchResult;
22		use eZ\Publish\API\Repository\Exceptions\NotFoundException as APINotFoundException;
23		use eZ\Publish\API\Repository\Exceptions\UnauthorizedException as APIUnauthorizedException;
24		use eZ\Publish\Core\Base\Exceptions\NotFoundException;
25		use eZ\Publish\Core\Base\Exceptions\InvalidArgumentException;
26		use eZ\Publish\Core\Base\Exceptions\InvalidArgumentType;
27		use eZ\Publish\SPI\Search\Capable;
28		use eZ\Publish\Core\Search\Common\BackgroundIndexer;
29		use eZ\Publish\SPI\Search\Handler;
30
31		/**
32		* Search service.
33		*/
34		class SearchService implements SearchServiceInterface
35		{
36		/**
37		* @var \eZ\Publish\Core\Repository\Repository
38		*/
39		protected $repository;
40
41		/**
42		* @var \eZ\Publish\SPI\Search\Handler
43		*/
44		protected $searchHandler;
45
46		/**
47		* @var array
48		*/
49		protected $settings;
50
51		/**
52		* @var \eZ\Publish\Core\Repository\Helper\DomainMapper
53		*/
54		protected $domainMapper;
55
56		/**
57		* @var \eZ\Publish\API\Repository\PermissionCriterionResolver
58		*/
59		protected $permissionCriterionResolver;
60
61		/**
62		* @var \eZ\Publish\Core\Search\Common\BackgroundIndexer
63		*/
64		protected $backgroundIndexer;
65
66		/**
67		* Setups service with reference to repository object that created it & corresponding handler.
68		*
69		* @param \eZ\Publish\API\Repository\Repository $repository
70		* @param \eZ\Publish\SPI\Search\Handler $searchHandler
71		* @param \eZ\Publish\Core\Repository\Helper\DomainMapper $domainMapper
72		* @param \eZ\Publish\API\Repository\PermissionCriterionResolver $permissionCriterionResolver
73		* @param \eZ\Publish\Core\Search\Common\BackgroundIndexer $backgroundIndexer
74		* @param array $settings
75		*/
76		public function __construct(
77		RepositoryInterface $repository,
78		Handler $searchHandler,
79		Helper\DomainMapper $domainMapper,
80		PermissionCriterionResolver $permissionCriterionResolver,
81		BackgroundIndexer $backgroundIndexer,
82		array $settings = array()
83		) {
84		$this->repository = $repository;
		0 ignored issues – show Documentation Bug introduced 2017-04-18 15:05 UTC by Report Bug Copy Issue Report `$repository` is of type `object<eZ\Publish\API\Repository\Repository>`, but the property `$repository` was declared to be of type `object<eZ\Publish\Core\Repository\Repository>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
85		$this->searchHandler = $searchHandler;
86		$this->domainMapper = $domainMapper;
87		// Union makes sure default settings are ignored if provided in argument
88		$this->settings = $settings + array(
89		//'defaultSetting' => array(),
90		);
91		$this->permissionCriterionResolver = $permissionCriterionResolver;
92		$this->backgroundIndexer = $backgroundIndexer;
93		}
94
95		/**
96		* Finds content objects for the given query.
97		*
98		* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if query is not valid
99		*
100		* @param \eZ\Publish\API\Repository\Values\Content\Query $query
101		* @param array $languageFilter Configuration for specifying prioritized languages query will be performed on.
102		* Currently supports: <code>array("languages" => array(<language1>,..), "useAlwaysAvailable" => bool)</code>
103		* useAlwaysAvailable defaults to true to avoid exceptions on missing translations.
104		* @param bool $filterOnUserPermissions if true only the objects which the user is allowed to read are returned.
105		*
106		* @return \eZ\Publish\API\Repository\Values\Content\Search\SearchResult
107		*/
108		public function findContent(Query $query, array $languageFilter = array(), $filterOnUserPermissions = true)
109		{
110		$contentService = $this->repository->getContentService();
111		$result = $this->internalFindContentInfo($query, $languageFilter, $filterOnUserPermissions);
112		foreach ($result->searchHits as $key => $hit) {
113		try {
114		// As we get ContentInfo from SPI, we need to load full content (avoids getting stale content data)
115		$hit->valueObject = $contentService->internalLoadContent(
		0 ignored issues – show Bug introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The method `internalLoadContent()` does not exist on `eZ\Publish\API\Repository\ContentService`. Did you maybe mean `loadContent()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
116		$hit->valueObject->id,
117		(!empty($languageFilter['languages']) ? $languageFilter['languages'] : null),
118		null,
119		false,
120		(isset($languageFilter['useAlwaysAvailable']) ? $languageFilter['useAlwaysAvailable'] : true)
121		);
122		} catch (APINotFoundException $e) {
123		// Most likely stale data, so we register content for background re-indexing.
124		$this->backgroundIndexer->registerContent($hit->valueObject);
125		unset($result->searchHits[$key]);
126		--$result->totalCount;
127		} catch (APIUnauthorizedException $e) {
128		// Most likely stale cached permission criterion, as ttl is only a few seconds we don't react to this
129		unset($result->searchHits[$key]);
130		--$result->totalCount;
131		}
132		}
133
134		return $result;
135		}
136
137		/**
138		* Finds contentInfo objects for the given query.
139		*
140		* @see SearchServiceInterface::findContentInfo()
141		*
142		* @since 5.4.5
143		* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if query is not valid
144		*
145		* @param \eZ\Publish\API\Repository\Values\Content\Query $query
146		* @param array $languageFilter - a map of filters for the returned fields.
147		* Currently supports: <code>array("languages" => array(<language1>,..), "useAlwaysAvailable" => bool)</code>
148		* useAlwaysAvailable defaults to true to avoid exceptions on missing translations.
149		* @param bool $filterOnUserPermissions if true (default) only the objects which is the user allowed to read are returned.
150		*
151		* @return \eZ\Publish\API\Repository\Values\Content\Search\SearchResult
152		*/
153		public function findContentInfo(Query $query, array $languageFilter = array(), $filterOnUserPermissions = true)
154		{
155		$result = $this->internalFindContentInfo($query, $languageFilter, $filterOnUserPermissions);
156		foreach ($result->searchHits as $hit) {
157		$hit->valueObject = $this->domainMapper->buildContentInfoDomainObject(
158		$hit->valueObject
159		);
160		}
161
162		return $result;
163		}
164
165		/**
166		* Finds SPI content info objects for the given query.
167		*
168		* Internal for use by {@link findContent} and {@link findContentInfo}.
169		*
170		* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if query is not valid
171		*
172		* @param \eZ\Publish\API\Repository\Values\Content\Query $query
173		* @param array $languageFilter - a map of filters for the returned fields.
174		* Currently supports: <code>array("languages" => array(<language1>,..), "useAlwaysAvailable" => bool)</code>
175		* useAlwaysAvailable defaults to true to avoid exceptions on missing translations.
176		* @param bool $filterOnUserPermissions if true only the objects which is the user allowed to read are returned.
177		*
178		* @return \eZ\Publish\API\Repository\Values\Content\Search\SearchResult With "raw" SPI contentInfo objects in result
179		*/
180		protected function internalFindContentInfo(Query $query, array $languageFilter = array(), $filterOnUserPermissions = true)
181		{
182		if (!is_int($query->offset)) {
183		throw new InvalidArgumentType(
184		'$query->offset',
185		'integer',
186		$query->offset
187		);
188		}
189
190		if (!is_int($query->limit)) {
191		throw new InvalidArgumentType(
192		'$query->limit',
193		'integer',
194		$query->limit
195		);
196		}
197
198		$query = clone $query;
199		$query->filter = $query->filter ?: new Criterion\MatchAll();
200
201		$this->validateContentCriteria(array($query->query), '$query');
202		$this->validateContentCriteria(array($query->filter), '$query');
203		$this->validateContentSortClauses($query);
204
205	View Code Duplication	if ($filterOnUserPermissions && !$this->addPermissionsCriterion($query->filter)) {
		0 ignored issues – show Duplication introduced 2017-10-27 08:27 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...
206		return new SearchResult(array('time' => 0, 'totalCount' => 0));
207		}
208
209		return $this->searchHandler->findContent($query, $languageFilter);
210		}
211
212		/**
213		* Checks that $criteria does not contain Location criterions.
214		*
215		* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException
216		*
217		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion[] $criteria
218		* @param string $argumentName
219		*/
220		protected function validateContentCriteria(array $criteria, $argumentName)
221		{
222		foreach ($criteria as $criterion) {
223		if ($criterion instanceof LocationCriterion) {
224		throw new InvalidArgumentException(
225		$argumentName,
226		'Location criterions cannot be used in Content search'
227		);
228		}
229		if ($criterion instanceof LogicalOperator) {
230		$this->validateContentCriteria($criterion->criteria, $argumentName);
231		}
232		}
233		}
234
235		/**
236		* Checks that $query does not contain Location sort clauses.
237		*
238		* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException
239		*
240		* @param \eZ\Publish\API\Repository\Values\Content\Query $query
241		*/
242		protected function validateContentSortClauses(Query $query)
243		{
244		foreach ($query->sortClauses as $sortClause) {
245		if ($sortClause instanceof LocationSortClause) {
246		throw new InvalidArgumentException('$query', 'Location sort clauses cannot be used in Content search');
247		}
248		}
249		}
250
251		/**
252		* Performs a query for a single content object.
253		*
254		* @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if the object was not found by the query or due to permissions
255		* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if criterion is not valid
256		* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if there is more than one result matching the criterions
257		*
258		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $filter
259		* @param array $languageFilter Configuration for specifying prioritized languages query will be performed on.
260		* Currently supports: <code>array("languages" => array(<language1>,..), "useAlwaysAvailable" => bool)</code>
261		* useAlwaysAvailable defaults to true to avoid exceptions on missing translations.
262		* @param bool $filterOnUserPermissions if true only the objects which is the user allowed to read are returned.
263		*
264		* @return \eZ\Publish\API\Repository\Values\Content\Content
265		*/
266		public function findSingle(Criterion $filter, array $languageFilter = array(), $filterOnUserPermissions = true)
267		{
268		$this->validateContentCriteria(array($filter), '$filter');
269
270		if ($filterOnUserPermissions && !$this->addPermissionsCriterion($filter)) {
271		throw new NotFoundException('Content', '*');
272		}
273
274		$contentInfo = $this->searchHandler->findSingle($filter, $languageFilter);
275
276		return $this->repository->getContentService()->internalLoadContent(
		0 ignored issues – show Bug introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The method `internalLoadContent()` does not exist on `eZ\Publish\API\Repository\ContentService`. Did you maybe mean `loadContent()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
277		$contentInfo->id,
278		(!empty($languageFilter['languages']) ? $languageFilter['languages'] : null),
279		null,
280		false,
281		(isset($languageFilter['useAlwaysAvailable']) ? $languageFilter['useAlwaysAvailable'] : true)
282		);
283		}
284
285		/**
286		* Suggests a list of values for the given prefix.
287		*
288		* @param string $prefix
289		* @param string[] $fieldPaths
290		* @param int $limit
291		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $filter
292		*/
293		public function suggest($prefix, $fieldPaths = array(), $limit = 10, Criterion $filter = null)
294		{
295		}
296
297		/**
298		* Finds Locations for the given query.
299		*
300		* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if query is not valid
301		*
302		* @param \eZ\Publish\API\Repository\Values\Content\LocationQuery $query
303		* @param array $languageFilter Configuration for specifying prioritized languages query will be performed on.
304		* Currently supports: <code>array("languages" => array(<language1>,..), "useAlwaysAvailable" => bool)</code>
305		* useAlwaysAvailable defaults to true to avoid exceptions on missing translations
306		* @param bool $filterOnUserPermissions if true only the objects which is the user allowed to read are returned.
307		*
308		* @return \eZ\Publish\API\Repository\Values\Content\Search\SearchResult
309		*/
310		public function findLocations(LocationQuery $query, array $languageFilter = array(), $filterOnUserPermissions = true)
311		{
312		if (!is_int($query->offset)) {
313		throw new InvalidArgumentType(
314		'$query->offset',
315		'integer',
316		$query->offset
317		);
318		}
319
320		if (!is_int($query->limit)) {
321		throw new InvalidArgumentType(
322		'$query->limit',
323		'integer',
324		$query->limit
325		);
326		}
327
328		$query = clone $query;
329		$query->filter = $query->filter ?: new Criterion\MatchAll();
330
331	View Code Duplication	if ($filterOnUserPermissions && !$this->addPermissionsCriterion($query->filter)) {
		0 ignored issues – show Duplication introduced 2017-10-27 08:27 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...
332		return new SearchResult(array('time' => 0, 'totalCount' => 0));
333		}
334
335		$result = $this->searchHandler->findLocations($query, $languageFilter);
336
337		foreach ($result->searchHits as $key => $hit) {
338		try {
339		$hit->valueObject = $this->domainMapper->buildLocationDomainObject(
340		$hit->valueObject
341		);
342		} catch (APINotFoundException $e) {
343		// Most likely stale data, so we register content for background re-indexing.
344		$this->backgroundIndexer->registerLocation($hit->valueObject);
		0 ignored issues – show Documentation introduced 2017-11-11 09:31 UTC by Report Bug Copy Issue Report `$hit->valueObject` is of type `object<eZ\Publish\Core\R...alues\Content\Location>`, but the function expects a `object<eZ\Publish\SPI\Pe...tence\Content\Location>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
345		unset($result->searchHits[$key]);
346		--$result->totalCount;
347		} catch (APIUnauthorizedException $e) {
348		// Most likely stale cached permission criterion, as ttl is only a few seconds we don't react to this
349		unset($result->searchHits[$key]);
350		--$result->totalCount;
351		}
352		}
353
354		return $result;
355		}
356
357		/**
358		* Adds content, read Permission criteria if needed and return false if no access at all.
359		*
360		* @uses \eZ\Publish\API\Repository\PermissionCriterionResolver::getPermissionsCriterion()
361		*
362		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
363		*
364		* @return bool\|\eZ\Publish\API\Repository\Values\Content\Query\Criterion
365		*/
366	View Code Duplication	protected function addPermissionsCriterion(Criterion &$criterion)
367		{
368		$permissionCriterion = $this->permissionCriterionResolver->getPermissionsCriterion('content', 'read');
369		if ($permissionCriterion === true \|\| $permissionCriterion === false) {
370		return $permissionCriterion;
371		}
372
373		// Merge with original $criterion
374		if ($criterion instanceof LogicalAnd) {
375		$criterion->criteria[] = $permissionCriterion;
376		} else {
377		$criterion = new LogicalAnd(
378		array(
		0 ignored issues – show Documentation introduced 2017-10-27 08:27 UTC by Report Bug Copy Issue Report `array($criterion, $permissionCriterion)` is of type `array<integer,object<eZ\...t\\Query\\Criterion>"}>`, but the function expects a `array<integer,object<eZ\...ntent\Query\Criterion>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
379		$criterion,
380		$permissionCriterion,
381		)
382		);
383		}
384
385		return true;
386		}
387
388		public function supports($capabilityFlag)
389		{
390		if ($this->searchHandler instanceof Capable) {
391		return $this->searchHandler->supports($capabilityFlag);
392		}
393
394		return false;
395		}
396		}
397

ezsystems / ezpublish-kernel