]> BookStack Code Mirror - bookstack/blobdiff - app/Entities/Queries/ProvidesEntityQueries.php
System CLI: Updated to 126de5599c state
[bookstack] / app / Entities / Queries / ProvidesEntityQueries.php
index 1033522447a602393d0dc6afa8798272a65033cc..611d0ae526bb24bd0804964818e05ae36076266d 100644 (file)
@@ -16,6 +16,19 @@ use Illuminate\Database\Eloquent\Builder;
  */
 interface ProvidesEntityQueries
 {
+    /**
+     * Start a new query for this entity type.
+     */
     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.
+     */
+    public function visibleForList(): Builder;
 }