mirror of
https://github.com/BookStackApp/BookStack.git
synced 2025-11-13 09:42:36 +03:00
4c7d6420ee
As per PR #5800 * DB: Planned out new entity table format via migrations * DB: Created entity migration logic Made some other tweaks/fixes while testing. * DB: Added change of entity relation columns to suit new entities table * DB: Got most view queries working for new structure * Entities: Started logic change to new structure Updated base entity class, and worked through BaseRepo. Need to go through other repos next. Removed a couple of redundant interfaces as part of this since we can move the logic onto the shared ContainerData model as needed. * Entities: Been through repos to update for new format * Entities: Updated repos to act on refreshed clones Changes to core entity models are now done on clones to ensure clean state before save, and those clones are returned back if changes are needed after that action. * Entities: Updated model classes & relations for changes * Entities: Changed from *Data to a common "contents" system Added smart loading from builder instances which should hydrate with "contents()" loaded via join, while keeping the core model original. * Entities: Moved entity description/covers to own non-model classes Added back some interfaces. * Entities: Removed use of contents system for data access * Entities: Got most queries back to working order * Entities: Reverted back to data from contents, fixed various issues * Entities: Started addressing issues from tests * Entities: Addressed further tests/issues * Entities: Been through tests to get all passing in dev Fixed issues and needed test changes along the way. * Entities: Addressed phpstan errors * Entities: Reviewed TODO notes * Entities: Ensured book/shelf relation data removed on destroy * Entities: Been through API responses & adjusted field visibility * Entities: Added type index to massively improve query speed
46 lines
1.3 KiB
PHP
46 lines
1.3 KiB
PHP
<?php
|
|
|
|
namespace BookStack\Entities\Queries;
|
|
|
|
use BookStack\Entities\Models\Entity;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
|
|
/**
|
|
* Interface for our classes which provide common queries for our
|
|
* entity objects. Ideally, all queries for entities should run through
|
|
* these classes.
|
|
* Any added methods should return a builder instances to allow extension
|
|
* via building on the query, unless the method starts with 'find'
|
|
* in which case an entity object should be returned.
|
|
* (nullable unless it's a *OrFail method).
|
|
*
|
|
* @template TModel of Entity
|
|
*/
|
|
interface ProvidesEntityQueries
|
|
{
|
|
/**
|
|
* Start a new query for this entity type.
|
|
* @return Builder<TModel>
|
|
*/
|
|
public function start(): Builder;
|
|
|
|
/**
|
|
* Find the entity of the given ID or return null if not found.
|
|
*/
|
|
public function findVisibleById(int $id): ?Entity;
|
|
|
|
/**
|
|
* Start a query for items that are visible, with selection
|
|
* configured for list display of this item.
|
|
* @return Builder<TModel>
|
|
*/
|
|
public function visibleForList(): Builder;
|
|
|
|
/**
|
|
* Start a query for items that are visible, with selection
|
|
* configured for using the content of the items found.
|
|
* @return Builder<TModel>
|
|
*/
|
|
public function visibleForContent(): Builder;
|
|
}
|