817581aa0c
- Adds filtering to the watched items list in notification preferences so that deleted (recycle bin) items are removed via query. - Adds relations and logic to properly remove watches upon user and entity delete events, to old watches in database do not linger. - Adds testing to cover the above. Did not add migration for existing data, since patch will be close to introduction, and lingering DB entries don't open a security concern, just some potential confusion in specific potential scenarios. Probably not work extra migration risk, although could add in future if concerns/issues are found. Related to #4499
80 lines
2 KiB
PHP
80 lines
2 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
|
|
{
|
|
public Bookshelf $bookshelf;
|
|
public Book $book;
|
|
public Chapter $chapter;
|
|
public Page $page;
|
|
public PageRevision $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<string, Entity>
|
|
*/
|
|
public function all(): array
|
|
{
|
|
return [
|
|
'bookshelf' => $this->bookshelf,
|
|
'book' => $this->book,
|
|
'chapter' => $this->chapter,
|
|
'page' => $this->page,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Get an entity instance by its basic name.
|
|
*/
|
|
public function get(string $type): Entity
|
|
{
|
|
$type = strtolower($type);
|
|
$instance = $this->all()[$type] ?? null;
|
|
|
|
if (is_null($instance)) {
|
|
throw new \InvalidArgumentException("Provided type \"{$type}\" is not a valid entity type");
|
|
}
|
|
|
|
return $instance;
|
|
}
|
|
|
|
/**
|
|
* 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;
|
|
}
|
|
}
|