Implement persist_state setting

Author: curry684

docs/source/index.html.md

@@ -128,7 +128,7 @@ datatables:
         option:           value           
 
     # Where to persist the current table state automatically
-    persist_state:        fragment # One of "query"; "fragment"; "local"; "session"
+    persist_state:        fragment # One of "none"; "query"; "fragment"; "local"; "session"
 
     # Default service used to render templates, built-in TwigRenderer uses global Twig environment
     renderer:             Omines\DataTablesBundle\Twig\TwigRenderer

src/DataTable.php

@@ -73,6 +73,9 @@ class DataTable
     /** @var string */
     protected $name = 'dt';
 
+    /** @var string */
+    protected $persistState = 'fragment';
+
     /** @var string */
     protected $template = self::DEFAULT_TEMPLATE;
 
@@ -229,9 +232,9 @@ public function getName(): string
     /**
      * @return string
      */
-    public function getTranslationDomain(): string
+    public function getPersistState(): string
     {
-        return $this->translationDomain;
+        return $this->persistState;
     }
 
     /**
@@ -242,6 +245,14 @@ public function getState()
         return $this->state;
     }
 
+    /**
+     * @return string
+     */
+    public function getTranslationDomain(): string
+    {
+        return $this->translationDomain;
+    }
+
     /**
      * @return bool
      */
@@ -391,6 +402,16 @@ public function setMethod(string $method): self
         return $this;
     }
 
+    /**
+     * @param string $persistState
+     * @return self
+     */
+    public function setPersistState(string $persistState): DataTable
+    {
+        $this->persistState = $persistState;
+        return $this;
+    }
+
     /**
      * @param DataTableRendererInterface $renderer
      * @return self

src/DataTableFactory.php

@@ -60,6 +60,7 @@ public function create(array $options = [])
         return (new DataTable(array_merge($config['options'] ?? [], $options), $this->instantiator))
             ->setRenderer($this->renderer)
             ->setMethod($config['method'] ?? Request::METHOD_POST)
+            ->setPersistState($config['persist_state'] ?? 'fragment')
             ->setTranslationDomain($config['translation_domain'] ?? 'messages')
             ->setLanguageFromCDN($config['language_from_cdn'] ?? true)
             ->setTemplate($config['template'] ?? DataTable::DEFAULT_TEMPLATE, $config['template_parameters'] ?? [])

src/DependencyInjection/Configuration.php

@@ -36,7 +36,7 @@ public function getConfigTreeBuilder()
                 ->end()
                 ->enumNode('persist_state')
                     ->info('Where to persist the current table state automatically')
-                    ->values(['query', 'fragment', 'local', 'session'])
+                    ->values(['none', 'query', 'fragment', 'local', 'session'])
                     ->defaultValue('fragment')
                 ->end()
                 ->enumNode('method')

src/Resources/assets/js/datatables.js

@@ -28,6 +28,13 @@
                 break;
         }
         state = (state.length > 1 ? deparam(state.substr(1)) : {});
+        var persistOptions = config.state === 'none' ? {} : {
+            stateSave: true,
+            stateLoadCallback: function(settings) {
+                state.time = Date.now();
+                return state;
+            }
+        };
 
         return new Promise((fulfill, reject) => {
             // Perform initial load
@@ -40,7 +47,7 @@
             }).done(function(data) {
                 var rebuild = true, cached;
 
-                var dtOpts = $.extend({}, data.options, config.options, options, {
+                var dtOpts = $.extend({}, data.options, config.options, options, persistOptions, {
                     ajax: function (request, drawCallback, settings) {
                         if (rebuild) {
                             data.draw = request.draw;

src/Twig/DataTablesExtension.php

@@ -40,6 +40,7 @@ public function getFunctions()
                 return json_encode([
                     'name' => $dataTable->getName(),
                     'method' => $dataTable->getMethod(),
+                    'state' => $dataTable->getPersistState(),
                     'options' => [
                         'language' => $this->getLanguageSettings($dataTable),
                     ],