QueryBasedTable: add forgotten table base class

library/Director/Web/Table/QueryBasedTable.php

@@ -0,0 +1,193 @@
+<?php
+
+namespace Icinga\Module\Director\Web\Table;
+
+use Icinga\Data\Filter\Filter;
+use Icinga\Module\Director\Db;
+use Icinga\Module\Director\Web\Table\Extension\QuickSearch;
+use ipl\Db\Zf1\FilterRenderer;
+use ipl\Db\Zf1\SelectPaginationAdapter;
+use ipl\Html\Container;
+use ipl\Html\DeferredText;
+use ipl\Html\Html;
+use ipl\Html\Link;
+use ipl\Html\Table;
+use ipl\Translation\TranslationHelper;
+use ipl\Web\Component\ControlsAndContent;
+use ipl\Web\Component\Paginator;
+use ipl\Web\Url;
+
+abstract class QueryBasedTable extends Table
+{
+    use TranslationHelper;
+    use QuickSearch;
+
+    protected $defaultAttributes = [
+        'class' => ['common-table', 'table-row-selectable'],
+        'data-base-target' => '_next',
+    ];
+
+    private $connection;
+
+    private $db;
+
+    private $query;
+
+    protected $searchColumns = [];
+
+    public function __construct(Db $connection)
+    {
+        $this->connection = $connection;
+        $this->db = $connection->getDbAdapter();
+    }
+
+    public function getCountQuery()
+    {
+        return $this->getPaginationAdapter()->getCountQuery();
+    }
+
+    protected function getPaginationAdapter()
+    {
+        return new SelectPaginationAdapter($this->getQuery());
+    }
+
+    public function getPaginator(Url $url)
+    {
+        return new Paginator(
+            $this->getPaginationAdapter(),
+            $url
+        );
+    }
+
+    protected function getSearchColumns()
+    {
+        return $this->searchColumns;
+    }
+
+    protected function search($search)
+    {
+        if (! empty($search)) {
+            $query = $this->getQuery();
+            $columns = $this->getSearchColumns();
+            if (strpos($search, ' ') === false) {
+                $filter = Filter::matchAny();
+                foreach ($columns as $column) {
+                    $filter->addFilter(Filter::expression($column, '=', "*$search*"));
+                }
+            } else {
+                $filter = Filter::matchAll();
+                foreach (explode(' ', $search) as $s) {
+                    $sub = Filter::matchAny();
+                    foreach ($columns as $column) {
+                        $sub->addFilter(Filter::expression($column, '=', "*$s*"));
+                    }
+                    $filter->addFilter($sub);
+                }
+            }
+
+            FilterRenderer::applyToQuery($filter, $query);
+        }
+
+        return $this;
+    }
+
+    abstract protected function prepareQuery();
+
+    public function renderContent()
+    {
+        $this->header();
+        $this->fetchRows();
+
+        return parent::renderContent();
+    }
+
+    protected function fetchRows()
+    {
+        $body = $this->body();
+        foreach ($this->fetch() as $row) {
+            $body->add($this->renderRow($row));
+        }
+    }
+
+    public function fetch()
+    {
+        return $this->db->fetchAll(
+            $this->getQuery()
+        );
+    }
+
+    public function connection()
+    {
+        return $this->connection;
+    }
+
+    public function db()
+    {
+        return $this->db;
+    }
+
+    /**
+     * @return \Zend_Db_Select
+     */
+    public function getQuery()
+    {
+        if ($this->query === null) {
+            $this->query = $this->prepareQuery();
+        }
+
+        return $this->query;
+    }
+
+    public function dumpSqlQuery(Url $url)
+    {
+        $self = $this;
+        return Container::create(['class' => 'sql-dump'], [
+            Link::create('[ close ]', $url->without('format')),
+            Html::tag('h3', null, $this->translate('SQL Query')),
+            Html::tag('pre', null, new DeferredText(
+                function () use ($self) {
+                    return wordwrap($self->getQuery());
+                }
+            )),
+            Html::tag('h3', null, $this->translate('Count Query')),
+            Html::tag('pre', null, new DeferredText(
+                function () use ($self) {
+                    return wordwrap($self->getCountQuery());
+                }
+            )),
+        ]);
+    }
+
+    public static function show(ControlsAndContent $controller, Db $db)
+    {
+        $table = new static($db);
+        $table->renderTo($controller);
+    }
+
+    protected function initializeOptionalQuickSearch(ControlsAndContent $controller)
+    {
+        $columns = $this->getSearchColumns();
+        if (! empty($columns)) {
+            $this->search(
+                $this->getQuickSearch(
+                    $controller->controls(),
+                    $controller->url()
+                )
+            );
+        }
+    }
+
+    public function renderTo(ControlsAndContent $controller)
+    {
+        $url = $controller->url();
+        $this->initializeOptionalQuickSearch($controller);
+        $controller->content()->add([
+            $this->getPaginator($url),
+            $this
+        ]);
+
+        if ($url->getParam('format') === 'sql') {
+            $controller->content()->prepend($this->dumpSqlQuery($url));
+        }
+    }
+}