Initial commit

kirby/src/Cms/Layout.php

@@ -0,0 +1,127 @@
+<?php
+
+namespace Kirby\Cms;
+
+/**
+ * Represents a single Layout with
+ * multiple columns
+ * @since 3.5.0
+ *
+ * @package   Kirby Cms
+ * @author    Bastian Allgeier <bastian@getkirby.com>
+ * @link      https://getkirby.com
+ * @copyright Bastian Allgeier
+ * @license   https://getkirby.com/license
+ */
+class Layout extends Item
+{
+    use HasMethods;
+
+    public const ITEMS_CLASS = '\Kirby\Cms\Layouts';
+
+    /**
+     * @var \Kirby\Cms\Content
+     */
+    protected $attrs;
+
+    /**
+     * @var \Kirby\Cms\LayoutColumns
+     */
+    protected $columns;
+
+    /**
+     * Proxy for attrs
+     *
+     * @param string $method
+     * @param array $args
+     * @return \Kirby\Cms\Field
+     */
+    public function __call(string $method, array $args = [])
+    {
+        // layout methods
+        if ($this->hasMethod($method) === true) {
+            return $this->callMethod($method, $args);
+        }
+
+        return $this->attrs()->get($method);
+    }
+
+    /**
+     * Creates a new Layout object
+     *
+     * @param array $params
+     */
+    public function __construct(array $params = [])
+    {
+        parent::__construct($params);
+
+        $this->columns = LayoutColumns::factory($params['columns'] ?? [], [
+            'parent' => $this->parent
+        ]);
+
+        // create the attrs object
+        $this->attrs = new Content($params['attrs'] ?? [], $this->parent);
+    }
+
+    /**
+     * Returns the attrs object
+     *
+     * @return \Kirby\Cms\Content
+     */
+    public function attrs()
+    {
+        return $this->attrs;
+    }
+
+    /**
+     * Returns the columns in this layout
+     *
+     * @return \Kirby\Cms\LayoutColumns
+     */
+    public function columns()
+    {
+        return $this->columns;
+    }
+
+    /**
+     * Checks if the layout is empty
+     * @since 3.5.2
+     *
+     * @return bool
+     */
+    public function isEmpty(): bool
+    {
+        return $this
+            ->columns()
+            ->filter(function ($column) {
+                return $column->isNotEmpty();
+            })
+            ->count() === 0;
+    }
+
+    /**
+     * Checks if the layout is not empty
+     * @since 3.5.2
+     *
+     * @return bool
+     */
+    public function isNotEmpty(): bool
+    {
+        return $this->isEmpty() === false;
+    }
+
+    /**
+     * The result is being sent to the editor
+     * via the API in the panel
+     *
+     * @return array
+     */
+    public function toArray(): array
+    {
+        return [
+            'attrs'   => $this->attrs()->toArray(),
+            'columns' => $this->columns()->toArray(),
+            'id'      => $this->id(),
+        ];
+    }
+}