SearchService::findContent() - Code Metrics - Inspection of "EZP-28203: image alias removal command not removin..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 6.7 ( 730fb7...a124d5 )

by André

created 2017-11-16 12:43 UTC

SearchService::findContent() B

↳ Parent: SearchService

Complexity

Conditions	6
Paths	4

Size

Total Lines	28
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	19
nc	4
nop	3
dl	0
loc	28
rs	8.439
c	0
b	0
f	0

<?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\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();

        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;
    }
}


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

ezsystems / ezpublish-kernel

Push — 6.7 ( 730fb7...a124d5 )

SearchService::findContent() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like