Gatekeeper.
More...
|
| __construct (SessionManagerService $session_manager, HttpRequest $request, RedirectService $redirects, EntityTable $entities, AccessCollections $access, Translator $translator) |
| Constructor. More...
|
|
| assertAuthenticatedUser () |
| Require a user to be authenticated to with code execution. More...
|
|
| assertUnauthenticatedUser () |
| Require a user to be not authenticated (logged out) to with code execution. More...
|
|
| assertAuthenticatedAdmin () |
| Require an admin user to be authenticated to proceed with code execution. More...
|
|
| assertExists (int $guid, string $type=null, string $subtype=null) |
| Require an entity with a given guid, type and subtype to proceed with code execution. More...
|
|
| assertAccessibleEntity (\ElggEntity $entity,\ElggUser $user=null, bool $validate_can_edit=false) |
| Require that authenticated user has access to entity. More...
|
|
| assertAccessibleUser (\ElggUser $user,\ElggUser $viewer=null) |
| Validate active user account. More...
|
|
| assertAccessibleGroup (\ElggGroup $group,\ElggUser $user=null) |
| Validate group content visibility. More...
|
|
| assertXmlHttpRequest () |
| Require XmlHttpRequest. More...
|
|
Gatekeeper.
Use elgg()->gatekeeper
Definition at line 24 of file Gatekeeper.php.
Elgg\Gatekeeper::assertAccessibleEntity |
( |
\ElggEntity |
$entity, |
|
|
\ElggUser |
$user = null , |
|
|
bool |
$validate_can_edit = false |
|
) |
| |
Require that authenticated user has access to entity.
- Parameters
-
\ElggEntity | $entity | Entity |
\ElggUser | $user | User |
bool | $validate_can_edit | flag to check canEdit access |
- Returns
- void
- Exceptions
-
Definition at line 174 of file Gatekeeper.php.
Validate group content visibility.
- Parameters
-
\ElggGroup | $group | Group entity |
\ElggUser | $user | User entity |
- Returns
- void
- Exceptions
-
GroupGatekeeperException | |
GatekeeperException | |
Definition at line 285 of file Gatekeeper.php.
Elgg\Gatekeeper::assertAccessibleUser |
( |
\ElggUser |
$user, |
|
|
\ElggUser |
$viewer = null |
|
) |
| |
Validate active user account.
- Parameters
-
\ElggUser | $user | User |
\ElggUser | $viewer | Viewing user |
- Returns
- void
- Exceptions
-
Definition at line 255 of file Gatekeeper.php.
Elgg\Gatekeeper::assertAuthenticatedAdmin |
( |
| ) |
|
Require an admin user to be authenticated to proceed with code execution.
- Returns
- void
- Exceptions
-
GatekeeperException | |
AdminGatekeeperException | |
Definition at line 119 of file Gatekeeper.php.
Elgg\Gatekeeper::assertAuthenticatedUser |
( |
| ) |
|
Require a user to be authenticated to with code execution.
- Returns
- void
- Exceptions
-
LoggedInGatekeeperException | |
Definition at line 87 of file Gatekeeper.php.
Elgg\Gatekeeper::assertExists |
( |
int |
$guid, |
|
|
string |
$type = null , |
|
|
string |
$subtype = null |
|
) |
| |
Require an entity with a given guid, type and subtype to proceed with code execution.
- Warning
- Returned entity has been retrieved with ignored access, as well including disabled entities. You must validate entity access on the return of this method.
- Parameters
-
int | $guid | GUID of the entity |
string | $type | Entity type |
string | $subtype | Entity subtype |
- Returns
- Exceptions
-
Definition at line 145 of file Gatekeeper.php.
Elgg\Gatekeeper::assertUnauthenticatedUser |
( |
| ) |
|
Require a user to be not authenticated (logged out) to with code execution.
- Returns
- void
- Exceptions
-
LoggedOutGatekeeperException | |
Definition at line 102 of file Gatekeeper.php.
Elgg\Gatekeeper::assertXmlHttpRequest |
( |
| ) |
|
Require XmlHttpRequest.
- Returns
- void
- Exceptions
-
Definition at line 310 of file Gatekeeper.php.
Elgg\Gatekeeper::$entities |
|
protected |
Elgg\Gatekeeper::$redirects |
|
protected |
Elgg\Gatekeeper::$request |
|
protected |
Elgg\Gatekeeper::$session_manager |
|
protected |
Elgg\Gatekeeper::$translator |
|
protected |
The documentation for this class was generated from the following file: