use BookStack\Exceptions\UserUpdateException;
use BookStack\Uploads\ImageRepo;
use Illuminate\Http\Request;
-use Illuminate\Http\Response;
use Illuminate\Support\Str;
class UserController extends Controller
/**
* UserController constructor.
- * @param User $user
- * @param UserRepo $userRepo
- * @param UserInviteService $inviteService
- * @param ImageRepo $imageRepo
*/
public function __construct(User $user, UserRepo $userRepo, UserInviteService $inviteService, ImageRepo $imageRepo)
{
/**
* Display a listing of the users.
- * @param Request $request
- * @return Response
*/
public function index(Request $request)
{
/**
* Show the form for creating a new user.
- * @return Response
*/
public function create()
{
/**
* Store a newly created user in storage.
- * @param Request $request
- * @return Response
* @throws UserUpdateException
+ * @throws \Illuminate\Validation\ValidationException
*/
public function store(Request $request)
{
/**
* Update the specified user in storage.
- * @param Request $request
- * @param int $id
- * @return Response
* @throws UserUpdateException
* @throws \BookStack\Exceptions\ImageUploadException
+ * @throws \Illuminate\Validation\ValidationException
*/
- public function update(Request $request, $id)
+ public function update(Request $request, int $id)
{
$this->preventAccessInDemoMode();
$this->checkPermissionOrCurrentUser('users-manage', $id);
/**
* Show the user delete page.
- * @param int $id
- * @return \Illuminate\View\View
*/
- public function delete($id)
+ public function delete(int $id)
{
$this->checkPermissionOrCurrentUser('users-manage', $id);
/**
* Remove the specified user from storage.
- * @param int $id
- * @return Response
* @throws \Exception
*/
- public function destroy($id)
+ public function destroy(int $id)
{
$this->preventAccessInDemoMode();
$this->checkPermissionOrCurrentUser('users-manage', $id);
/**
* Show the user profile page
- * @param $id
- * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/
public function showProfilePage($id)
{
/**
* Update the user's preferred book-list display setting.
- * @param Request $request
- * @param $id
- * @return \Illuminate\Http\RedirectResponse
*/
- public function switchBookView(Request $request, $id)
+ public function switchBooksView(Request $request, int $id)
{
return $this->switchViewType($id, $request, 'books');
}
/**
* Update the user's preferred shelf-list display setting.
- * @param Request $request
- * @param $id
- * @return \Illuminate\Http\RedirectResponse
*/
- public function switchShelfView(Request $request, $id)
+ public function switchShelvesView(Request $request, int $id)
{
return $this->switchViewType($id, $request, 'bookshelves');
}
+ /**
+ * Update the user's preferred shelf-view book list display setting.
+ */
+ public function switchShelfView(Request $request, int $id)
+ {
+ return $this->switchViewType($id, $request, 'bookshelf');
+ }
+
/**
* For a type of list, switch with stored view type for a user.
- * @param integer $userId
- * @param Request $request
- * @param string $listName
- * @return \Illuminate\Http\RedirectResponse
*/
- protected function switchViewType($userId, Request $request, string $listName)
+ protected function switchViewType(int $userId, Request $request, string $listName)
{
$this->checkPermissionOrCurrentUser('users-manage', $userId);
/**
* Change the stored sort type for a particular view.
- * @param Request $request
- * @param string $id
- * @param string $type
- * @return \Illuminate\Http\RedirectResponse
*/
public function changeSort(Request $request, string $id, string $type)
{
/**
* Update the stored section expansion preference for the given user.
- * @param Request $request
- * @param string $id
- * @param string $key
- * @return \Illuminate\Contracts\Routing\ResponseFactory|\Symfony\Component\HttpFoundation\Response
*/
public function updateExpansionPreference(Request $request, string $id, string $key)
{
/**
* Changed the stored preference for a list sort order.
- * @param int $userId
- * @param Request $request
- * @param string $listName
- * @return \Illuminate\Http\RedirectResponse
*/
protected function changeListSort(int $userId, Request $request, string $listName)
{