1 <?php namespace BookStack\Actions;
3 use BookStack\Auth\Permissions\PermissionService;
4 use BookStack\Entities\Entity;
9 protected $permissionService;
12 * ViewService constructor.
13 * @param \BookStack\Actions\View $view
14 * @param \BookStack\Auth\Permissions\PermissionService $permissionService
16 public function __construct(View $view, PermissionService $permissionService)
19 $this->permissionService = $permissionService;
23 * Add a view to the given entity.
24 * @param Entity $entity
27 public function add(Entity $entity)
30 if ($user === null || $user->isDefault()) {
33 $view = $entity->views()->where('user_id', '=', $user->id)->first();
34 // Add view if model exists
36 $view->increment('views');
40 // Otherwise create new view count
41 $entity->views()->save($this->view->create([
42 'user_id' => $user->id,
50 * Get the entities with the most views.
53 * @param Entity|false|array $filterModel
54 * @param string $action - used for permission checking
57 public function getPopular($count = 10, $page = 0, $filterModel = false, $action = 'view')
59 // TODO - Standardise input filter
60 $skipCount = $count * $page;
61 $query = $this->permissionService->filterRestrictedEntityRelations($this->view, 'views', 'viewable_id', 'viewable_type', $action)
62 ->select('*', 'viewable_id', 'viewable_type', \DB::raw('SUM(views) as view_count'))
63 ->groupBy('viewable_id', 'viewable_type')
64 ->orderBy('view_count', 'desc');
66 if ($filterModel && is_array($filterModel)) {
67 $query->whereIn('viewable_type', $filterModel);
68 } else if ($filterModel) {
69 $query->where('viewable_type', '=', $filterModel->getMorphClass());
72 return $query->with('viewable')->skip($skipCount)->take($count)->get()->pluck('viewable');
76 * Get all recently viewed entities for the current user.
79 * @param Entity|bool $filterModel
82 public function getUserRecentlyViewed($count = 10, $page = 0, $filterModel = false)
85 if ($user === null || $user->isDefault()) {
89 $query = $this->permissionService
90 ->filterRestrictedEntityRelations($this->view, 'views', 'viewable_id', 'viewable_type');
93 $query = $query->where('viewable_type', '=', $filterModel->getMorphClass());
95 $query = $query->where('user_id', '=', $user->id);
97 $viewables = $query->with('viewable')->orderBy('updated_at', 'desc')
98 ->skip($count * $page)->take($count)->get()->pluck('viewable');
103 * Reset all view counts by deleting all views.
105 public function resetAll()
107 $this->view->truncate();