BookStack Code Mirror - bookstack/blob - app/Activity/Models/Tag.php

   1 <?php
   2
   3 namespace BookStack\Activity\Models;
   4
   5 use BookStack\App\Model;
   6 use BookStack\Permissions\Models\JointPermission;
   7 use Illuminate\Database\Eloquent\Factories\HasFactory;
   8 use Illuminate\Database\Eloquent\Relations\HasMany;
   9 use Illuminate\Database\Eloquent\Relations\MorphTo;
  10
  11 /**
  12  * @property int    $id
  13  * @property string $name
  14  * @property string $value
  15  * @property int    $entity_id
  16  * @property string $entity_type
  17  * @property int    $order
  18  */
  19 class Tag extends Model
  20 {
  21     use HasFactory;
  22
  23     protected $fillable = ['name', 'value', 'order'];
  24     protected $hidden = ['id', 'entity_id', 'entity_type', 'created_at', 'updated_at'];
  25
  26     /**
  27      * Get the entity that this tag belongs to.
  28      */
  29     public function entity(): MorphTo
  30     {
  31         return $this->morphTo('entity');
  32     }
  33
  34     public function jointPermissions(): HasMany
  35     {
  36         return $this->hasMany(JointPermission::class, 'entity_id', 'entity_id')
  37             ->whereColumn('tags.entity_type', '=', 'joint_permissions.entity_type');
  38     }
  39
  40     /**
  41      * Get a full URL to start a tag name search for this tag name.
  42      */
  43     public function nameUrl(): string
  44     {
  45         return url('/search?term=%5B' . urlencode($this->name) . '%5D');
  46     }
  47
  48     /**
  49      * Get a full URL to start a tag name and value search for this tag's values.
  50      */
  51     public function valueUrl(): string
  52     {
  53         return url('/search?term=%5B' . urlencode($this->name) . '%3D' . urlencode($this->value) . '%5D');
  54     }
  55 }