Remove widgets

Author: root

README.md

@@ -334,7 +334,39 @@ Widget::group('sidebar')->wrap(function ($content, $index, $total) {
 })->...;
 ```
 
-### Checking the state of a widget group
+### Removing widgets from a group
+
+There is a couple of ways to remove widget/widgets from a group after they've been already added.
+
+1) Remove one widget by its unique `id`
+```php
+$id1 = Widget::group('sidebar')->addWidget('files');
+$id2 = Widget::group('sidebar')->addAsyncWidget('files');
+Widget::group('sidebar')->removeById($id1); // There is only second widget in the group now
+```
+
+2) Remove all widgets with specific name
+```php
+Widget::group('sidebar')->addWidget('files');
+Widget::group('sidebar')->addAsyncWidget('files');
+Widget::group('sidebar')->removeByName('files'); // Widget group is empty now
+```
+
+3) Remove all widgets that are placed on a specific position.
+```php
+Widget::group('sidebar')->position(42)->addWidget('files');
+Widget::group('sidebar')->position(42)->addAsyncWidget('files');
+Widget::group('sidebar')->removeByPosition(42); // Widget group is empty now
+```
+
+4) Remove all widgets at once.
+```php
+Widget::group('sidebar')->addWidget('files');
+Widget::group('sidebar')->addAsyncWidget('files');
+Widget::group('sidebar')->removeAll(); // Widget group is empty now
+```
+
+### Checking the state of a group
 
 `Widget::group('sidebar')->isEmpty(); // bool`
 

src/WidgetGroup.php

@@ -45,11 +45,11 @@ class WidgetGroup
     protected $separator = '';
 
     /**
-     * The number of widgets in the group.
+     * Id that is going to be issued to the next widget when it's added to the group.
      *
      * @var int
      */
-    protected $count = 0;
+    protected $nextWidgetId = 1;
 
     /**
      * A callback that defines extra markup that wraps every widget in the group.
@@ -80,11 +80,13 @@ public function display()
 
         $output = '';
         $index = 0;
+        $count = $this->count();
+
         foreach ($this->widgets as $position => $widgets) {
             foreach ($widgets as $widget) {
-                $output .= $this->performWrap($this->displayWidget($widget), $index, $this->count);
+                $output .= $this->performWrap($this->displayWidget($widget), $index, $count);
                 $index++;
-                if ($this->count !== $index) {
+                if ($index !== $count) {
                     $output .= $this->separator;
                 }
             }
@@ -93,6 +95,59 @@ public function display()
         return $this->convertToViewExpression($output);
     }
 
+    /**
+     * Remove a widget by its id.
+     *
+     * @param int $id
+     */
+    public function removeById($id)
+    {
+        foreach ($this->widgets as $position => $widgets) {
+            foreach ($widgets as $i => $widget) {
+                if ($widget['id'] === $id) {
+                    unset($this->widgets[$position][$i]);
+                    return;
+                }
+            }
+        }
+    }
+
+    /**
+     * Remove all widgets with $name from the group.
+     *
+     * @param string $name
+     */
+    public function removeByName($name)
+    {
+        foreach ($this->widgets as $position => $widgets) {
+            foreach ($widgets as $i => $widget) {
+                if ($widget['arguments'][0] === $name) {
+                    unset($this->widgets[$position][$i]);
+                }
+            }
+        }
+    }
+
+    /**
+     * Remove all widgets from $position from the group.
+     *
+     * @param int|string $position
+     */
+    public function removeByPosition($position)
+    {
+        if (array_key_exists($position, $this->widgets)) {
+            unset($this->widgets[$position]);
+        }
+    }
+
+    /**
+     * Remove all widgets from the group.
+     */
+    public function removeAll()
+    {
+        $this->widgets = [];
+    }
+
     /**
      * Set widget position.
      *
@@ -112,15 +167,15 @@ public function position($position)
      */
     public function addWidget()
     {
-        $this->addWidgetWithType('sync', func_get_args());
+        return $this->addWidgetWithType('sync', func_get_args());
     }
 
     /**
      * Add an async widget to the group.
      */
     public function addAsyncWidget()
     {
-        $this->addWidgetWithType('async', func_get_args());
+        return $this->addWidgetWithType('async', func_get_args());
     }
 
     /**
@@ -195,27 +250,31 @@ public function count()
 
         return $count;
     }
-
+    
     /**
      * Add a widget with a given type to the array.
      *
      * @param string $type
-     * @param array  $arguments
+     * @param array $arguments
+     * @return int
      */
     protected function addWidgetWithType($type, array $arguments = [])
     {
         if (!isset($this->widgets[$this->position])) {
             $this->widgets[$this->position] = [];
         }
 
+        $id = $this->nextWidgetId;
         $this->widgets[$this->position][] = [
+            'id'        => $id,
             'arguments' => $arguments,
             'type'      => $type,
         ];
 
-        $this->count++;
-
         $this->resetPosition();
+        $this->nextWidgetId++;
+
+        return $id;
     }
 
     /**

tests/WidgetGroupTest.php

@@ -140,15 +140,64 @@ public function testCount()
         $this->assertSame(0, $this->widgetGroup->count());
 
         $this->widgetGroup->addWidget('Slider');
-
         $this->assertSame(1, $this->widgetGroup->count());
 
         $this->widgetGroup->position(50)->addWidget('Slider');
+        $this->assertSame(2, $this->widgetGroup->count());
 
+        $this->widgetGroup->position(50)->addWidget('Slider');
+        $this->assertSame(3, $this->widgetGroup->count());
+    }
+    
+    public function testRemoveById()
+    {
+        $id1 = $this->widgetGroup->addWidget('Slider');
+        $id2 = $this->widgetGroup->addWidget('Slider');
         $this->assertSame(2, $this->widgetGroup->count());
 
+        $this->widgetGroup->removeById($id1);
+        $this->assertSame(1, $this->widgetGroup->count());
+
+        $this->widgetGroup->removeById($id2);
+        $this->assertSame(0, $this->widgetGroup->count());
+    }
+
+    public function testRemoveByName()
+    {
+        $this->widgetGroup->addWidget('Slider');
+        $this->widgetGroup->addWidget('TestDefaultSlider');
+        $this->widgetGroup->addWidget('Slider');
+        $this->assertSame(3, $this->widgetGroup->count());
+
+        $this->widgetGroup->removeByName('Slider');
+        $this->assertSame(1, $this->widgetGroup->count());
+
+        $this->widgetGroup->removeByName('TestDefaultSlider');
+        $this->assertSame(0, $this->widgetGroup->count());
+    }
+
+    public function testRemoveByPosition()
+    {
+        $this->widgetGroup->position(60)->addWidget('Slider');
+        $this->widgetGroup->position(50)->addWidget('TestDefaultSlider');
         $this->widgetGroup->position(50)->addWidget('Slider');
+        $this->assertSame(3, $this->widgetGroup->count());
+
+        $this->widgetGroup->removeByPosition(50);
+        $this->assertSame(1, $this->widgetGroup->count());
 
+        $this->widgetGroup->removeByPosition(60);
+        $this->assertSame(0, $this->widgetGroup->count());
+    }
+
+    public function testRemoveAll()
+    {
+        $this->widgetGroup->addWidget('Slider');
+        $this->widgetGroup->addWidget('TestDefaultSlider');
+        $this->widgetGroup->addWidget('Slider');
         $this->assertSame(3, $this->widgetGroup->count());
+
+        $this->widgetGroup->removeAll();
+        $this->assertSame(0, $this->widgetGroup->count());
     }
 }