class ImpersonateController extends ActionController (View source)

The Impersonate controller

Properties

protected ImpersonateService $impersonateService
protected PartyService $partyService
protected string $defaultViewObjectName
protected array $viewFormatToObjectNameMap
protected array $supportedMediaTypes

Methods

void
impersonateAction(Account $account)

No description

void
redirectIfPossible(string $actionName)

Fetching possible redirect options for the given action method and if everything is set we redirect to the configured controller action.

void
redirectWithParentRequest(string $actionName, string $controllerName = null, string $packageKey = null, array $arguments = [], int $delay = 0, int $statusCode = 303, string $format = null)

No description

void
impersonateUserWithResponseAction(User $user)

No description

void
restoreAction()

No description

void
restoreWithResponseAction()

No description

void
statusAction()

No description

array
getImpersonateStatus()

No description

Details

void impersonateAction(Account $account)

No description

Parameters

Account $account

Return Value

void

protected void redirectIfPossible(string $actionName)

Fetching possible redirect options for the given action method and if everything is set we redirect to the configured controller action.

Parameters

string $actionName

Return Value

void

protected void redirectWithParentRequest(string $actionName, string $controllerName = null, string $packageKey = null, array $arguments = [], int $delay = 0, int $statusCode = 303, string $format = null)

No description

Parameters

string $actionName

Name of the action to forward to

string $controllerName

Unqualified object name of the controller to forward to. If not specified, the current controller is used.

string $packageKey

Key of the package containing the controller to forward to. If not specified, the current package is assumed.

array $arguments

Array of arguments for the target action

int $delay

(optional) The delay in seconds. Default is no delay.

int $statusCode

(optional) The HTTP status code for the redirect. Default is "303 See Other"

string $format

The format to use for the redirect URI

Return Value

void

See also

redirect()

void impersonateUserWithResponseAction(User $user)

No description

Parameters

User $user

Return Value

void

Exceptions

SessionNotStartedException

void restoreAction()

No description

Return Value

void

Exceptions

StopActionException

void restoreWithResponseAction()

No description

Return Value

void

Exceptions

StopActionException

void statusAction()

No description

Return Value

void

array getImpersonateStatus()

No description

Return Value

array