container improvements

Author: arrilot

spec/Arrilot/Widgets/Factories/WidgetFactorySpec.php

@@ -7,6 +7,7 @@
 use App\Widgets\TestDefaultSlider;
 use App\Widgets\TestMyClass;
 use App\Widgets\TestRepeatableFeed;
+use App\Widgets\TestWidgetWithCustomContainer;
 use App\Widgets\TestWidgetWithDIInRun;
 use App\Widgets\TestWidgetWithParamsInRun;
 use Arrilot\Widgets\Misc\LaravelApplicationWrapper;
@@ -178,7 +179,7 @@ public function it_can_run_multiple_widgets(LaravelApplicationWrapper $wrapper)
             );
     }
 
-    public function it_can_run_async_widget(LaravelApplicationWrapper $wrapper)
+    public function it_can_run_reloadable_widget(LaravelApplicationWrapper $wrapper)
     {
         $config = [];
         $params = [$config];
@@ -196,6 +197,24 @@ public function it_can_run_async_widget(LaravelApplicationWrapper $wrapper)
             );
     }
 
+    public function it_can_run_widget_with_custom_container(LaravelApplicationWrapper $wrapper)
+    {
+        $config = [];
+        $params = [$config];
+
+        $wrapper->csrf_token()->willReturn('token_stub');
+        $wrapper->call(Argument::any(), Argument::any())->willReturn(
+            call_user_func_array([new TestWidgetWithCustomContainer([]), 'run'], [])
+        );
+
+        $this->testWidgetWithCustomContainer($config)
+            ->shouldReturn(
+                '<p id="arrilot-widget-container-1" data-id="123">Dummy Content'.
+                '<script type="text/javascript">setTimeout( function() { $(\'#arrilot-widget-container-1\').load(\'/arrilot/load-widget\', '.$this->mockProduceJavascriptData('TestWidgetWithCustomContainer', $params).') }, 10000)</script>'.
+                '</p>'
+            );
+    }
+
     public function it_can_cache_widgets(LaravelApplicationWrapper $wrapper)
     {
         $wrapper->call(Argument::any(), Argument::any())->willReturn(

spec/Dummies/TestWidgetWithCustomContainer.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Widgets;
+
+use Arrilot\Widgets\AbstractWidget;
+
+class TestWidgetWithCustomContainer extends AbstractWidget
+{
+    public $reloadTimeout = 10;
+
+    public function run()
+    {
+        return 'Dummy Content';
+    }
+
+    public function placeholder()
+    {
+        return 'Placeholder here!';
+    }
+
+    /**
+     * Async and reloadable widgets are wrapped in container.
+     * You can customize it by overwriting this method.
+     *
+     * @return array
+     */
+    public function container()
+    {
+        return [
+            'element'       => 'p',
+            'attributes'    => 'data-id="123"',
+        ];
+    }
+}

spec/Dummies/TestWidgetWithCustomCssClass.php

@@ -6,10 +6,11 @@ abstract class AbstractWidget
 {
     /**
      * The number of seconds before each reload.
+     * False means no reload at all.
      *
-     * @var int|float
+     * @var int|float|bool
      */
-    public $reloadTimeout;
+    public $reloadTimeout = false;
 
     /**
      * The number of minutes before cache expires.
@@ -19,14 +20,6 @@ abstract class AbstractWidget
      */
     public $cacheTime = false;
 
-    /**
-     * The css class or classes that are applied to a special container (div)
-     * that wraps all widget content.
-     *
-     * @var string
-     */
-    public $cssClassForWrapper = 'arrilot-widget-container';
-
     /**
      * Constructor.
      *
@@ -45,6 +38,7 @@ public function __construct($config)
 
     /**
      * Placeholder for async widget.
+     * You can customize it by overwriting this method.
      *
      * @return string
      */
@@ -53,6 +47,20 @@ public function placeholder()
         return '';
     }
 
+    /**
+     * Async and reloadable widgets are wrapped in container.
+     * You can customize it by overwriting this method.
+     *
+     * @return array
+     */
+    public function container()
+    {
+        return [
+            'element'       => 'div',
+            'attributes'    => 'style="display:inline" class="arrilot-widget-container"',
+        ];
+    }
+
     /**
      * Cache key that is used if caching is enabled.
      *

src/AbstractWidget.php

@@ -165,6 +165,11 @@ protected function wrapContentInContainer($content)
             return $content;
         }
 
-        return '<div id="'.$this->javascriptFactory->getContainerId().'" style="display:inline" class="'.$this->widget->cssClassForWrapper.'">'.$content.'</div>';
+        $container = $this->widget->container();
+        if (empty($container['element'])) {
+            $container['element'] = 'div';
+        }
+
+        return '<'.$container['element'].' id="'.$this->javascriptFactory->getContainerId().'" '.$container['attributes'].'>'.$content.'</'.$container['element'].'>';
     }
 }

src/Factories/AbstractWidgetFactory.php

@@ -34,6 +34,7 @@ public function run()
 
         if ($timeout = $this->getReloadTimeout()) {
             $content .= $this->javascriptFactory->getReloader($timeout);
+
             return $this->wrapContentInContainer($content);
         }