Lazy search execution

Move search out of aggregation constructors. It should only be executed
before actual rendering, not e.g. on metadata run

Author: annda

_test/mock/AggregationEditorTable.php

@@ -8,6 +8,7 @@ class AggregationEditorTable extends meta\AggregationEditorTable
 {
     public function getResult()
     {
+        $this->executeSearch();
         return $this->result;
     }
 }

_test/mock/AggregationTable.php

@@ -8,6 +8,7 @@ class AggregationTable extends meta\AggregationTable
 {
     public function getResult()
     {
+        $this->executeSearch();
         return $this->result;
     }
 }

action/aggregationeditor.php

@@ -144,6 +144,7 @@ protected function saveRow()
             new SearchConfig($config)
         );
 
+        $editorTable->executeSearch();
         echo $editorTable->getFirstRow();
     }
 

meta/Aggregation.php

@@ -60,10 +60,7 @@ public function __construct($id, $mode, \Doku_Renderer $renderer, SearchConfig $
         $this->mode = $mode;
         $this->renderer = $renderer;
         $this->searchConfig = $searchConfig;
-        $this->data = $searchConfig->getConf();
-        $this->columns = $searchConfig->getColumns();
-        $this->result = $this->searchConfig->execute();
-        $this->resultCount = $this->searchConfig->getCount();
+        $this->data = $this->searchConfig->getConf();
         $this->helper = plugin_load('helper', 'struct_config');
     }
 
@@ -104,6 +101,15 @@ public function getScopeClasses()
         return $classes;
     }
 
+    public function executeSearch()
+    {
+        $this->columns = $this->searchConfig->getColumns();
+        $this->result = $this->searchConfig->execute();
+        $this->resultCount = $this->searchConfig->getCount();
+
+        $this->postSearch();
+    }
+
     /**
      * Render the actual output to the renderer
      *
@@ -120,6 +126,9 @@ abstract public function render($showNotFound = false);
      */
     public function startScope()
     {
+        if ($this->mode !== 'metadata') {
+            $this->executeSearch();
+        }
         if ($this->mode == 'xhtml') {
             $classes = $this->getScopeClasses();
 
@@ -130,6 +139,16 @@ public function startScope()
         }
     }
 
+    /**
+     * Child classes can set their own class properties based on search result
+     *
+     * @return void
+     */
+    public function postSearch()
+    {
+        return;
+    }
+
     /**
      * Closes anything opened in startScope()
      *

meta/AggregationCloud.php

@@ -20,10 +20,8 @@ class AggregationCloud extends Aggregation
      * @see render() on the resulting object.
      *
      */
-    public function __construct($id, $mode, \Doku_Renderer $renderer, SearchCloud $searchConfig)
+    public function postSearch()
     {
-        parent::__construct($id, $mode, $renderer, $searchConfig);
-
         $this->max = $this->result[0]['count'];
         $this->min = end($this->result)['count'];
     }

meta/AggregationEditorTable.php

@@ -27,9 +27,7 @@ public function render($showNotFound = false)
      */
     public function startScope()
     {
-        // unique identifier for this aggregation
-        $hash = md5(var_export($this->data, true));
-        $this->renderer->info['struct_table_hash'] = $hash;
+        parent::startScope();
 
         if ($this->mode != 'xhtml') return;
 

meta/AggregationList.php

@@ -12,10 +12,17 @@ class AggregationList extends Aggregation
     /** @var int number of all results */
     protected $resultColumnCount;
 
-    /** @inheritdoc */
-    public function __construct($id, $mode, \Doku_Renderer $renderer, SearchConfig $searchConfig)
+    /**
+     * Set our class property after search has been executed in parent
+     * @return void
+     */
+    public function startScope()
+    {
+        parent::startScope();
+    }
+
+    public function postSearch()
     {
-        parent::__construct($id, $mode, $renderer, $searchConfig);
         $this->resultColumnCount = count($this->columns);
     }
 

meta/AggregationTable.php

@@ -19,18 +19,9 @@ class AggregationTable extends Aggregation
     protected $resultRids;
     protected $resultRevs;
 
-    public function __construct($id, $mode, \Doku_Renderer $renderer, SearchConfig $searchConfig)
-    {
-        parent::__construct($id, $mode, $renderer, $searchConfig);
-        $this->resultPIDs = $this->searchConfig->getPids();
-        $this->resultRids = $this->searchConfig->getRids();
-        $this->resultRevs = $this->searchConfig->getRevs();
-    }
-
     /** @inheritdoc */
     public function render($showNotFound = false)
     {
-
         // abort early if there are no results at all (not filtered)
         if (!$this->resultCount && !$this->isDynamicallyFiltered() && $showNotFound) {
             $this->renderer->cdata($this->helper->getLang('none'));
@@ -104,6 +95,13 @@ public function startScope()
         parent::startScope();
     }
 
+    public function postSearch()
+    {
+        $this->resultPIDs = $this->searchConfig->getPids();
+        $this->resultRids = $this->searchConfig->getRids();
+        $this->resultRevs = $this->searchConfig->getRevs();
+    }
+
     /**
      * Closes the table and anything opened in startScope()
      *

syntax/table.php

@@ -122,13 +122,13 @@ public function render($format, Doku_Renderer $renderer, $config)
                 throw new StructException('Aggregation class does not inherit Aggregation: ' . $this->tableclass);
             }
 
-            $table->startScope();
-            $table->render(true);
-            $table->finishScope();
-
             if ($format === 'metadata') {
                 /** @var Doku_Renderer_metadata $renderer */
                 $renderer->meta['plugin']['struct']['hasaggregation'] = $search->getCacheFlag();
+            } else {
+                $table->startScope();
+                $table->render(true);
+                $table->finishScope();
             }
         } catch (StructException $e) {
             msg($e->getMessage(), -1, $e->getLine(), $e->getFile());