Presenter
abstract class Presenter extends Control implements IPresenter
Presenter component represents a webpage instance. It converts Request to Response.
Constants
| InvalidLinkSilent |
bad link handling Presenter::$invalidLinkMode |
| InvalidLinkWarning |
bad link handling Presenter::$invalidLinkMode |
| InvalidLinkException |
bad link handling Presenter::$invalidLinkMode |
| InvalidLinkTextual |
bad link handling Presenter::$invalidLinkMode |
| internal PresenterKey |
|
| internal SignalKey |
|
| internal ActionKey |
|
| internal FlashKey |
|
| internal DefaultAction |
|
| deprecated INVALID_LINK_SILENT |
|
| deprecated INVALID_LINK_WARNING |
|
| deprecated INVALID_LINK_EXCEPTION |
|
| deprecated INVALID_LINK_TEXTUAL |
|
| deprecated PRESENTER_KEY |
|
| deprecated SIGNAL_KEY |
|
| deprecated ACTION_KEY |
|
| deprecated FLASH_KEY |
|
| deprecated DEFAULT_ACTION |
|
Properties
| $invalidLinkMode | |||
| $onStartup | |||
| $onRender | |||
| $onShutdown | |||
| $autoCanonicalize | automatically call canonicalize() |
||
| $absoluteUrls | use absolute Urls or paths? |
||
| deprecated | $allowedMethods | ||
| string | $view | ||
| string|bool | $layout | ||
| Request read-only | $request | ||
| string read-only | $action | ||
| stdClass read-only | $payload | ||
| Session read-only | $session | ||
| User read-only | $user |
Methods
No description
No description
Returns self.
Returns the presenter where this component belongs to.
Returns a name that uniquely identifies component.
No description
No description
No description
Common render method.
Common render method.
This method will be called when CSRF is detected.
No description
Returns pair signal receiver and name.
Checks if the signal receiver is the given one.
Returns current action name.
Changes current action.
Switch from current action or render method to another.
Returns current view.
Returns current layout name.
No description
Finds template file name.
Finds layout template file name.
Formats layout template file names.
Formats view template file names.
Formats action method name.
Formats render view method name.
No description
No description
No description
Is AJAX request?
Sends AJAX payload to the output.
Sends JSON data to the output.
Correctly terminates presenter.
Forward to another presenter or action.
Redirect to another URL and ends presenter execution.
Returns the last created Request.
Returns the last created Request flag.
Conditional redirect to canonicalized URI.
Attempts to cache the sent entity by its last modification date.
No description
Invalid link handler. Descendant can override this method to change default behaviour.
Stores current request to session.
Restores request from session.
Descendant can override this method to return the names of custom persistent components.
Saves state information for all subcomponents to $this->globalState.
Permanently saves state information for all subcomponents to $this->globalState.
Pops parameters for specified component.
Checks if a flash session namespace exists.
Returns session namespace provided to pass temporary data between redirects.
No description
No description
No description
No description
No description
No description
No description
Details
at line 119
__construct()
No description
at line 124
final Request|null
getRequest()
No description
at line 133
final Presenter|null
getPresenter()
Returns self.
at line 139
final Presenter|null
getPresenterIfExists()
Returns the presenter where this component belongs to.
at line 146
final bool
hasPresenter()
deprecated
deprecated
No description
at line 155
string
getUniqueId()
Returns a name that uniquely identifies component.
at line 161
bool
isModuleCurrent(string $module)
No description
at line 168
bool
isForwarded()
No description
at line 177
Response
run(Request $request)
No description
at line 283
protected void
startup()
No description
at line 293
protected void
beforeRender()
Common render method.
at line 301
protected void
afterRender()
Common render method.
at line 306
protected void
shutdown(Response $response)
No description
at line 314
void
detectedCsrf()
This method will be called when CSRF is detected.
at line 325
protected void
checkHttpMethod()
deprecated
deprecated use #[Requires(methods: ...)] to specify allowed methods
No description
at line 342
void
processSignal()
No description
at line 366
final array|null
getSignal()
Returns pair signal receiver and name.
at line 375
final bool
isSignalReceiver(Component|string $component, string|bool|null $signal = null)
Checks if the signal receiver is the given one.
at line 407
final string
getAction(bool $fullyQualified = false)
Returns current action name.
at line 418
void
changeAction(string $action)
Changes current action.
at line 428
never
switch(string $action)
Switch from current action or render method to another.
at line 437
final string
getView()
Returns current view.
at line 446
Presenter
setView(string $view)
Changes current view. Any name is allowed.
at line 457
final string|bool
getLayout()
Returns current layout name.
at line 466
Presenter
setLayout(string|bool $layout)
Changes or disables layout.
at line 477
void
sendTemplate(Template|null $template = null)
No description
at line 490
string
findTemplateFile()
Finds template file name.
at line 508
string|null
findLayoutTemplateFile()
| internal |
Finds layout template file name.
at line 534
array
formatLayoutTemplateFiles()
Formats layout template file names.
at line 571
array
formatTemplateFiles()
Formats view template file names.
at line 594
static string
formatActionMethod(string $action)
Formats action method name.
at line 603
static string
formatRenderMethod(string $view)
Formats render view method name.
at line 609
protected Template
createTemplate(string|null $class = null)
No description
at line 616
string|null
formatTemplateClass()
No description
at line 627
final stdClass
getPayload()
No description
at line 636
bool
isAjax()
Is AJAX request?
at line 651
void
sendPayload()
Sends AJAX payload to the output.
at line 662
void
sendJson(mixed $data)
Sends JSON data to the output.
at line 676
void
sendResponse(Response $response)
Sends response and terminates presenter.
at line 688
void
terminate()
Correctly terminates presenter.
at line 700
void
forward(Request $destination, array|mixed $args = [])
Forward to another presenter or action.
at line 719
void
redirectUrl(string $url, int|null $httpCode = null)
Redirect to another URL and ends presenter execution.
at line 739
final Request|null
getLastCreatedRequest()
| internal |
Returns the last created Request.
at line 749
final bool
getLastCreatedRequestFlag(string $flag)
| internal |
Returns the last created Request flag.
at line 760
void
canonicalize(string|null $destination = null, mixed ...$args)
Conditional redirect to canonicalized URI.
at line 797
void
lastModified(string|int|DateTimeInterface|null $lastModified, string|null $etag = null, string|null $expire = null)
Attempts to cache the sent entity by its last modification date.
at line 815
protected string|null
createRequest(Component $component, string $destination, array $args, string $mode)
deprecated
deprecated @internal
No description
at line 822
static array
parseDestination(string $destination)
deprecated
deprecated @internal
No description
at line 829
protected string
requestToUrl(Request $request, bool|null $relative = null)
deprecated
deprecated @internal
No description
at line 839
protected string
handleInvalidLink(InvalidLinkException $e)
Invalid link handler. Descendant can override this method to change default behaviour.
at line 859
string
storeRequest(string $expiration = '+ 10 minutes')
Stores current request to session.
at line 875
void
restoreRequest(string $key)
Restores request from session.
at line 904
static array
getPersistentComponents()
Descendant can override this method to return the names of custom persistent components.
at line 913
array
getGlobalState(string|null $forClass = null)
Saves state information for all subcomponents to $this->globalState.
at line 987
protected void
saveGlobalState()
Permanently saves state information for all subcomponents to $this->globalState.
at line 1063
final array
popGlobalParameters(string $id)
| internal |
Pops parameters for specified component.
at line 1086
bool
hasFlashSession()
Checks if a flash session namespace exists.
at line 1097
SessionSection
getFlashSession()
Returns session namespace provided to pass temporary data between redirects.
at line 1111
final void
injectPrimary(IRequest $httpRequest, IResponse $httpResponse, IPresenterFactory|null $presenterFactory = null, Router|null $router = null, Session|null $session = null, User|null $user = null, TemplateFactory|null $templateFactory = null)
No description
at line 1137
final IRequest
getHttpRequest()
No description
at line 1143
final IResponse
getHttpResponse()
No description
at line 1149
final SessionSection
getSession(string|null $namespace = null)
No description
at line 1161
final User
getUser()
No description
at line 1167
final TemplateFactory
getTemplateFactory()
No description
at line 1173
final protected LinkGenerator
getLinkGenerator()
No description