Skip intermediate login page with single provider

[bookstack] / app / Entities / Models / Entity.php

diff --git a/app/Entities/Models/Entity.php b/app/Entities/Models/Entity.php
index 5618767693b34311ee6057fae86dde062a1192e0..7ad78f1d1475d03c6131146335949bb29b29be82 100644 (file)
--- a/app/Entities/Models/Entity.php
+++ b/app/Entities/Models/Entity.php
@@ -1,4 +1,6 @@
-<?php namespace BookStack\Entities\Models;
+<?php
+
+namespace BookStack\Entities\Models;

 
 use BookStack\Actions\Activity;
 use BookStack\Actions\Comment;
 
 use BookStack\Actions\Activity;
 use BookStack\Actions\Comment;


@@ -10,7 +12,9 @@ use BookStack\Auth\Permissions\JointPermission;
 use BookStack\Entities\Tools\SearchIndex;
 use BookStack\Entities\Tools\SlugGenerator;
 use BookStack\Facades\Permissions;
 use BookStack\Entities\Tools\SearchIndex;
 use BookStack\Entities\Tools\SlugGenerator;
 use BookStack\Facades\Permissions;

+use BookStack\Interfaces\Deletable;

 use BookStack\Interfaces\Favouritable;
 use BookStack\Interfaces\Favouritable;

+use BookStack\Interfaces\Loggable;

 use BookStack\Interfaces\Sluggable;
 use BookStack\Interfaces\Viewable;
 use BookStack\Model;
 use BookStack\Interfaces\Sluggable;
 use BookStack\Interfaces\Viewable;
 use BookStack\Model;


@@ -27,21 +31,23 @@ use Illuminate\Database\Eloquent\SoftDeletes;
  * The base class for book-like items such as pages, chapters & books.
  * This is not a database model in itself but extended.
  *
  * The base class for book-like items such as pages, chapters & books.
  * This is not a database model in itself but extended.
  *

- * @property int $id
- * @property string $name
- * @property string $slug
- * @property Carbon $created_at
- * @property Carbon $updated_at
- * @property int $created_by
- * @property int $updated_by
- * @property boolean $restricted
+ * @property int        $id
+ * @property string     $name
+ * @property string     $slug
+ * @property Carbon     $created_at
+ * @property Carbon     $updated_at
+ * @property Carbon     $deleted_at
+ * @property int        $created_by
+ * @property int        $updated_by
+ * @property bool       $restricted

  * @property Collection $tags
  * @property Collection $tags

+ *

  * @method static Entity|Builder visible()
  * @method static Entity|Builder hasPermission(string $permission)
  * @method static Builder withLastView()
  * @method static Builder withViewCount()
  */
  * @method static Entity|Builder visible()
  * @method static Entity|Builder hasPermission(string $permission)
  * @method static Builder withLastView()
  * @method static Builder withViewCount()
  */

-abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
+abstract class Entity extends Model implements Sluggable, Favouritable, Viewable, Deletable, Loggable

 {
     use SoftDeletes;
     use HasCreatorAndUpdater;
 {
     use SoftDeletes;
     use HasCreatorAndUpdater;


@@ -103,7 +109,7 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
      * Compares this entity to another given entity.
      * Matches by comparing class and id.
      */
      * Compares this entity to another given entity.
      * Matches by comparing class and id.
      */

-    public function matches(Entity $entity): bool
+    public function matches(self $entity): bool

     {
         return [get_class($this), $this->id] === [get_class($entity), $entity->id];
     }
     {
         return [get_class($this), $this->id] === [get_class($entity), $entity->id];
     }


@@ -111,17 +117,17 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
     /**
      * Checks if the current entity matches or contains the given.
      */
     /**
      * Checks if the current entity matches or contains the given.
      */

-    public function matchesOrContains(Entity $entity): bool
+    public function matchesOrContains(self $entity): bool

     {
         if ($this->matches($entity)) {
             return true;
         }
 
     {
         if ($this->matches($entity)) {
             return true;
         }
 

-        if (($entity->isA('chapter') || $entity->isA('page')) && $this->isA('book')) {
+        if (($entity instanceof BookChild) && $this instanceof Book) {

             return $entity->book_id === $this->id;
         }
 
             return $entity->book_id === $this->id;
         }
 

-        if ($entity->isA('page') && $this->isA('chapter')) {
+        if ($entity instanceof Page && $this instanceof Chapter) {

             return $entity->chapter_id === $this->id;
         }
 
             return $entity->chapter_id === $this->id;
         }
 


@@ -154,11 +160,12 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
     }
 
     /**
     }
 
     /**

-     * Get the comments for an entity
+     * Get the comments for an entity.

      */
     public function comments(bool $orderByCreated = true): MorphMany
     {
         $query = $this->morphMany(Comment::class, 'entity');
      */
     public function comments(bool $orderByCreated = true): MorphMany
     {
         $query = $this->morphMany(Comment::class, 'entity');

+

         return $orderByCreated ? $query->orderBy('created_at', 'asc') : $query;
     }
 
         return $orderByCreated ? $query->orderBy('created_at', 'asc') : $query;
     }
 


@@ -205,7 +212,9 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
 
     /**
      * Check if this instance or class is a certain type of entity.
 
     /**
      * Check if this instance or class is a certain type of entity.

-     * Examples of $type are 'page', 'book', 'chapter'
+     * Examples of $type are 'page', 'book', 'chapter'.
+     *
+     * @deprecated Use instanceof instead.

      */
     public static function isA(string $type): bool
     {
      */
     public static function isA(string $type): bool
     {


@@ -218,6 +227,7 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
     public static function getType(): string
     {
         $className = array_slice(explode('\\', static::class), -1, 1)[0];
     public static function getType(): string
     {
         $className = array_slice(explode('\\', static::class), -1, 1)[0];

+

         return strtolower($className);
     }
 
         return strtolower($className);
     }
 


@@ -229,15 +239,8 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
         if (mb_strlen($this->name) <= $length) {
             return $this->name;
         }
         if (mb_strlen($this->name) <= $length) {
             return $this->name;
         }

-        return mb_substr($this->name, 0, $length - 3) . '...';
-    }

 
 

-    /**
-     * Get the body text of this entity.
-     */
-    public function getText(): string
-    {
-        return $this->{$this->textField} ?? '';
+        return mb_substr($this->name, 0, $length - 3) . '...';

     }
 
     /**
     }
 
     /**


@@ -245,17 +248,17 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
      */
     public function getExcerpt(int $length = 100): string
     {
      */
     public function getExcerpt(int $length = 100): string
     {

-        $text = $this->getText();
+        $text = $this->{$this->textField} ?? '';

 
         if (mb_strlen($text) > $length) {
 
         if (mb_strlen($text) > $length) {

-            $text = mb_substr($text, 0, $length-3) . '...';
+            $text = mb_substr($text, 0, $length - 3) . '...';

         }
 
         return trim($text);
     }
 
     /**
         }
 
         return trim($text);
     }
 
     /**

-     * Get the url of this entity
+     * Get the url of this entity.

      */
     abstract public function getUrl(string $path = '/'): string;
 
      */
     abstract public function getUrl(string $path = '/'): string;
 


@@ -264,14 +267,15 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
      * This is the "static" parent and does not include dynamic
      * relations such as shelves to books.
      */
      * This is the "static" parent and does not include dynamic
      * relations such as shelves to books.
      */

-    public function getParent(): ?Entity
+    public function getParent(): ?self

     {
     {

-        if ($this->isA('page')) {
+        if ($this instanceof Page) {

             return $this->chapter_id ? $this->chapter()->withTrashed()->first() : $this->book()->withTrashed()->first();
         }
             return $this->chapter_id ? $this->chapter()->withTrashed()->first() : $this->book()->withTrashed()->first();
         }

-        if ($this->isA('chapter')) {
+        if ($this instanceof Chapter) {

             return $this->book()->withTrashed()->first();
         }
             return $this->book()->withTrashed()->first();
         }

+

         return null;
     }
 
         return null;
     }
 


@@ -285,7 +289,7 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
     }
 
     /**
     }
 
     /**

-     * Index the current entity for search
+     * Index the current entity for search.

      */
     public function indexForSearch()
     {
      */
     public function indexForSearch()
     {


@@ -293,16 +297,17 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
     }
 
     /**
     }
 
     /**

-     * @inheritdoc
+     * {@inheritdoc}

      */
     public function refreshSlug(): string
     {
         $this->slug = app(SlugGenerator::class)->generate($this);
      */
     public function refreshSlug(): string
     {
         $this->slug = app(SlugGenerator::class)->generate($this);

+

         return $this->slug;
     }
 
     /**
         return $this->slug;
     }
 
     /**

-     * @inheritdoc
+     * {@inheritdoc}

      */
     public function favourites(): MorphMany
     {
      */
     public function favourites(): MorphMany
     {


@@ -318,4 +323,12 @@ abstract class Entity extends Model implements Sluggable, Favouritable, Viewable
             ->where('user_id', '=', user()->id)
             ->exists();
     }
             ->where('user_id', '=', user()->id)
             ->exists();
     }

+
+    /**
+     * {@inheritdoc}
+     */
+    public function logDescriptor(): string
+    {
+        return "({$this->id}) {$this->name}";
+    }

 }
 }