implement visibility

Author: thomas-kl1

Block/Widget/Document/Link.php

@@ -93,7 +93,7 @@ private function resolveDocument(): ?DocumentInterface
     {
         if (!$this->hasData('document')) {
             try {
-                $this->setData('document', $this->documentRepository->getById((int)$this->getData('document_id')));
+                $this->setData('document', $this->documentRepository->getById((int) $this->getData('document_id')));
             } catch (NoSuchEntityException $e) {
                 $this->_logger->error($e->getLogMessage(), $e->getTrace());
                 $this->setData('document');

Block/Widget/Document/ListByType.php

@@ -7,6 +7,7 @@
 
 namespace Opengento\DocumentWidget\Block\Widget\Document;
 
+use Magento\Framework\Data\CollectionModifierInterface;
 use Magento\Framework\DataObject\IdentityInterface;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\View\Element\Template;
@@ -42,18 +43,25 @@ class ListByType extends Template implements BlockInterface, IdentityInterface
      */
     private $imageViewModel;
 
+    /**
+     * @var CollectionModifierInterface
+     */
+    private $collectionModifier;
+
     public function __construct(
         Context $context,
         DocumentTypeRepositoryInterface $docTypeRepository,
         CollectionFactory $collectionFactory,
         UrlViewModel $urlViewModel,
         ImageViewModel $imageViewModel,
+        CollectionModifierInterface $collectionModifier,
         array $data = []
     ) {
         $this->docTypeRepository = $docTypeRepository;
         $this->collectionFactory = $collectionFactory;
         $this->urlViewModel = $urlViewModel;
         $this->imageViewModel = $imageViewModel;
+        $this->collectionModifier = $collectionModifier;
         parent::__construct($context, $data);
     }
 
@@ -102,7 +110,7 @@ private function createCollection(): Collection
         /** @var Collection $collection */
         $collection = $this->collectionFactory->create();
         $collection->addFieldToFilter('type_id', ['eq' => $this->getData('type_id')]);
-        $collection->addDefaultImage();
+        $this->collectionModifier->apply($collection);
 
         return $collection;
     }

Model/Document/Collection/CollectionModifier.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
+
+namespace Opengento\DocumentWidget\Model\Document\Collection;
+
+use Magento\Framework\Data\Collection\AbstractDb;
+use Magento\Framework\Data\CollectionModifierInterface;
+
+/**
+ * @api
+ */
+final class CollectionModifier implements CollectionModifierInterface
+{
+    /**
+     * @var CollectionModifierInterface[]
+     */
+    private $modifiers;
+
+    public function __construct(
+        array $modifiers = []
+    ) {
+        $this->modifiers = $modifiers;
+    }
+
+    public function apply(AbstractDb $collection): void
+    {
+        foreach ($this->modifiers as $modifier) {
+            $modifier->apply($collection);
+        }
+    }
+}

Model/Document/Collection/SorterModifier.php

@@ -20,14 +20,26 @@ final class SorterModifier implements CollectionModifierInterface
      */
     private $sorter;
 
+    /**
+     * @var string[]
+     */
+    private $mapper;
+
     public function __construct(
-        Sorter $sorter
+        Sorter $sorter,
+        array $mapper = []
     ) {
         $this->sorter = $sorter;
+        $this->mapper = $mapper;
     }
 
     public function apply(AbstractDb $collection): void
     {
-        $collection->setOrder($this->sorter->getOrder(), $this->sorter->getDirection());
+        $field = $this->sorter->getOrder();
+        if (isset($this->mapper[$field])) {
+            $collection->addFilterToMap($field, $this->mapper[$field]);
+        }
+
+        $collection->setOrder($field, $this->sorter->getDirection());
     }
 }

ViewModel/DocumentType.php

@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <type name="Opengento\DocumentWidget\Model\Document\Collection\CollectionModifier">
+        <arguments>
+            <argument name="modifiers" xsi:type="array">
+                <item name="select" xsi:type="object">Opengento\Document\Model\Document\Collection\SelectModifier</item>
+                <item name="sorter" xsi:type="object">Opengento\DocumentWidget\Model\Document\Collection\SorterModifier</item>
+            </argument>
+        </arguments>
+    </type>
+    <type name="Opengento\DocumentWidget\Block\Widget\Document\ListByType">
+        <arguments>
+            <argument name="collectionModifier" xsi:type="object">Opengento\DocumentWidget\Model\Document\Collection\CollectionModifier</argument>
+        </arguments>
+    </type>
+    <type name="Opengento\DocumentWidget\Model\Document\Collection\SorterModifier">
+        <arguments>
+            <argument name="mapper" xsi:type="array">
+                <item name="entity_id" xsi:type="string">main_table.entity_id</item>
+            </argument>
+        </arguments>
+    </type>
+</config>

etc/di.xml

@@ -32,4 +32,13 @@
             </argument>
         </arguments>
     </type>
+    <type name="Opengento\DocumentWidget\Model\Document\Collection\CollectionModifier">
+        <arguments>
+            <argument name="modifiers" xsi:type="array">
+                <item name="select" xsi:type="object">Opengento\Document\Model\Document\Collection\SelectModifier</item>
+                <item name="sorter" xsi:type="object">Opengento\DocumentWidget\Model\Document\Collection\SorterModifier</item>
+                <item name="visibility" xsi:type="object">Opengento\Document\Model\Document\Collection\FrontendVisibilityModifier</item>
+            </argument>
+        </arguments>
+    </type>
 </config>