Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/DataObject/Controller/Grid/GetController.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
use Pimcore\Bundle\StudioBackendBundle\Exception\Api\InvalidArgumentException;
use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
use Pimcore\Bundle\StudioBackendBundle\Grid\Attribute\Property\GridCollection;
use Pimcore\Bundle\StudioBackendBundle\Grid\Attribute\Request\GridRequestBody;
use Pimcore\Bundle\StudioBackendBundle\Grid\Attribute\Request\DataObjectGridRequestBody;
use Pimcore\Bundle\StudioBackendBundle\Grid\MappedParameter\GridParameter;
use Pimcore\Bundle\StudioBackendBundle\Grid\Service\GridServiceInterface;
use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Parameter\Path\StringParameter;
Expand Down Expand Up @@ -61,7 +61,7 @@ public function __construct(
summary: 'data_object_get_grid_summary',
tags: [Tags::DataObjectsGrid->value]
)]
#[GridRequestBody]
#[DataObjectGridRequestBody]
#[SuccessResponse(
description: 'data_object_get_grid_success_response',
content: new CollectionJson(
Expand Down
60 changes: 60 additions & 0 deletions src/Grid/Attribute/Request/DataObjectGridRequestBody.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<?php
declare(strict_types=1);

/**
* This source file is available under the terms of the
* Pimcore Open Core License (POCL)
* Full copyright and license information is available in
* LICENSE.md which is distributed with this source code.
*
* @copyright Copyright (c) Pimcore GmbH (https://www.pimcore.com)
* @license Pimcore Open Core License (POCL)
*/

namespace Pimcore\Bundle\StudioBackendBundle\Grid\Attribute\Request;

use Attribute;
use OpenApi\Attributes\Items;
use OpenApi\Attributes\JsonContent;
use OpenApi\Attributes\Property;
use OpenApi\Attributes\RequestBody;
use Pimcore\Bundle\StudioBackendBundle\Grid\Schema\Column;
use Pimcore\Bundle\StudioBackendBundle\Grid\Schema\Filter;
use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Property\SingleInteger;

/**
* @internal
*/
#[Attribute(Attribute::TARGET_METHOD)]
final class DataObjectGridRequestBody extends RequestBody
{
public function __construct()
{
parent::__construct(
required: true,
content: new JsonContent(
required: ['folderId'],
properties: [
new SingleInteger(propertyName: 'folderId'),
new Property(
property: 'applyFallbackLanguages',
description: 'When true, empty localized values fall back to configured fallback languages',
type: 'boolean',
default: false
),
new Property(
property: 'columns',
type: 'array',
items: new Items(ref: Column::class)
),
new Property(
property: 'filters',
ref: Filter::class,
type: 'object'
),
],
type: 'object',
),
);
}
}
19 changes: 17 additions & 2 deletions src/Grid/Column/Resolver/DataObject/AdapterResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
namespace Pimcore\Bundle\StudioBackendBundle\Grid\Column\Resolver\DataObject;

use Exception;
use Pimcore\Bundle\StaticResolverBundle\Lib\ToolResolverInterface;
use Pimcore\Bundle\StaticResolverBundle\Models\DataObject\LocalizedFieldResolverInterface;
use Pimcore\Bundle\StaticResolverBundle\Models\DataObject\DataObjectServiceResolverInterface;
use Pimcore\Bundle\StudioBackendBundle\DataObject\Data\Model\FieldContextData;
use Pimcore\Bundle\StudioBackendBundle\DataObject\Data\Model\InheritanceData;
Expand Down Expand Up @@ -50,11 +52,24 @@ final class AdapterResolver implements
public function __construct(
private readonly DataServiceInterface $dataService,
private readonly InheritanceServiceInterface $inheritanceService,
private readonly DataObjectServiceResolverInterface $dataObjectServiceResolver

private readonly DataObjectServiceResolverInterface $dataObjectServiceResolver,
private readonly ToolResolverInterface $toolResolver,
private readonly LocalizedFieldResolverInterface $localizedFieldResolver,
) {
}

/** @see LocalizedValueTrait::doGetFallbackValues() */
protected function doGetFallbackValues(): bool
{
return $this->localizedFieldResolver->doGetFallbackValues();
}

/** @see LocalizedValueTrait::getDefaultLanguage() */
protected function getDefaultLanguage(): ?string
{
return $this->toolResolver->getDefaultLanguage();
}
Comment thread
martineiber marked this conversation as resolved.

/**
* @throws Exception
* @throws InvalidArgumentException
Expand Down
20 changes: 18 additions & 2 deletions src/Grid/Column/Resolver/DataObject/AdvancedColumnResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
use Pimcore\Bundle\StudioBackendBundle\Grid\Column\CoreElementColumnResolverInterface;
use Pimcore\Bundle\StudioBackendBundle\Grid\Column\ExportResolverInterface;
use Pimcore\Bundle\StudioBackendBundle\Grid\Column\Resolver\ResolverTypeGuesserInterface;
use Pimcore\Bundle\StaticResolverBundle\Lib\ToolResolverInterface;
use Pimcore\Bundle\StaticResolverBundle\Models\DataObject\LocalizedFieldResolverInterface;
use Pimcore\Bundle\StudioBackendBundle\Grid\Column\TransformerInterface;
use Pimcore\Bundle\StudioBackendBundle\Grid\Schema\AdvancedColumnConfig\RelationFieldConfig;
use Pimcore\Bundle\StudioBackendBundle\Grid\Schema\AdvancedColumnConfig\SimpleFieldConfig;
Expand Down Expand Up @@ -69,10 +71,24 @@ final class AdvancedColumnResolver implements
public function __construct(
private readonly TransformerLoaderInterface $transformerLoader,
private readonly GridServiceInterface $gridService,
private readonly ResolverTypeGuesserInterface $resolverTypeGuesser
private readonly ResolverTypeGuesserInterface $resolverTypeGuesser,
private readonly ToolResolverInterface $toolResolver,
private readonly LocalizedFieldResolverInterface $localizedFieldResolver,
) {
}

/** @see LocalizedValueTrait::doGetFallbackValues() */
protected function doGetFallbackValues(): bool
{
return $this->localizedFieldResolver->doGetFallbackValues();
}

/** @see LocalizedValueTrait::getDefaultLanguage() */
protected function getDefaultLanguage(): ?string
{
return $this->toolResolver->getDefaultLanguage();
}

public function getType(): string
{
return 'dataobject.advanced';
Expand Down Expand Up @@ -211,7 +227,7 @@ private function resolveField(
locale: $isLocalizable ? $column->getLocale() : null,
type: $resolverType,
group: $column->getGroup(),
config: $column->getConfig()
config: $column->getConfig(),
);

$data = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
namespace Pimcore\Bundle\StudioBackendBundle\Grid\Column\Resolver\DataObject;

use Exception;
use Pimcore\Bundle\StaticResolverBundle\Lib\ToolResolverInterface;
use Pimcore\Bundle\StaticResolverBundle\Models\DataObject\LocalizedFieldResolverInterface;
use Pimcore\Bundle\StaticResolverBundle\Models\DataObject\ClassificationStore\ServiceResolverInterface;
use Pimcore\Bundle\StudioBackendBundle\ClassificationStore\Repository\KeyGroupRelationRepositoryInterface;
use Pimcore\Bundle\StudioBackendBundle\DataObject\Data\Model\FieldContextData;
Expand Down Expand Up @@ -55,10 +57,23 @@ public function __construct(
private readonly KeyGroupRelationRepositoryInterface $keyGroupRelationRepository,
private readonly ServiceResolverInterface $classificationStoreServiceResolver,
private readonly DataServiceInterface $dataService,

private readonly ToolResolverInterface $toolResolver,
private readonly LocalizedFieldResolverInterface $localizedFieldResolver,
) {
}

/** @see LocalizedValueTrait::doGetFallbackValues() */
protected function doGetFallbackValues(): bool
{
return $this->localizedFieldResolver->doGetFallbackValues();
}

/** @see LocalizedValueTrait::getDefaultLanguage() */
protected function getDefaultLanguage(): ?string
{
return $this->toolResolver->getDefaultLanguage();
}

/**
* @throws Exception
* @throws InvalidArgumentException
Expand Down
19 changes: 17 additions & 2 deletions src/Grid/Column/Resolver/DataObject/ObjectBrickResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
namespace Pimcore\Bundle\StudioBackendBundle\Grid\Column\Resolver\DataObject;

use Exception;
use Pimcore\Bundle\StaticResolverBundle\Lib\ToolResolverInterface;
use Pimcore\Bundle\StaticResolverBundle\Models\DataObject\LocalizedFieldResolverInterface;
use Pimcore\Bundle\StaticResolverBundle\Models\DataObject\ClassDefinitionResolverInterface;
use Pimcore\Bundle\StaticResolverBundle\Models\DataObject\DataObjectServiceResolverInterface;
use Pimcore\Bundle\StaticResolverBundle\Models\DataObject\Objectbrick\DefinitionResolverInterface;
Expand Down Expand Up @@ -57,11 +59,24 @@ public function __construct(
private readonly InheritanceServiceInterface $inheritanceService,
private readonly DataObjectServiceResolverInterface $dataObjectServiceResolver,
private readonly ObjectBrickServiceInterface $objectBrickService,
private readonly DefinitionResolverInterface $definitionResolver

private readonly DefinitionResolverInterface $definitionResolver,
private readonly ToolResolverInterface $toolResolver,
private readonly LocalizedFieldResolverInterface $localizedFieldResolver,
) {
}

/** @see LocalizedValueTrait::doGetFallbackValues() */
protected function doGetFallbackValues(): bool
{
return $this->localizedFieldResolver->doGetFallbackValues();
}

/** @see LocalizedValueTrait::getDefaultLanguage() */
protected function getDefaultLanguage(): ?string
{
return $this->toolResolver->getDefaultLanguage();
}

/**
* @throws Exception
* @throws InvalidArgumentException
Expand Down
8 changes: 7 additions & 1 deletion src/Grid/MappedParameter/GridParameter.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
public function __construct(
private int $folderId,
private array $columns,
private ?FilterParameter $filters
private ?FilterParameter $filters,
private bool $applyFallbackLanguages = false,
) {
}

Expand All @@ -41,4 +42,9 @@ public function getFilters(): FilterParameter
{
return $this->filters ?? new FilterParameter();
}

public function getApplyFallbackLanguages(): bool
{
return $this->applyFallbackLanguages;
}
}
21 changes: 15 additions & 6 deletions src/Grid/Service/GridService.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
use Pimcore\Bundle\StudioBackendBundle\Util\Constant\ElementPermissions;
use Pimcore\Bundle\StudioBackendBundle\Util\Constant\ElementTypes;
use Pimcore\Bundle\StudioBackendBundle\Util\Trait\ElementProviderTrait;
use Pimcore\Bundle\StaticResolverBundle\Models\DataObject\LocalizedFieldResolverInterface;
use Pimcore\Model\DataObject\ClassDefinition;
use Pimcore\Model\UserInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
Expand Down Expand Up @@ -77,7 +78,8 @@ public function __construct(
private readonly EventDispatcherInterface $eventDispatcher,
private readonly SecurityServiceInterface $securityService,
private readonly ServiceResolverInterface $serviceResolver,
private readonly ClassDefinitionResolverInterface $classDefinitionResolver
private readonly ClassDefinitionResolverInterface $classDefinitionResolver,
private readonly LocalizedFieldResolverInterface $localizedFieldResolver,
) {
}

Expand Down Expand Up @@ -131,11 +133,18 @@ public function getDataObjectGrid(

$result = $this->gridSearch->searchDataObjects($gridParameter);

return $this->getCollectionFromSearchResult(
$result,
$gridParameter,
ElementTypes::TYPE_OBJECT
);
$fallbackBackup = $this->localizedFieldResolver->getGetFallbackValues();
$this->localizedFieldResolver->setGetFallbackValues($gridParameter->getApplyFallbackLanguages());

try {
return $this->getCollectionFromSearchResult(
$result,
$gridParameter,
ElementTypes::TYPE_OBJECT
);
} finally {
$this->localizedFieldResolver->setGetFallbackValues($fallbackBackup);
}
}

/**
Expand Down
30 changes: 27 additions & 3 deletions src/Grid/Util/Trait/LocalizedValueTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,20 @@ trait LocalizedValueTrait
private function getLocalizedValue(Column $column, ElementInterface $element): mixed
{
$getter = $this->getGetter($column->getKey());
if ($column->getLocale()) {
return $element->$getter($column->getLocale());
if (!$column->getLocale()) {
return $element->$getter();
}

return $element->$getter();
$value = $element->$getter($column->getLocale());

if ($this->isEmptyValue($value) && $this->doGetFallbackValues()) {
$defaultLanguage = $this->getDefaultLanguage();
if ($defaultLanguage !== null && $defaultLanguage !== $column->getLocale()) {
$value = $element->$getter($defaultLanguage);
}
}

return $value;
}

private function getLocalizedValueFromKey(string $key, ?string $locale, ElementInterface $element): mixed
Expand All @@ -45,4 +54,19 @@ private function getGetter(string $key): string
{
return 'get' . ucfirst($key);
}

private function isEmptyValue(mixed $value): bool
{
return $value === null || $value === '';
}

protected function doGetFallbackValues(): bool
{
return false;
}

protected function getDefaultLanguage(): ?string
{
return null;
}
}
Loading