Finally implementing Grid

demos/grid.php

@@ -0,0 +1,20 @@
+<?php
+
+require 'init.php';
+require 'database.php';
+
+$g = $layout->add(['Grid']);
+$g->setModel(new Country($db));
+$g->addQuickSearch();
+
+$g->menu->addItem(['Add Country', 'icon'=>'add square'], new \atk4\ui\jsExpression('alert(123)'));
+$g->menu->addItem(['Re-Import', 'icon'=>'power']);
+$g->menu->addItem(['Delete All', 'icon'=>'trash', 'red active']);
+
+$g->addAction('Say HI', new \atk4\ui\jsExpression('alert("hi")'));
+$g->addAction(['icon'=>'pencil'], new \atk4\ui\jsExpression('alert($(this).closest("tr").data("id"))'));
+
+$sel = $g->addSelection();
+$g->menu->addItem('show selection')->on('click', new \atk4\ui\jsExpression(
+    'alert("Selected: "+[].join(", "))', [$sel->jsChecked()]
+));

demos/init.php

@@ -22,7 +22,7 @@
     $form = $layout->leftMenu->addGroup(['Grid and Table', 'icon'=>'table']);
     $form->addItem('Data table with formatted columns', ['table']);
     $form->addItem('Table interractions', ['multitable']);
-    $form->addItem('Grid - Table+Bar+Search+Paginator', ['table']);
+    $form->addItem('Grid - Table+Bar+Search+Paginator', ['grid']);
     $form->addItem('Interactivity - Modals and Expanders', ['expander']);
 
     $basic = $layout->leftMenu->addGroup(['Basics', 'icon'=>'cubes']);

docs/misc.rst

@@ -127,7 +127,6 @@ Label has the following propetries:
 
 All the above can be string, array (passed to Icon, Image or View class) or an object.
 
-
 .. php:class:: HelloWorld
 
 HelloWorld

src/App.php

@@ -36,6 +36,11 @@ class App
 
     public $ui_persistence = null;
 
+    /**
+     * Constructor.
+     *
+     * @param array $defaults
+     */
     public function __construct($defaults = [])
     {
         // Process defaults
@@ -88,6 +93,11 @@ public function __construct($defaults = [])
         }
     }
 
+    /**
+     * Catch exception.
+     *
+     * @param mixed $exception
+     */
     public function caughtException($exception)
     {
         $l = new \atk4\ui\App();
@@ -107,6 +117,11 @@ public function caughtException($exception)
         $this->run_called = true;
     }
 
+    /**
+     * Outputs debug info.
+     *
+     * @param string $str
+     */
     public function outputDebug($str)
     {
         echo 'DEBUG:'.$str.'<br/>';
@@ -116,6 +131,8 @@ public function outputDebug($str)
      * Will perform a preemptive output and terminate. Do not use this
      * directly, instead call it form Callback, jsCallback or similar
      * other classes.
+     *
+     * @param string $output
      */
     public function terminate($output = null)
     {
@@ -124,6 +141,14 @@ public function terminate($output = null)
         exit;
     }
 
+    /**
+     * Initializes layout.
+     *
+     * @param string|Layout\Generic $layout
+     * @param array                 $options
+     *
+     * @return $this
+     */
     public function initLayout($layout, $options = [])
     {
         if (is_string($layout)) {
@@ -154,6 +179,14 @@ public function addStyle($style)
         $this->html->template->appendHTML('HEAD', $this->getTag('style', $style));
     }
 
+    /**
+     * Normalizes class name.
+     *
+     * @param string $name
+     * @param string $prefix
+     *
+     * @return string
+     */
     public function normalizeClassNameApp($name, $prefix = null)
     {
         if (strpos('/', $name) === false && strpos('\\', $name) === false) {
@@ -163,6 +196,11 @@ public function normalizeClassNameApp($name, $prefix = null)
         return $name;
     }
 
+    /**
+     * Create object and associate it with this app.
+     *
+     * @return object
+     */
     public function add()
     {
         if ($this->layout) {
@@ -180,6 +218,9 @@ public function add()
         }
     }
 
+    /**
+     * Runs app and echo rendered template.
+     */
     public function run()
     {
         $this->run_called = true;
@@ -201,6 +242,13 @@ public function init()
         $this->_init();
     }
 
+    /**
+     * Load template.
+     *
+     * @param string $name
+     *
+     * @return Template
+     */
     public function loadTemplate($name)
     {
         $template = new Template();
@@ -297,20 +345,49 @@ public function url($args = [])
      * 10. pass array as text to net tags (array must contain 1 to 3 elements corresponding to arguments):
      * getTag('a', ['href'=>'foo.html'], ['b','click here']);
      * --> <a href="foo.html"><b>click here</b></a>
+     *
+     * @param string|array $tag
+     * @param string       $attr
+     * @param string|array $value
+     *
+     * @return string
      */
     public function getTag($tag = null, $attr = null, $value = null)
     {
         if ($tag === null) {
             $tag = 'div';
         } elseif (is_array($tag)) {
-            $value = $attr;
-            $attr = $tag;
+            $tmp = $tag;
+
             $tag = 'div';
+            $value = '';
+
+            if (isset($tmp[0])) {
+                $tag = $tmp[0];
+                unset($tmp[0]);
+            }
+
+            if (isset($tmp[1])) {
+                $value = $tmp[1];
+                unset($tmp[1]);
+            }
+
+            $attr = $tmp;
+        }
+        if ($tag[0] === '<') {
+            return $tag;
         }
         if (is_string($attr)) {
             $value = $attr;
             $attr = null;
         }
+
+        if (is_string($value)) {
+            $value = $this->encodeHTML($value);
+        } elseif (is_array($value)) {
+            $value = $this->getTag($value);
+        }
+
         if (!$attr) {
             return "<$tag>".($value ? ($value)."</$tag>" : '');
         }

src/Button.php

@@ -70,24 +70,4 @@ public function renderView()
 
         parent::renderView();
     }
-
-    /**
-     * Makes button into a "<a>" element with a link.
-     *
-     * @param string $url
-     *
-     * @return $this
-     */
-    public function link($url)
-    {
-        $this->element = 'a';
-        if (is_string($url)) {
-            $this->setAttr('href', $url);
-
-            return $this;
-        }
-        $this->setAttr('href', $this->app->url($url));
-
-        return $this;
-    }
 }

src/Grid.php

@@ -0,0 +1,82 @@
+<?php
+
+// vim:ts=4:sw=4:et:fdm=marker:fdl=0
+
+namespace atk4\ui;
+
+/**
+ * Implements a more sophisticated and interractive Data-Table component.
+ */
+class Grid extends View
+{
+    public $menu = null;
+
+    public $quickSearch = null;
+
+    public $table = null;
+
+    public $buttons = null;
+
+    public $actions = null;
+
+    public $defaultTemplate = 'grid.html';
+
+    public $ipp = 20;
+
+    public $paginator = null;
+
+    public $selection = null;
+
+    public function init()
+    {
+        parent::init();
+
+        if (!$this->menu) {
+            $this->menu = $this->add(['Menu', 'activate_on_click'=>false], 'Menu');
+        }
+
+        if (!$this->table) {
+            $this->table = $this->add(['Table', 'very compact'], 'Table');
+        }
+    }
+
+    public function addButton($text)
+    {
+        return $this->menu->addItem()->add(new Button($text));
+    }
+
+    public function addQuickSearch($fields = [])
+    {
+        if (!$fields) {
+            $fields = [$this->model->title_field];
+        }
+
+        $x = $this->menu->addMenuRight();
+        $this->quickSearch = $x->addItem()->setElement('div')->add(new \atk4\ui\FormField\Input(['placeholder'=>'Search', 'icon'=>'search']))->addClass('transparent');
+    }
+
+    public function addAction($label, $action)
+    {
+        if (!$this->actions) {
+            $this->actions = $this->table->addColumn('TableColumn/Actions');
+        }
+
+        $this->actions->addAction($label, $action);
+    }
+
+    public function setModel(\atk4\data\Model $model, $columns = null)
+    {
+        return $this->model = $this->table->setModel($model, $columns)->setLimit($this->ipp);
+    }
+
+    public function addSelection()
+    {
+        $this->selection = $this->table->addColumn('TableColumn/Checkbox');
+
+        // Move element to the beginning
+        $k = array_search($this->selection, $this->table->columns);
+        $this->table->columns = [$k => $this->table->columns[$k]] + $this->table->columns;
+
+        return $this->selection;
+    }
+}

src/Menu.php

@@ -17,11 +17,16 @@ class Menu extends View
 
     public function addItem($name = null, $action = null)
     {
-        $item = $this->add(new Item(['element'=>'a']));
-        if (!is_null($name)) {
-            $item->set($name);
+        if (is_object($name)) {
+            $item = $name;
+        } elseif ($name) {
+            $item = new Item($name);
+        } else {
+            $item = new Item();
         }
 
+        $item = $this->add($item)->setElement('a');
+
         if (is_array($action)) {
             $action = $this->app->url($action);
         }
@@ -30,6 +35,10 @@ public function addItem($name = null, $action = null)
             $item->setAttr('href', $action);
         }
 
+        if ($action instanceof jsExpressionable) {
+            $item->js('click', $action);
+        }
+
         return $item;
     }
 
@@ -77,6 +86,14 @@ public function addGroup($title)
         return $group;
     }
 
+    public function addMenuRight()
+    {
+        $menu = $this->add(new self(), ['RightMenu', 'ui'=>false]);
+        $menu->removeClass('item')->addClass('right menu');
+
+        return $menu;
+    }
+
     public function add($object, $region = null)
     {
         $item = parent::add($object, $region);