BookStack Code Mirror - bookstack/blob - app/Repos/TagRepo.php

   1 <?php namespace BookStack\Repos;
   2
   3 use BookStack\Tag;
   4 use BookStack\Entity;
   5 use BookStack\Services\PermissionService;
   6
   7 /**
   8  * Class TagRepo
   9  * @package BookStack\Repos
  10  */
  11 class TagRepo
  12 {
  13
  14     protected $tag;
  15     protected $entity;
  16     protected $permissionService;
  17
  18     /**
  19      * TagRepo constructor.
  20      * @param Tag $attr
  21      * @param Entity $ent
  22      * @param PermissionService $ps
  23      */
  24     public function __construct(Tag $attr, Entity $ent, PermissionService $ps)
  25     {
  26         $this->tag = $attr;
  27         $this->entity = $ent;
  28         $this->permissionService = $ps;
  29     }
  30
  31     /**
  32      * Get an entity instance of its particular type.
  33      * @param $entityType
  34      * @param $entityId
  35      * @param string $action
  36      */
  37     public function getEntity($entityType, $entityId, $action = 'view')
  38     {
  39         $entityInstance = $this->entity->getEntityInstance($entityType);
  40         $searchQuery = $entityInstance->where('id', '=', $entityId)->with('tags');
  41         $searchQuery = $this->permissionService->enforceEntityRestrictions($searchQuery, $action);
  42         return $searchQuery->first();
  43     }
  44
  45     /**
  46      * Get all tags for a particular entity.
  47      * @param string $entityType
  48      * @param int $entityId
  49      * @return mixed
  50      */
  51     public function getForEntity($entityType, $entityId)
  52     {
  53         $entity = $this->getEntity($entityType, $entityId);
  54         if ($entity === null) return collect();
  55
  56         return $entity->tags;
  57     }
  58
  59     /**
  60      * Get tag name suggestions from scanning existing tag names.
  61      * @param $searchTerm
  62      * @return array
  63      */
  64     public function getNameSuggestions($searchTerm)
  65     {
  66         if ($searchTerm === '') return [];
  67         $query = $this->tag->where('name', 'LIKE', $searchTerm . '%')->groupBy('name')->orderBy('name', 'desc');
  68         $query = $this->permissionService->filterRestrictedEntityRelations($query, 'tags', 'entity_id', 'entity_type');
  69         return $query->get(['name'])->pluck('name');
  70     }
  71
  72     /**
  73      * Get tag value suggestions from scanning existing tag values.
  74      * @param $searchTerm
  75      * @param $tagName
  76      * @return array
  77      */
  78     public function getValueSuggestions($searchTerm, $tagName = false)
  79     {
  80         if ($searchTerm === '') return [];
  81         $query = $this->tag->where('value', 'LIKE', $searchTerm . '%')->groupBy('value')->orderBy('value', 'desc');
  82         if ($tagName !== false) {
  83             $query = $query->where('name', '=', $tagName);
  84         }
  85         $query = $this->permissionService->filterRestrictedEntityRelations($query, 'tags', 'entity_id', 'entity_type');
  86         return $query->get(['value'])->pluck('value');
  87     }
  88
  89     /**
  90      * Save an array of tags to an entity
  91      * @param Entity $entity
  92      * @param array $tags
  93      * @return array|\Illuminate\Database\Eloquent\Collection
  94      */
  95     public function saveTagsToEntity(Entity $entity, $tags = [])
  96     {
  97         $entity->tags()->delete();
  98         $newTags = [];
  99         foreach ($tags as $tag) {
 100             if (trim($tag['name']) === '') continue;
 101             $newTags[] = $this->newInstanceFromInput($tag);
 102         }
 103
 104         return $entity->tags()->saveMany($newTags);
 105     }
 106
 107     /**
 108      * Create a new Tag instance from user input.
 109      * @param $input
 110      * @return static
 111      */
 112     protected function newInstanceFromInput($input)
 113     {
 114         $name = trim($input['name']);
 115         $value = isset($input['value']) ? trim($input['value']) : '';
 116         // Any other modification or cleanup required can go here
 117         $values = ['name' => $name, 'value' => $value];
 118         return $this->tag->newInstance($values);
 119     }
 120
 121 }