mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-11-23 03:44:30 +08:00
37bf7f11e4
- Also showed entity path in search. - Cleaned popular entity fetch logic. - Cleaned entity selector JS code a little
107 lines
2.2 KiB
PHP
107 lines
2.2 KiB
PHP
<?php namespace BookStack\Entities;
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @package BookStack\Entities
|
|
*/
|
|
class EntityProvider
|
|
{
|
|
|
|
/**
|
|
* @var Bookshelf
|
|
*/
|
|
public $bookshelf;
|
|
|
|
/**
|
|
* @var Book
|
|
*/
|
|
public $book;
|
|
|
|
/**
|
|
* @var Chapter
|
|
*/
|
|
public $chapter;
|
|
|
|
/**
|
|
* @var Page
|
|
*/
|
|
public $page;
|
|
|
|
/**
|
|
* @var PageRevision
|
|
*/
|
|
public $pageRevision;
|
|
|
|
/**
|
|
* EntityProvider constructor.
|
|
* @param Bookshelf $bookshelf
|
|
* @param Book $book
|
|
* @param Chapter $chapter
|
|
* @param Page $page
|
|
* @param PageRevision $pageRevision
|
|
*/
|
|
public function __construct(
|
|
Bookshelf $bookshelf,
|
|
Book $book,
|
|
Chapter $chapter,
|
|
Page $page,
|
|
PageRevision $pageRevision
|
|
) {
|
|
$this->bookshelf = $bookshelf;
|
|
$this->book = $book;
|
|
$this->chapter = $chapter;
|
|
$this->page = $page;
|
|
$this->pageRevision = $pageRevision;
|
|
}
|
|
|
|
/**
|
|
* Fetch all core entity types as an associated array
|
|
* with their basic names as the keys.
|
|
* @return Entity[]
|
|
*/
|
|
public function all()
|
|
{
|
|
return [
|
|
'bookshelf' => $this->bookshelf,
|
|
'book' => $this->book,
|
|
'chapter' => $this->chapter,
|
|
'page' => $this->page,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Get an entity instance by it's basic name.
|
|
* @param string $type
|
|
* @return Entity
|
|
*/
|
|
public function get(string $type)
|
|
{
|
|
$type = strtolower($type);
|
|
return $this->all()[$type];
|
|
}
|
|
|
|
/**
|
|
* Get the morph classes, as an array, for a single or multiple types.
|
|
* @param string|array $types
|
|
* @return array<string>
|
|
*/
|
|
public function getMorphClasses($types)
|
|
{
|
|
if (is_string($types)) {
|
|
$types = [$types];
|
|
}
|
|
|
|
$morphClasses = [];
|
|
foreach ($types as $type) {
|
|
$model = $this->get($type);
|
|
$morphClasses[] = $model->getMorphClass();
|
|
}
|
|
return $morphClasses;
|
|
}
|
|
}
|