Updated canInsert method & added isInsertable method on Layout

Author: toonvandenbos

src/Concerns/HasLayoutInstances.php

@@ -90,8 +90,10 @@ protected function canInsert(Layout $instance)
             return InstanceNotInsertableException::REASON_LIMIT;
         }
 
-        if(! is_null($limit = $instance->getLimit()) && ($limit <= $this->count($instance->getKey()))) {
-            return InstanceNotInsertableException::REASON_LAYOUT_LIMIT;
+        $code = $instance->isInsertable($this);
+
+        if(is_int($code) || $code === false) {
+            return $code ?: 0;
         }
 
         return true;

src/Contracts/Layout.php

@@ -2,6 +2,8 @@
 
 namespace Whitecube\LaravelFlexibleContent\Contracts;
 
+use Whitecube\LaravelFlexibleContent\Contracts\Flexible;
+
 interface Layout
 {
     /**
@@ -67,6 +69,15 @@ public function attributes(array $attributes, $syncOriginal = false) : Layout;
      */
     public function getAttributes();
 
+    /**
+     * Check if the current layout can be inserted in the provided flexible container.
+     * If not insertable, it is recommended to return an error code (int).
+     *
+     * @param \Whitecube\LaravelFlexibleContent\Contracts\Flexible $container
+     * @return bool|int
+     */
+    public function isInsertable(Flexible $container);
+
     /**
      * Create a layout instance from this layout.
      *

src/Layout.php

@@ -9,6 +9,8 @@
 use Illuminate\Database\Eloquent\Concerns\HasAttributes;
 use Illuminate\Database\Eloquent\Concerns\HidesAttributes;
 use Whitecube\LaravelFlexibleContent\Contracts\Layout as LayoutInterface;
+use Whitecube\LaravelFlexibleContent\Contracts\Flexible as FlexibleInterface;
+use Whitecube\LaravelFlexibleContent\Exceptions\InstanceNotInsertableException;
 
 class Layout implements LayoutInterface, ArrayAccess, JsonSerializable, Arrayable
 {
@@ -125,6 +127,22 @@ public function attributes(array $attributes, $syncOriginal = false): LayoutInte
         return $this;
     }
 
+    /**
+     * Check if the current layout can be inserted in the provided flexible container.
+     * If not insertable, it is recommended to return an error code (int).
+     *
+     * @param \Whitecube\LaravelFlexibleContent\Contracts\Flexible $container
+     * @return bool|int
+     */
+    public function isInsertable(FlexibleInterface $container)
+    {
+        if(! is_null($limit = $this->getLimit()) && ($limit <= $container->count($this->getKey()))) {
+            return InstanceNotInsertableException::REASON_LAYOUT_LIMIT;
+        }
+
+        return true;
+    }
+
     /**
      * Create a layout instance from this layout.
      *