mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-11-26 02:10:19 +08:00
a042e22481
Removed some common functions from other entities. Aligned implementation of getUrl() Cleaned phpdocs and added typehinting. Also extracted sibling search logic out of controller.
92 lines
1.9 KiB
PHP
92 lines
1.9 KiB
PHP
<?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
|
|
{
|
|
|
|
/**
|
|
* @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 [string => 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;
|
|
}
|
|
}
|