vendor/shopware/core/Content/Product/SalesChannel/Sorting/ProductSortingEntity.php line 9

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\SalesChannel\Sorting;
  5. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  6. use Shopware\Core\Framework\DataAbstractionLayer\EntityIdTrait;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Search\Sorting\FieldSorting;
  8. use Shopware\Core\Framework\Log\Package;
  10. #[Package('inventory')]
  11. class ProductSortingEntity extends Entity
  12. {
  13.     use EntityIdTrait;
  15.     /**
  16.      * @var string
  17.      */
  18.     protected $key;
  20.     /**
  21.      * @var int
  22.      */
  23.     protected $priority;
  25.     /**
  26.      * @var bool
  27.      */
  28.     protected $active;
  30.     /**
  31.      * @var array<array{field: string, priority: int, order: ?string, naturalSorting: bool|int|null}>
  32.      */
  33.     protected $fields;
  35.     /**
  36.      * @var string|null
  37.      */
  38.     protected $label;
  40.     /**
  41.      * @var ProductSortingTranslationCollection|null
  42.      */
  43.     protected $translations;
  45.     /**
  46.      * @var bool
  47.      */
  48.     protected $locked;
  50.     /**
  51.      * @return array<FieldSorting>
  52.      */
  53.     public function createDalSorting(): array
  54.     {
  55.         $sorting = [];
  57.         $fields = $this->fields;
  59.         if (!\is_array($fields)) {
  60.             $fields = [];
  61.         }
  63.         usort($fields, fn ($a, $b) => $b['priority'] <=> $a['priority']);
  65.         foreach ($fields as $field) {
  66.             $direction = mb_strtoupper((string) $field['order']) === FieldSorting::ASCENDING
  67.                 ? FieldSorting::ASCENDING
  68.                 : FieldSorting::DESCENDING;
  70.             $sorting[] = new FieldSorting(
  71.                 $field['field'],
  72.                 $direction,
  73.                 (bool) ($field['naturalSorting'] ?? false)
  74.             );
  75.         }
  77.         $flat = array_column($fields, 'field');
  79.         if (\in_array('id', $flat, true)) {
  80.             return $sorting;
  81.         }
  82.         if (\in_array('product.id', $flat, true)) {
  83.             return $sorting;
  84.         }
  86.         $sorting[] = new FieldSorting('id', FieldSorting::ASCENDING);
  88.         return $sorting;
  89.     }
  91.     public function getKey(): string
  92.     {
  93.         return $this->key;
  94.     }
  96.     public function setKey(string $key): void
  97.     {
  98.         $this->key = $key;
  99.     }
  101.     public function getPriority(): int
  102.     {
  103.         return $this->priority;
  104.     }
  106.     public function setPriority(int $priority): void
  107.     {
  108.         $this->priority = $priority;
  109.     }
  111.     public function isActive(): bool
  112.     {
  113.         return $this->active;
  114.     }
  116.     public function setActive(bool $active): void
  117.     {
  118.         $this->active = $active;
  119.     }
  121.     /**
  122.      * @return array<array{field: string, priority: int, order: ?string, naturalSorting: bool|int|null}>
  123.      */
  124.     public function getFields(): array
  125.     {
  126.         return $this->fields;
  127.     }
  129.     /**
  130.      * @param array<array{field: string, priority: int, order: ?string, naturalSorting: bool|int|null}> $fields
  131.      */
  132.     public function setFields(array $fields): void
  133.     {
  134.         $this->fields = $fields;
  135.     }
  137.     public function getLabel(): ?string
  138.     {
  139.         return $this->label;
  140.     }
  142.     public function setLabel(?string $label): void
  143.     {
  144.         $this->label = $label;
  145.     }
  147.     public function getTranslations(): ?ProductSortingTranslationCollection
  148.     {
  149.         return $this->translations;
  150.     }
  152.     public function setTranslations(ProductSortingTranslationCollection $translations): void
  153.     {
  154.         $this->translations = $translations;
  155.     }
  157.     public function isLocked(): bool
  158.     {
  159.         return $this->locked;
  160.     }
  162.     public function setLocked(bool $locked): void
  163.     {
  164.         $this->locked = $locked;
  165.     }
  167.     public function getApiAlias(): string
  168.     {
  169.         return 'product_sorting';
  170.     }
  171. }