]> BookStack Code Mirror - bookstack/blobdiff - app/Entities/Queries/ProvidesEntityQueries.php
TypeScript: Updated compile target, addressed issues
[bookstack] / app / Entities / Queries / ProvidesEntityQueries.php
index ea83d6cdd57f79b3d5b9afd6151ac49c7cb11d7d..611d0ae526bb24bd0804964818e05ae36076266d 100644 (file)
@@ -2,7 +2,7 @@
 
 namespace BookStack\Entities\Queries;
 
-use BookStack\App\Model;
+use BookStack\Entities\Models\Entity;
 use Illuminate\Database\Eloquent\Builder;
 
 /**
@@ -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;
 }