Added test for logical-theme-system command registration

[bookstack] / app / Entities / EntityProvider.php

diff --git a/app/Entities/EntityProvider.php b/app/Entities/EntityProvider.php
index 51e3ad06009d0df58a4549e991b94f92cb970720..aaf392c7b2782b7f54199d4d7398ce8a3059c7d8 100644 (file)
--- a/app/Entities/EntityProvider.php
+++ b/app/Entities/EntityProvider.php
@@ -1,7 +1,94 @@
-<?php namespace BookStack\Entities;
+<?php
 
+namespace BookStack\Entities;
 
+use BookStack\Entities\Models\Book;
+use BookStack\Entities\Models\Bookshelf;
+use BookStack\Entities\Models\Chapter;
+use BookStack\Entities\Models\Entity;
+use BookStack\Entities\Models\Page;
+use BookStack\Entities\Models\PageRevision;
+
+/**
+ * Class EntityProvider.
+ *
+ * Provides access to the core entity models.
+ * Wrapped up in this provider since they are often used together
+ * so this is a neater alternative to injecting all in individually.
+ */
 class EntityProvider
 {
-    // TODO -
-}
\ No newline at end of file
+    /**
+     * @var Bookshelf
+     */
+    public $bookshelf;
+
+    /**
+     * @var Book
+     */
+    public $book;
+
+    /**
+     * @var Chapter
+     */
+    public $chapter;
+
+    /**
+     * @var Page
+     */
+    public $page;
+
+    /**
+     * @var PageRevision
+     */
+    public $pageRevision;
+
+    public function __construct()
+    {
+        $this->bookshelf = new Bookshelf();
+        $this->book = new Book();
+        $this->chapter = new Chapter();
+        $this->page = new Page();
+        $this->pageRevision = new PageRevision();
+    }
+
+    /**
+     * Fetch all core entity types as an associated array
+     * with their basic names as the keys.
+     *
+     * @return array<Entity>
+     */
+    public function all(): array
+    {
+        return [
+            'bookshelf' => $this->bookshelf,
+            'book'      => $this->book,
+            'chapter'   => $this->chapter,
+            'page'      => $this->page,
+        ];
+    }
+
+    /**
+     * Get an entity instance by it's basic name.
+     */
+    public function get(string $type): Entity
+    {
+        $type = strtolower($type);
+
+        return $this->all()[$type];
+    }
+
+    /**
+     * Get the morph classes, as an array, for a single or multiple types.
+     */
+    public function getMorphClasses(array $types): array
+    {
+        $morphClasses = [];
+        foreach ($types as $type) {
+            $model = $this->get($type);
+            $morphClasses[] = $model->getMorphClass();
+        }
+
+        return $morphClasses;
+    }
+}