Elgg  Version master
Public Member Functions | List of all members
Elgg\Gatekeeper Class Reference

Gatekeeper. More...

Public Member Functions

 __construct (protected SessionManagerService $session_manager, protected HttpRequest $request, protected RedirectService $redirects, protected EntityTable $entities, protected AccessCollections $access, protected 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...
 

Detailed Description

Gatekeeper.

Use elgg()->gatekeeper

Definition at line 24 of file Gatekeeper.php.

Constructor & Destructor Documentation

Elgg\Gatekeeper::__construct ( protected SessionManagerService  $session_manager,
protected HttpRequest  $request,
protected RedirectService  $redirects,
protected EntityTable  $entities,
protected AccessCollections  $access,
protected Translator  $translator 
)

Constructor.

Parameters
SessionManagerService$session_managerSession manager
HttpRequest$requestHTTP Request
RedirectService$redirectsRedirects Service
EntityTable$entitiesEntity table
AccessCollections$accessAccess collection table
Translator$translatorTranslator

Definition at line 36 of file Gatekeeper.php.

Member Function Documentation

Elgg\Gatekeeper::assertAccessibleEntity ( \ElggEntity  $entity,
\ElggUser  $user = null,
bool  $validate_can_edit = false 
)

Require that authenticated user has access to entity.

Parameters
\ElggEntity$entityEntity
\ElggUser$userUser
bool$validate_can_editflag to check canEdit access
Returns
void
Exceptions
HttpException

Definition at line 141 of file Gatekeeper.php.

Elgg\Gatekeeper::assertAccessibleGroup ( \ElggGroup  $group,
\ElggUser  $user = null 
)

Validate group content visibility.

Parameters
\ElggGroup$groupGroup entity
\ElggUser$userUser entity
Returns
void
Exceptions
GroupGatekeeperException
GatekeeperException

Definition at line 252 of file Gatekeeper.php.

Elgg\Gatekeeper::assertAccessibleUser ( \ElggUser  $user,
\ElggUser  $viewer = null 
)

Validate active user account.

Parameters
\ElggUser$userUser
\ElggUser$viewerViewing user
Returns
void
Exceptions
EntityNotFoundException

Definition at line 222 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 86 of file Gatekeeper.php.

Elgg\Gatekeeper::assertAuthenticatedUser ( )

Require a user to be authenticated to with code execution.

Returns
void
Exceptions
LoggedInGatekeeperException

Definition at line 52 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$guidGUID of the entity
string$typeEntity type
string$subtypeEntity subtype
Returns
Exceptions
EntityNotFoundException

Definition at line 112 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 68 of file Gatekeeper.php.

Elgg\Gatekeeper::assertXmlHttpRequest ( )

Require XmlHttpRequest.

Returns
void
Exceptions
AjaxGatekeeperException

Definition at line 277 of file Gatekeeper.php.


The documentation for this class was generated from the following file: