added pagination items count selector in backend

degami · degami · commit f77c2c0b744c · 2024-07-24T00:41:41.000+02:00
diff --git a/app/base/abstracts/Controllers/AdminManageModelsPage.php b/app/base/abstracts/Controllers/AdminManageModelsPage.php
@@ -13,6 +13,7 @@
 
 namespace App\Base\Abstracts\Controllers;
 
+use App\Base\Abstracts\Models\BaseCollection;
 use App\Base\Abstracts\Models\BaseModel;
 use App\Base\Exceptions\PermissionDeniedException;
 use App\Site\Routing\RouteInfo;
@@ -26,6 +27,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use App\Base\Abstracts\Models\FrontendModel;
 use Degami\Basics\Html\TagElement;
+use App\Site\Models\User;
 
 /**
  * Base for admin page that manages a Model
@@ -62,6 +64,7 @@ public function __construct(
     ) {
         parent::__construct($container, $request, $route_info);
         if ($this->template_data['action'] == 'list') {
+            $this->addPaginationSizeSelector();
             $this->addNewButton();
 
             $paginate_params = [
@@ -90,19 +93,43 @@ public function __construct(
 
                 $paginate_params['condition'] = array_filter($conditions);
             }
+
+            $itemsPerPage = $this->getItemsPerPage();
             /** @var \App\Base\Abstracts\Models\BaseCollection $collection */
             $collection = $this->containerCall([$this->getObjectClass(), 'getCollection']);
             $collection->addCondition($paginate_params['condition'])->addOrder($paginate_params['order']);
-            $data = $this->containerCall([$collection, 'paginate']);
+            $data = $this->containerCall([$collection, 'paginate'], ['page_size' => $itemsPerPage]);
             $this->template_data += [
                 'table' => $this->getHtmlRenderer()->renderAdminTable($this->getTableElements($data['items']), $this->getTableHeader(), $this),
                 'total' => $data['total'],
                 'current_page' => $data['page'],
-                'paginator' => $this->getHtmlRenderer()->renderPaginator($data['page'], $data['total'], $this),
+                'paginator' => $this->getHtmlRenderer()->renderPaginator($data['page'], $data['total'], $this, $itemsPerPage, 5),
             ];
         }
     }
 
+    /**
+     * get items per page on listing
+     * 
+     * @return int
+     */
+    protected function getItemsPerPage() : int 
+    {
+        /** @var User $user */
+        $user = $this->getCurrentUser();
+
+        $uiSettings = $user->getUserSession()->getSessionKey('uiSettings');
+        $currentRoute = $this->getRouteInfo()->getRouteName();
+
+        if (is_array($uiSettings) && isset($uiSettings[$currentRoute])) {
+            if (isset($uiSettings[$currentRoute]['itemsPerPage'])) {
+                return intval($uiSettings[$currentRoute]['itemsPerPage']);
+            }
+        }
+
+        return BaseCollection::ITEMS_PER_PAGE;
+    }
+
     /**
      * gets search parameters
      *
@@ -221,6 +248,36 @@ public function addNewButton()
         $this->addActionLink('new-btn', 'new-btn', $this->getHtmlRenderer()->getIcon('plus') . ' ' . $this->getUtils()->translate('New', $this->getCurrentLocale()), $this->getControllerUrl() . '?action=new', 'btn btn-sm btn-success');
     }
 
+    public function addPaginationSizeSelector()
+    {
+        // calculate options values, including value used for pagination
+        $options = array_unique(array_merge([10, 25, 50, 200, 500], [$this->getItemsPerPage()]));
+        sort($options);
+
+        $select = $this->containerMake(TagElement::class, ['options' => [
+            'tag' => 'select',
+            'id' => 'pagination-size-selector',
+            'attributes' => [
+                'class' => 'paginator-items-choice',
+                'style' => 'width: 50px',
+            ],
+            'children' => array_map(function($val) {
+                $selected = [];
+                if ($val == $this->getItemsPerPage()) {
+                    $selected = ['selected' => 'selected'];
+                }
+                return $this->containerMake(TagElement::class, ['options' => [
+                    'tag' => 'option',
+                    'value' => $val,
+                    'attributes' => [
+                        'class' => '',
+                    ] + $selected,
+                    'text' => $val,
+                ]]);
+            }, $options),
+        ]]);
+        $this->action_buttons[] = __('Items per page'). ':' . $select;
+    }
 
     /**
      * gets action button html
diff --git a/app/base/abstracts/Controllers/AdminPage.php b/app/base/abstracts/Controllers/AdminPage.php
@@ -151,10 +151,12 @@ protected function prepareTemplate(): Template
         $this->getAssets()->addJs(
             "\$('#admin').appAdmin(" . json_encode(
                 [
+                    'currentRoute' => $this->getRouteInfo()->getRouteName(),
                     'checkLoggedUrl' => $this->getUrl('crud.app.site.controllers.admin.json.checksession'),
                     'logoutUrl' => $this->getUrl('admin.logout'),
                     'chatGPTUrl' => $this->getUrl('crud.app.site.controllers.admin.json.chatgpt'),
                     'googleGeminiUrl' => $this->getUrl('crud.app.site.controllers.admin.json.googlegemini'),
+                    'uIsettingsUrl' => $this->getUrl('crud.app.site.controllers.admin.json.uisettings'),
                 ]
             ) . ");"
         );
diff --git a/app/base/traits/AdminTrait.php b/app/base/traits/AdminTrait.php
@@ -118,7 +118,7 @@ protected function renderActionButtons(): string
                     TagElement::class,
                     ['options' => [
                         'tag' => 'li',
-                        'attributes' => ['class' => 'nav-item ml-1'],
+                        'attributes' => ['class' => 'nav-item ml-1 text-nowrap'],
                         'text' => $button_html
                     ]]
                 )
diff --git a/app/site/controllers/Admin/Json/UISettings.php b/app/site/controllers/Admin/Json/UISettings.php
@@ -0,0 +1,84 @@
+<?php
+
+/**
+ * SiteBase
+ * PHP Version 8.0
+ *
+ * @category CMS / Framework
+ * @package  Degami\Sitebase
+ * @author   Mirko De Grandis <degami@github.com>
+ * @license  MIT https://opensource.org/licenses/mit-license.php
+ * @link     https://github.com/degami/sitebase
+ */
+
+namespace App\Site\Controllers\Admin\Json;
+
+use App\Base\Abstracts\Controllers\AdminJsonPage;
+use DI\DependencyException;
+use DI\NotFoundException;
+use Exception;
+use Symfony\Component\HttpFoundation\Request;
+use App\Site\Models\User;
+
+/**
+ * UISettings Admin
+ */
+class UISettings extends AdminJsonPage
+{
+    /**
+     * {@inheritdocs}
+     *
+     * @return string
+     */
+    protected function getAccessPermission(): string
+    {
+        return 'administer_site';
+    }
+
+    /**
+     * {@inheritdocs}
+     *
+     * @return array
+     * @throws DependencyException
+     * @throws NotFoundException
+     */
+    protected function getJsonData(): array
+    {
+        $settings = $this->getSettingsData($this->getRequest());
+        if (empty($settings) || !isset($settings['currentRoute'])) {
+            throw new Exception("Missing settings content");
+        }
+    
+        $currentRoute = $settings['currentRoute'];
+        // remove unuseful element
+        unset($settings['currentRoute']);
+
+        /** @var User $user */
+        $user = $this->getCurrentUser();
+        $uiSettings = $user->getUserSession()->getSessionKey('uiSettings') ?? [];
+
+        // merge incoming data into existing
+        $uiSettings[$currentRoute] = array_merge(
+            $uiSettings[$currentRoute] ?? [],
+            $settings
+        );
+
+        // save data
+        $user->getUserSession()->addSessionData('uiSettings', $uiSettings)->persist();
+
+        return ['success' => true, 'settings' => $user->getUserSession()->getSessionKey('uiSettings')];
+    }
+
+    /**
+     * @return string|null
+     */
+    protected function getSettingsData(Request $request) : ?array
+    {
+        $content = json_decode($request->getContent(), true);
+        if (is_array($content) && !empty($content)) {
+            return $content;
+        }
+
+        return null;
+    }
+}
diff --git a/app/site/models/UserSession.php b/app/site/models/UserSession.php
@@ -103,6 +103,22 @@ public function addSessionData(string $key, $value): UserSession
         return $this;
     }
 
+    /**
+     * gets session data by key
+     * 
+     * @param string $key
+     * @return mixed
+     */
+    public function getSessionKey(string $key): mixed
+    {
+        $session_data = $this->getNormalizedSessionData();
+        if (array_key_exists($key, $session_data)) {
+            return $session_data[$key];
+        }
+
+        return null;
+    }
+
     /**
      * sets input array values as session values
      *
diff --git a/js/src/admin.js b/js/src/admin.js
@@ -29,7 +29,19 @@
 
                 $elem.data('appAdmin', instance);
 
-                $('select:not(".select2-processed")', $elem).select2({'width':'100%'}).addClass('select2-processed');
+                $('select:not(".select2-processed")', $elem).each(function(index, select){
+                    $(select).select2({'width': $(select).css('width') ? $(select).css('width') : '100%'}).addClass('select2-processed');
+                });
+
+                $('select.paginator-items-choice').on('change', function(){
+                    $elem.appAdmin('updateUserUiSettings', 
+                        {'currentRoute': $elem.appAdmin('getSettings').currentRoute, 'itemsPerPage': $(this).val()},
+                        function (data) {
+                            document.location.reload();
+                        }
+                    );
+                });
+
                 $('a.inToolSidePanel[href]', $elem).click(function(evt){
                     if($(this).attr('href') != '#') {
                        evt.preventDefault();
@@ -221,6 +233,18 @@
         askGoogleGemini: function(text, target) {
             $(this).appAdmin('askAI', 'gemini', text, target);
         },
+        updateUserUiSettings: function(settings, succesCallback) {
+            var uIsettingsUrl = $(this).appAdmin('getSettings').uIsettingsUrl;
+            $.ajax({
+                type: "POST",
+                url: uIsettingsUrl,
+                data: JSON.stringify(settings),
+                processData: false,
+                contentType: 'application/json',
+                success: succesCallback,
+                error: function(xhr, ajaxOptions, thrownError) {}
+            });
+        },
         show : function( ) {    },// IS
         hide : function( ) {  },// GOOD
         update : function( content ) {  }// !!!
@@ -231,5 +255,7 @@
         'logoutUrl': null,
         'chatGPTUrl': null,
         'googleGeminiUrl': null,
+        'uIsettingsUrl': null,
+        'currentRoute': null,
     }
 })(jQuery);

Original file line number	Diff line number	Diff line change
`@@ -151,10 +151,12 @@ protected function prepareTemplate(): Template`
`151`	`151`	`$this->getAssets()->addJs(`
`152`	`152`	`"\$('#admin').appAdmin(" . json_encode(`
`153`	`153`	`[`
	`154`	`+ 'currentRoute' => $this->getRouteInfo()->getRouteName(),`
`154`	`155`	`'checkLoggedUrl' => $this->getUrl('crud.app.site.controllers.admin.json.checksession'),`
`155`	`156`	`'logoutUrl' => $this->getUrl('admin.logout'),`
`156`	`157`	`'chatGPTUrl' => $this->getUrl('crud.app.site.controllers.admin.json.chatgpt'),`
`157`	`158`	`'googleGeminiUrl' => $this->getUrl('crud.app.site.controllers.admin.json.googlegemini'),`
	`159`	`+ 'uIsettingsUrl' => $this->getUrl('crud.app.site.controllers.admin.json.uisettings'),`
`158`	`160`	`]`
`159`	`161`	`) . ");"`
`160`	`162`	`);`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ protected function renderActionButtons(): string`
`118`	`118`	`TagElement::class,`
`119`	`119`	`['options' => [`
`120`	`120`	`'tag' => 'li',`
`121`		`- 'attributes' => ['class' => 'nav-item ml-1'],`
	`121`	`+ 'attributes' => ['class' => 'nav-item ml-1 text-nowrap'],`
`122`	`122`	`'text' => $button_html`
`123`	`123`	`]]`
`124`	`124`	`)`