first version

kirby/src/Cms/Collections.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace Kirby\Cms;
+
+use Closure;
+use Kirby\Exception\NotFoundException;
+use Kirby\Toolkit\Controller;
+
+/**
+ * Manages and loads all collections
+ * in site/collections, which can then
+ * be reused in controllers, templates, etc
+ *
+ * This class is mainly used in the `$kirby->collection()`
+ * method to provide easy access to registered collections
+ *
+ * @package   Kirby Cms
+ * @author    Bastian Allgeier <bastian@getkirby.com>
+ * @link      http://getkirby.com
+ * @copyright Bastian Allgeier
+ */
+class Collections
+{
+
+    /**
+     * Each collection is cached once it
+     * has been called, to avoid further
+     * processing on sequential calls to
+     * the same collection.
+     *
+     * @var array
+     */
+    protected $cache = [];
+
+    /**
+     * Store of all collections
+     *
+     * @var array
+     */
+    protected $collections = [];
+
+    /**
+     * Magic caller to enable something like
+     * `$collections->myCollection()`
+     *
+     * @param  string $name
+     * @param  array $arguments
+     * @return Collection|null
+     */
+    public function __call(string $name, array $arguments = [])
+    {
+        return $this->get($name, ...$arguments);
+    }
+
+    /**
+     * Creates a new Collections set
+     *
+     * @param array $collections
+     */
+    public function __construct(array $collections = [])
+    {
+        $this->collections = $collections;
+    }
+
+    /**
+     * Loads a collection by name if registered
+     *
+     * @param string $name
+     * @param array $data
+     * @return Collection|null
+     */
+    public function get(string $name, array $data = [])
+    {
+        if (isset($this->cache[$name]) === true) {
+            return $this->cache[$name];
+        }
+
+        if (isset($this->collections[$name]) === false) {
+            return null;
+        }
+
+        $controller = new Controller($this->collections[$name]);
+
+        return $this->cache[$name] = $controller->call(null, $data);
+    }
+
+    /**
+     * Checks if a collection exists
+     *
+     * @param string $name
+     * @return boolean
+     */
+    public function has(string $name): bool
+    {
+        return isset($this->collections[$name]) === true;
+    }
+
+    /**
+     * Loads collections from php files in a
+     * given directory.
+     *
+     * @param  string $root
+     * @return self
+     */
+    public static function load(App $app): self
+    {
+        $collections = $app->extensions('collections');
+        $root        = $app->root('collections');
+
+        foreach (glob($root . '/*.php') as $file) {
+            $collection = require $file;
+
+            if (is_a($collection, 'Closure')) {
+                $name = pathinfo($file, PATHINFO_FILENAME);
+                $collections[$name] = $collection;
+            }
+        }
+
+        return new static($collections);
+    }
+}