1 <?php namespace BookStack\Actions;
3 use BookStack\Auth\Permissions\PermissionService;
4 use BookStack\Entities\Models\Entity;
6 use Illuminate\Support\Collection;
12 protected $permissionService;
15 * TagRepo constructor.
17 public function __construct(Tag $tag, PermissionService $ps)
20 $this->permissionService = $ps;
24 * Get tag name suggestions from scanning existing tag names.
25 * If no search term is given the 50 most popular tag names are provided.
27 public function getNameSuggestions(?string $searchTerm): Collection
29 $query = $this->tag->select('*', DB::raw('count(*) as count'))->groupBy('name');
32 $query = $query->where('name', 'LIKE', $searchTerm . '%')->orderBy('name', 'desc');
34 $query = $query->orderBy('count', 'desc')->take(50);
37 $query = $this->permissionService->filterRestrictedEntityRelations($query, 'tags', 'entity_id', 'entity_type');
38 return $query->get(['name'])->pluck('name');
42 * Get tag value suggestions from scanning existing tag values.
43 * If no search is given the 50 most popular values are provided.
44 * Passing a tagName will only find values for a tags with a particular name.
46 public function getValueSuggestions(?string $searchTerm, ?string $tagName): Collection
48 $query = $this->tag->select('*', DB::raw('count(*) as count'))->groupBy('value');
51 $query = $query->where('value', 'LIKE', $searchTerm . '%')->orderBy('value', 'desc');
53 $query = $query->orderBy('count', 'desc')->take(50);
57 $query = $query->where('name', '=', $tagName);
60 $query = $this->permissionService->filterRestrictedEntityRelations($query, 'tags', 'entity_id', 'entity_type');
61 return $query->get(['value'])->pluck('value');
65 * Save an array of tags to an entity
67 public function saveTagsToEntity(Entity $entity, array $tags = []): iterable
69 $entity->tags()->delete();
71 $newTags = collect($tags)->filter(function ($tag) {
72 return boolval(trim($tag['name']));
73 })->map(function ($tag) {
74 return $this->newInstanceFromInput($tag);
77 return $entity->tags()->saveMany($newTags);
81 * Create a new Tag instance from user input.
82 * Input must be an array with a 'name' and an optional 'value' key.
84 protected function newInstanceFromInput(array $input): Tag
86 $name = trim($input['name']);
87 $value = isset($input['value']) ? trim($input['value']) : '';
88 return $this->tag->newInstance(['name' => $name, 'value' => $value]);