Allow for bookmarks of non-bookmark entities

Author: jissereitsma

Component/Grid/GridViewModel.php

@@ -153,9 +153,13 @@ public function getJsData(): array
         $columns = $this->getColumns();
         $stateData = $this->getState()->toArray();
         if (empty($stateData['activeColumns'])) {
+            $columnsData = [];
             foreach ($columns as $column) {
+                $columnsData[$column->getCode()] = ['visible' => 1];
                 $stateData['activeColumns'][] = $column->getCode();
             }
+
+            $this->getState()->saveBookmarkData(['columns' => $columnsData]);
         }
 
         return [

Grid/BookmarkLoader.php

@@ -6,15 +6,19 @@
 use Magento\Framework\Serialize\SerializerInterface;
 use Magento\Ui\Api\BookmarkManagementInterface;
 use Magento\Ui\Api\BookmarkRepositoryInterface;
+use Magento\Ui\Api\Data\BookmarkInterfaceFactory as BookmarkFactory;
 use Magento\Ui\Api\Data\BookmarkInterface;
 use Magento\Ui\Api\Data\BookmarkSearchResultsInterface;
+use Magento\Backend\Model\Auth\Session as AdminSession;
 
 class BookmarkLoader
 {
     public function __construct(
         private BookmarkManagementInterface $bookmarkManagement,
         private BookmarkRepositoryInterface $bookmarkRepository,
+        private BookmarkFactory $bookmarkFactory,
         private SerializerInterface $serializer,
+        private AdminSession $adminSession,
     ) {
     }
 
@@ -57,4 +61,24 @@ public function saveBookmark(BookmarkInterface $bookmark, array $data, string $i
         $bookmark->setConfig($this->serializer->serialize($config));
         $this->bookmarkRepository->save($bookmark);
     }
+
+    public function createBookmark(string $namespace, array $data, string $identifier = 'default'): void
+    {
+        $config = [
+            'views' => [
+                $identifier => [
+                    'data' => $data,
+                ]
+            ]
+        ];
+
+        $bookmark = $this->bookmarkFactory->create();
+        $bookmark->setIdentifier($identifier);
+        $bookmark->setNamespace($namespace);
+        $bookmark->setCurrent(true);
+        $bookmark->setTitle('Default');
+        $bookmark->setUserId($this->adminSession->getUser()->getId());
+        $bookmark->setConfig($this->serializer->serialize($config));
+        $this->bookmarkRepository->save($bookmark);
+    }
 }

Grid/ColumnLoader.php

@@ -72,8 +72,7 @@ public function getColumnsFromNamespace(string $namespace): array
             return [];
         }
 
-        $positions = $currentBookmark['data']['positions'];
-
+        $positions = $currentBookmark['data']['positions'] ?? [];
 
         $columns = [];
         foreach ($currentBookmark['data']['columns'] as $columnName => $columnData) {

Grid/State.php

@@ -245,6 +245,10 @@ public function setActiveColumns(array $columns): void
                 $columnData['visible'] =  (int)in_array($columnName, $columns);
                 $columnsData[$columnName] = $columnData;
             }
+        } else {
+            foreach ($columns as $columnName => $columnData) {
+                $columnsData[$columnName] = ['visible' => true];
+            }
         }
 
         $this->saveBookmarkData(['columns' => $columnsData]);
@@ -284,6 +288,7 @@ public function saveBookmarkData(array $bookmarkData): void
         try {
             $this->bookmarkLoader->saveBookmark($this->getBookmark(), $bookmarkData);
         } catch (NoSuchEntityException $e) {
+            $this->bookmarkLoader->createBookmark($this->namespace, $bookmarkData);
         }
     }