Skip to content

Commit

Permalink
Make FetchHelper class inheritable more easily
Browse files Browse the repository at this point in the history
  • Loading branch information
Damien VERNER committed Aug 12, 2024
1 parent b72fc02 commit 80e000a
Show file tree
Hide file tree
Showing 2 changed files with 117 additions and 104 deletions.
220 changes: 116 additions & 104 deletions Services/FetchHelper.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use Exception;
use Ibexa\Contracts\Core\Repository\ContentService;
use Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException;
use Ibexa\Contracts\Core\Repository\Exceptions\InvalidCriterionArgumentException;
use Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException;
use Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException;
use Ibexa\Contracts\Core\Repository\LocationService;
Expand All @@ -23,44 +24,37 @@
class FetchHelper
{
public const LIMIT = 25;
/** @var ConfigResolverInterface */
private $configResolver;
/** @var SearchService */
private $searchService;
/** @var LocationService */
private $locationService;
/** @var FieldHelper */
private $fieldhelper;
/** @var TranslationHelper */
private $translationhelper;
/** @var ContentService */
private $contentservice;
/** @var DataFormatterHelper */
private $dataFormatterHelper;

public function __construct(
protected ConfigResolverInterface $configResolver;
protected SearchService $searchService;
protected LocationService $locationService;
protected FieldHelper $fieldhelper;
protected TranslationHelper $translationhelper;
protected ContentService $contentservice;

/**
* @required
*/
public function setDependencies(
ConfigResolverInterface $configResolver,
SearchService $searchService,
LocationService $locationService,
FieldHelper $fieldhelper,
TranslationHelper $translationhelper,
ContentService $contentservice,
DataFormatterHelper $dataFormatterHelper
ContentService $contentservice
) {
$this->configResolver = $configResolver;
$this->searchService = $searchService;
$this->locationService = $locationService;
$this->fieldhelper = $fieldhelper;
$this->translationhelper = $translationhelper;
$this->contentservice = $contentservice;
$this->dataFormatterHelper = $dataFormatterHelper;
}

/**
* Similar as fetchChildren but returns Content for each child instead of Location
*
* @param Location|int $parentLocation
* @param string|null $contentClass
* @param string|string[]|null $contentClass
* @return Content[]
* @throws InvalidArgumentException
*/
Expand All @@ -79,13 +73,18 @@ public function fetchChildrenContent($parentLocation, $contentClass = null): arr

/**
* @param Location|int $parentLocation
* @param string|null $contentClass
* @param string|string[]|null $contentClass
* @param int $limit
* @param int $offset
* @return Location[]
* @throws InvalidArgumentException
*/
public function fetchChildren($parentLocation, $contentClass = null, $limit = self::LIMIT): array
{
public function fetchChildren(
$parentLocation,
$contentClass = null,
int $limit = self::LIMIT,
int $offset = 0
): array {
$params = [];

if (!is_null($contentClass)) {
Expand All @@ -95,65 +94,27 @@ public function fetchChildren($parentLocation, $contentClass = null, $limit = se
$parentLocationId = $parentLocation instanceof Location ? $parentLocation->id : $parentLocation;
$params[] = new Criterion\ParentLocationId($parentLocationId);

return $this->fetchLocationList($params, null, $limit);
}

/**
* @param array $params
* @param int $limit
* @param int $offset
* @param SortClause[]|null $sortClauses If null, results will be sorted by priority
* @return Location[]
* @throws InvalidArgumentException
*/
private function fetchLocationList(
array $params,
$sortClauses = null,
$limit = self::LIMIT,
$offset = 0
): array {
$languages = $this->configResolver->getParameter('languages');
$query = new LocationQuery();

$query->query = new Criterion\LogicalAnd(
array_merge(
[
new Criterion\Visibility(Criterion\Visibility::VISIBLE),
new Criterion\LanguageCode($languages),
],
$params
)
);
$query->performCount = true;
$query->limit = $limit;
$query->offset = $offset;
$query->sortClauses = is_null($sortClauses) ?
[ new SortClause\Location\Priority(Query::SORT_ASC) ] : $sortClauses;
$results = $this->searchService->findLocations($query);
$items = [];

foreach ($results->searchHits as $item) {
$items[] = $item->valueObject;
}

return $items;
return $this->fetchLocationList($params, null, $limit, $offset);
}

/**
* @param Location $parentLocation
* @param null $contentClass
* @param string|string[]|null $contentClass
* @param int $limit
* @param int $offset
* @param array $params
* @param array $sortClauses
* @return array
* @throws InvalidArgumentException
* @throws InvalidCriterionArgumentException
*/
public function fetchSubTree(
Location $parentLocation,
$contentClass = null,
$limit = self::LIMIT,
$offset = 0,
array $params = []
int $limit = self::LIMIT,
int $offset = 0,
array $params = [],
array $sortClauses = []
): array {
if (!is_null($contentClass)) {
$params[] = new Criterion\ContentTypeIdentifier($contentClass);
Expand Down Expand Up @@ -186,9 +147,15 @@ public function fetchSubTree(
}

$query->performCount = false;
$query->sortClauses = [
new SortClause\DateModified(Query::SORT_DESC),
];

if (empty($sortClauses)) {
$query->sortClauses = [
new SortClause\DateModified(Query::SORT_DESC),
];
} else {
$query->sortClauses = $sortClauses;
}

$results = $this->searchService->findLocations($query);

$items = [];
Expand Down Expand Up @@ -251,30 +218,20 @@ public function fetchAncestor($location, $contentType, bool $highest = true): ?L
return ($itemHit instanceof Location) ? $itemHit : null;
}

/**
* @param array $params
* @return Location|null
* @throws InvalidArgumentException
*/
private function fetchLocation(array $params): ?Location
{
$results = $this->fetchLocationList($params, null, 1);

$itemHit = reset($results);
return ($itemHit instanceof Location) ? $itemHit : null;
}

/**
* Fetch all contents which contains specified content into specified RelationList field
*
* @param Content|null $content
* @param string $fieldIdentifier
* @param null $contentClass
* @param string|string[]|null $contentClass
* @return array
* @throws InvalidArgumentException
*/
public function fetchRelatedContents(?Content $content, string $fieldIdentifier, $contentClass = null): array
{
public function fetchRelatedContents(
?Content $content,
string $fieldIdentifier,
$contentClass = null
): array {
$params = [];

$contentId = $content instanceof Content ? $content->id : $content;
Expand All @@ -286,14 +243,69 @@ public function fetchRelatedContents(?Content $content, string $fieldIdentifier,
return $this->fetchContentList($params);
}

/**
* @param array $params
* @param int $limit
* @param int $offset
* @param SortClause[]|null $sortClauses If null, results will be sorted by priority
* @return Location[]
* @throws InvalidArgumentException
*/
protected function fetchLocationList(
array $params,
?array $sortClauses = null,
int $limit = self::LIMIT,
int $offset = 0
): array {
$languages = $this->configResolver->getParameter('languages');
$query = new LocationQuery();

$query->query = new Criterion\LogicalAnd(
array_merge(
[
new Criterion\Visibility(Criterion\Visibility::VISIBLE),
new Criterion\LanguageCode($languages),
],
$params
)
);
$query->performCount = true;
$query->limit = $limit;
$query->offset = $offset;
$query->sortClauses = is_null($sortClauses) ?
[ new SortClause\Location\Priority(Query::SORT_ASC) ] : $sortClauses;
$results = $this->searchService->findLocations($query);
$items = [];

foreach ($results->searchHits as $item) {
$items[] = $item->valueObject;
}

return $items;
}

/**
* @param array $params
* @return Content|null
* @throws InvalidArgumentException
*/
protected function fetchContent(array $params): ?Content
{
$results = $this->fetchContentList($params, 1);

$itemHit = reset($results);

return ($itemHit instanceof Content) ? $itemHit : null;
}

/**
* @param array $params
* @param int $limit
* @param int $offset
* @return array
* @throws InvalidArgumentException
*/
private function fetchContentList(array $params, int $limit = self::LIMIT, int $offset = 0): array
protected function fetchContentList(array $params, int $limit = self::LIMIT, int $offset = 0): array
{
$languages = $this->configResolver->getParameter('languages');
$query = new Query();
Expand All @@ -320,6 +332,19 @@ private function fetchContentList(array $params, int $limit = self::LIMIT, int $
return $items;
}

/**
* @param array $params
* @return Location|null
* @throws InvalidArgumentException
*/
protected function fetchLocation(array $params): ?Location
{
$results = $this->fetchLocationList($params, null, 1);

$itemHit = reset($results);
return ($itemHit instanceof Location) ? $itemHit : null;
}

/**
* Search a content in specified Location or the first of it's ancestors which have fieldIdentifier filled
*
Expand All @@ -334,7 +359,8 @@ public function recursiveAncestorGetField(Location $location, string $fieldIdent
$content = $location->getContent();

// Check if $location has a relation in field
if ($content->getContentType()->getFieldDefinition($fieldIdentifier) == null ||
if (
$content->getContentType()->getFieldDefinition($fieldIdentifier) == null ||
$this->fieldhelper->isFieldEmpty($content, $fieldIdentifier)
) {
// No relation to a header object then check parent location
Expand Down Expand Up @@ -385,18 +411,4 @@ public function getName(): string
{
return 'fetch_extension';
}

/**
* @param array $params
* @return Content|null
* @throws InvalidArgumentException
*/
private function fetchContent(array $params): ?Content
{
$results = $this->fetchContentList($params, 1);

$itemHit = reset($results);

return ($itemHit instanceof Content) ? $itemHit : null;
}
}
1 change: 1 addition & 0 deletions composer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"MIT"
],
"require": {
"php": "^7.4 || ^8.0",
"ibexa/oss": "^4.0.2",
"ext-json": "*",
"ext-openssl": "*"
Expand Down

0 comments on commit 80e000a

Please sign in to comment.