ACP-4056 Added interface to expands actions on file info view page. (…

…#11134) ACP-4056 Added interface to expands actions on file info view page.
spryker · Oct 11, 2024 · 8f93e20 · 8f93e20
1 parent fb1ca52
commit 8f93e20
Show file tree

Hide file tree

Showing 8 changed files with 107 additions and 5 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -11,4 +11,3 @@ trim_trailing_whitespace = true
 
 [*.bat]
 end_of_line = crlf
-
diff --git a/.gitattributes b/.gitattributes
@@ -32,5 +32,5 @@ tooling.yml export-ignore
 .editorconfig export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
-architecture-baseline.json export-ignore
 .github/ export-ignore
+architecture-baseline.json export-ignore
diff --git a/codeception.yml b/codeception.yml
@@ -1,7 +1,7 @@
 namespace: SprykerTest
 paths:
     tests: tests/
-    output: tests/_output/
+    log: tests/_output/
     data: tests/_data/
     support: tests/_support/
     envs: tests/_envs/

diff --git a/composer.json b/composer.json
@@ -6,6 +6,7 @@
     "require": {
         "php": ">=8.2",
         "spryker/file-manager": "^2.3.0",
+        "spryker/file-manager-gui-extension": "^1.0.0",
         "spryker/file-system-extension": "^1.0.0",
         "spryker/gui": "^3.45.0",
         "spryker/kernel": "^3.30.0",

diff --git a/src/Spryker/Shared/FileManagerGui/Transfer/file_manager_gui.transfer.xml b/src/Spryker/Shared/FileManagerGui/Transfer/file_manager_gui.transfer.xml
@@ -81,4 +81,10 @@
     <transfer name="Locale">
     </transfer>
 
+    <transfer name="Button">
+        <property name="url" type="string"/>
+        <property name="title" type="string"/>
+        <property name="defaultOptions" type="array" singular="defaultOptions"/>
+        <property name="customOptions" type="array" singular="customOptions"/>
+    </transfer>
 </transfers>
diff --git a/src/Spryker/Zed/FileManagerGui/Communication/FileManagerGuiCommunicationFactory.php b/src/Spryker/Zed/FileManagerGui/Communication/FileManagerGuiCommunicationFactory.php
@@ -69,6 +69,7 @@ public function createFileInfoViewTable(int $idFile)
         return new FileInfoViewTable(
             $this->getFileInfoQuery(),
             $idFile,
+            $this->getTableActionsExpanderPlugins(),
         );
     }
 
@@ -264,4 +265,12 @@ protected function getMimeTypeQuery()
     {
         return $this->getProvidedDependency(FileManagerGuiDependencyProvider::PROPEL_QUERY_MIME_TYPE);
     }
+
+    /**
+     * @return array<\Spryker\Zed\FileManagerGuiExtension\Dependency\Plugin\FileInfoViewTableActionsExpanderPluginInterface>
+     */
+    protected function getTableActionsExpanderPlugins(): array
+    {
+        return $this->getProvidedDependency(FileManagerGuiDependencyProvider::PLUGINS_FILE_INFO_VIEW_TABLE_ACTIONS_EXPANDER);
+    }
 }
diff --git a/src/Spryker/Zed/FileManagerGui/Communication/Table/FileInfoViewTable.php b/src/Spryker/Zed/FileManagerGui/Communication/Table/FileInfoViewTable.php
@@ -7,12 +7,33 @@
 
 namespace Spryker\Zed\FileManagerGui\Communication\Table;
 
+use Orm\Zed\FileManager\Persistence\SpyFileInfoQuery;
 use Spryker\Service\UtilText\Model\Url\Url;
 
 class FileInfoViewTable extends FileInfoTable
 {
     /**
-     * @param array $item
+     * @var array<\Spryker\Zed\FileManagerGuiExtension\Dependency\Plugin\FileInfoViewTableActionsExpanderPluginInterface>
+     */
+    protected array $tableActionsExpanderPlugins;
+
+    /**
+     * @param \Orm\Zed\FileManager\Persistence\SpyFileInfoQuery $fileInfoQuery
+     * @param int $idFile
+     * @param array<\Spryker\Zed\FileManagerGuiExtension\Dependency\Plugin\FileInfoViewTableActionsExpanderPluginInterface> $tableActionsExpanderPlugins
+     */
+    public function __construct(
+        SpyFileInfoQuery $fileInfoQuery,
+        int $idFile,
+        array $tableActionsExpanderPlugins
+    ) {
+        parent::__construct($fileInfoQuery, $idFile);
+
+        $this->tableActionsExpanderPlugins = $tableActionsExpanderPlugins;
+    }
+
+    /**
+     * @param array<mixed> $item
      *
      * @return array<string>
      */
@@ -27,6 +48,44 @@ protected function buildLinks($item)
             'Download',
         );
 
-        return $buttons;
+        return $this->expandLinks($item, $buttons);
+    }
+
+    /**
+     * @param array<string, mixed> $item
+     * @param array<string> $buttons
+     *
+     * @return array<string>
+     */
+    protected function expandLinks(array $item, array $buttons): array
+    {
+        $buttonCollection = [];
+
+        foreach ($this->tableActionsExpanderPlugins as $tableActionsExpanderPlugin) {
+            $buttonCollection = $tableActionsExpanderPlugin->execute($item, $buttonCollection);
+        }
+
+        return array_merge($buttons, $this->generateButtons($buttonCollection));
+    }
+
+    /**
+     * @param array<\Generated\Shared\Transfer\ButtonTransfer> $buttonTransferCollection
+     *
+     * @return array<string>
+     */
+    protected function generateButtons(array $buttonTransferCollection): array
+    {
+        $generatedButtons = [];
+
+        foreach ($buttonTransferCollection as $buttonTransfer) {
+            $generatedButtons[] = $this->generateButton(
+                $buttonTransfer->getUrlOrFail(),
+                $buttonTransfer->getTitleOrFail(),
+                $buttonTransfer->getDefaultOptions(),
+                $buttonTransfer->getCustomOptions(),
+            );
+        }
+
+        return $generatedButtons;
     }
 }
diff --git a/src/Spryker/Zed/FileManagerGui/FileManagerGuiDependencyProvider.php b/src/Spryker/Zed/FileManagerGui/FileManagerGuiDependencyProvider.php
@@ -51,6 +51,11 @@ class FileManagerGuiDependencyProvider extends AbstractBundleDependencyProvider
      */
     public const SERVICE_UTIL_ENCODING = 'SERVICE_UTIL_ENCODING';
 
+    /**
+     * @var string
+     */
+    public const PLUGINS_FILE_INFO_VIEW_TABLE_ACTIONS_EXPANDER = 'PLUGINS_FILE_INFO_VIEW_TABLE_ACTIONS_EXPANDER';
+
     /**
      * @param \Spryker\Zed\Kernel\Container $container
      *
@@ -64,6 +69,7 @@ public function provideCommunicationLayerDependencies(Container $container)
         $container = $this->addLocaleFacade($container);
         $container = $this->addQueries($container);
         $container = $this->addUtilEncodingService($container);
+        $container = $this->addTableActionsExpanderPlugins($container);
 
         return $container;
     }
@@ -171,4 +177,26 @@ protected function addUtilEncodingService(Container $container): Container
 
         return $container;
     }
+
+    /**
+     * @param \Spryker\Zed\Kernel\Container $container
+     *
+     * @return \Spryker\Zed\Kernel\Container
+     */
+    protected function addTableActionsExpanderPlugins(Container $container): Container
+    {
+        $container->set(static::PLUGINS_FILE_INFO_VIEW_TABLE_ACTIONS_EXPANDER, function () {
+            return $this->getFileInfoViewTableActionsExpanderPlugins();
+        });
+
+        return $container;
+    }
+
+    /**
+     * @return array<\Spryker\Zed\FileManagerGuiExtension\Dependency\Plugin\FileInfoViewTableActionsExpanderPluginInterface>
+     */
+    protected function getFileInfoViewTableActionsExpanderPlugins(): array
+    {
+        return [];
+    }
 }