github-mirror/framework
github-mirror/framework
2
0
Fork 0
mirror of https://github.com/flarum/framework.git synced 2025-02-27 18:11:54 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document permission check methods

Browse Source
This commit is contained in:
Franz Liedke 2019-08-20 17:18:18 +02:00 committed by Daniël Klabbers
parent f7222d7e20
commit 4cab48c0fd
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/User/AssertPermissionTrait.php
View File

@ -15,6 +15,13 @@ use Flarum\User\Exception\PermissionDeniedException;
trait AssertPermissionTrait trait AssertPermissionTrait
{ {
/** /**
* Ensure the current user is allowed to do something.
*
* If the condition is not met, an exception will be thrown that signals the
* lack of permissions. This is about *authorization*, i.e. retrying such a
* request / operation without a change in permissions (or using another
* user account) is pointless.
*
* @param bool $condition * @param bool $condition
* @throws PermissionDeniedException * @throws PermissionDeniedException
*/ */
@ -26,6 +33,12 @@ trait AssertPermissionTrait
} }
/** /**
* Ensure the current user is authenticated.
*
* This will throw an exception for guest users, signaling that
* *authorization* failed. Thus, they could retry the operation after
* logging in (or using other means of authentication).
*
* @param bool $condition * @param bool $condition
* @throws NotAuthenticatedException * @throws NotAuthenticatedException
*/ */