1 <?php namespace BookStack\Actions;
3 use BookStack\Auth\Permissions\PermissionService;
4 use BookStack\Entities\Book;
5 use BookStack\Entities\Entity;
6 use BookStack\Entities\EntityProvider;
8 use Illuminate\Support\Collection;
13 protected $permissionService;
14 protected $entityProvider;
17 * ViewService constructor.
19 * @param PermissionService $permissionService
20 * @param EntityProvider $entityProvider
22 public function __construct(View $view, PermissionService $permissionService, EntityProvider $entityProvider)
25 $this->permissionService = $permissionService;
26 $this->entityProvider = $entityProvider;
30 * Add a view to the given entity.
31 * @param \BookStack\Entities\Entity $entity
34 public function add(Entity $entity)
37 if ($user === null || $user->isDefault()) {
40 $view = $entity->views()->where('user_id', '=', $user->id)->first();
41 // Add view if model exists
43 $view->increment('views');
47 // Otherwise create new view count
48 $entity->views()->save($this->view->newInstance([
49 'user_id' => $user->id,
57 * Get the entities with the most views.
60 * @param string|array $filterModels
61 * @param string $action - used for permission checking
64 public function getPopular(int $count = 10, int $page = 0, array $filterModels = null, string $action = 'view')
66 $skipCount = $count * $page;
67 $query = $this->permissionService
68 ->filterRestrictedEntityRelations($this->view, 'views', 'viewable_id', 'viewable_type', $action)
69 ->select('*', 'viewable_id', 'viewable_type', DB::raw('SUM(views) as view_count'))
70 ->groupBy('viewable_id', 'viewable_type')
71 ->orderBy('view_count', 'desc');
74 $query->whereIn('viewable_type', $this->entityProvider->getMorphClasses($filterModels));
77 return $query->with('viewable')->skip($skipCount)->take($count)->get()->pluck('viewable');
81 * Get all recently viewed entities for the current user.
84 * @param Entity|bool $filterModel
87 public function getUserRecentlyViewed($count = 10, $page = 0, $filterModel = false)
90 if ($user === null || $user->isDefault()) {
94 $query = $this->permissionService
95 ->filterRestrictedEntityRelations($this->view, 'views', 'viewable_id', 'viewable_type');
98 $query = $query->where('viewable_type', '=', $filterModel->getMorphClass());
100 $query = $query->where('user_id', '=', $user->id);
102 $viewables = $query->with('viewable')->orderBy('updated_at', 'desc')
103 ->skip($count * $page)->take($count)->get()->pluck('viewable');
108 * Reset all view counts by deleting all views.
110 public function resetAll()
112 $this->view->truncate();