Interface ImpersonationInterface
Namespace: Authentication\Authenticator
Method Summary
-
clearIdentity() public
Clears the identity data
-
impersonate() public
Impersonates a user
-
isImpersonating() public
Returns true if impersonation is being done
-
persistIdentity() public
Persists the users data
-
stopImpersonating() public
Stops impersonation
Method Detail
clearIdentity() ¶ public
clearIdentity(Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response): arrayClears the identity data
Parameters
-
Psr\Http\Message\ServerRequestInterface$request The request object.
-
Psr\Http\Message\ResponseInterface$response The response object.
Returns
arrayimpersonate() ¶ public
impersonate(Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response, ArrayAccess $impersonator, ArrayAccess $impersonated): arrayImpersonates a user
Parameters
-
Psr\Http\Message\ServerRequestInterface$request The request
-
Psr\Http\Message\ResponseInterface$response The response
-
ArrayAccess$impersonator User who impersonates
-
ArrayAccess$impersonated User impersonated
Returns
arrayisImpersonating() ¶ public
isImpersonating(Psr\Http\Message\ServerRequestInterface $request): boolReturns true if impersonation is being done
Parameters
-
Psr\Http\Message\ServerRequestInterface$request The request
Returns
boolpersistIdentity() ¶ public
persistIdentity(Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response, ArrayAccess|array $identity): arrayPersists the users data
Parameters
-
Psr\Http\Message\ServerRequestInterface$request The request object.
-
Psr\Http\Message\ResponseInterface$response The response object.
-
ArrayAccess|array$identity Identity data to persist.
Returns
arraystopImpersonating() ¶ public
stopImpersonating(Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response): arrayStops impersonation
Parameters
-
Psr\Http\Message\ServerRequestInterface$request The request
-
Psr\Http\Message\ResponseInterface$response The response
Returns
array