Documentation

FrontEndEntrance

Defines that a specific controller is able to handle front-end entrances from the pages module

Table of Contents

Methods

_getEntranceArguments()  : array<string|int, mixed>
Return the list of [argument => label] options a tool page can call on this controller.
entrance()  : void
Acts as the entrance-point of the controller, calling internal methods specific to each argument

Methods

_getEntranceArguments()

Return the list of [argument => label] options a tool page can call on this controller.

public _getEntranceArguments() : array<string|int, mixed>

See UserController::_getEntranceArguments for an example implementation

Return values
array<string|int, mixed> —

The keys are the valid arguments, and the values are their human-friendly labels

entrance()

Acts as the entrance-point of the controller, calling internal methods specific to each argument

public entrance(string $argument) : void

See UserController::entrance for an example implementation

Parameters
$argument : string

A key in the array returned by FrontEndEntrance::_getEntranceArguments, each of which must be handled, usually by mapping onto one of the controller's own methods.

Return values
void —

The underlying method should either output HTML or redirect

On this page

Search results