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? |
||
$allowedMethods | |||
stdClass read-only | $payload |
Methods
No description
Returns self.
Returns the presenter where this component belongs to.
Returns a name that uniquely identifies component.
No description
No description
Common render method.
Common render method.
This method will be called when CSRF is detected.
No description
No description
Returns pair signal receiver and name.
Checks if the signal receiver is the given one.
Returns current action name.
Changes current action.
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.
Request/URL factory.
Parse destination in format "[//] [[[module:]presenter:]action | signal! | this] [?query] [#fragment]"
Converts list of arguments to named parameters.
Invalid link handler. Descendant can override this method to change default behaviour.
Stores current request to session.
Restores request from session.
Returns array of persistent components.
Saves state information for all subcomponents to $this->globalState.
Saves state information for next request.
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
Details
at line 117
final Request|null
getRequest()
No description
at line 126
final Presenter|null
getPresenter()
Returns self.
at line 132
final Presenter|null
getPresenterIfExists()
Returns the presenter where this component belongs to.
at line 139
final bool
hasPresenter()
deprecated
deprecated
No description
at line 148
string
getUniqueId()
Returns a name that uniquely identifies component.
at line 154
bool
isModuleCurrent(string $module)
No description
at line 252
protected void
startup()
No description
at line 262
protected void
beforeRender()
Common render method.
at line 270
protected void
afterRender()
Common render method.
at line 275
protected void
shutdown(Response $response)
No description
at line 283
void
detectedCsrf()
This method will be called when CSRF is detected.
at line 293
protected void
checkHttpMethod()
No description
at line 310
void
processSignal()
No description
at line 334
final array|null
getSignal()
Returns pair signal receiver and name.
at line 343
final bool
isSignalReceiver(Component|string $component, string|bool|null $signal = null)
Checks if the signal receiver is the given one.
at line 375
final string
getAction(bool $fullyQualified = false)
Returns current action name.
at line 386
void
changeAction(string $action)
Changes current action.
at line 395
final string
getView()
Returns current view.
at line 404
Presenter
setView(string $view)
Changes current view. Any name is allowed.
at line 414
final string|bool
getLayout()
Returns current layout name.
at line 423
Presenter
setLayout(string|bool $layout)
Changes or disables layout.
at line 434
void
sendTemplate(Template|null $template = null)
No description
at line 447
string
findTemplateFile()
Finds template file name.
at line 465
string|null
findLayoutTemplateFile()
internal |
Finds layout template file name.
at line 490
array
formatLayoutTemplateFiles()
Formats layout template file names.
at line 516
array
formatTemplateFiles()
Formats view template file names.
at line 531
static string
formatActionMethod(string $action)
Formats action method name.
at line 540
static string
formatRenderMethod(string $view)
Formats render view method name.
at line 546
protected Template
createTemplate(string|null $class = null)
No description
at line 553
string|null
formatTemplateClass()
No description
at line 564
final stdClass
getPayload()
No description
at line 573
bool
isAjax()
Is AJAX request?
at line 588
void
sendPayload()
Sends AJAX payload to the output.
at line 599
void
sendJson(mixed $data)
Sends JSON data to the output.
at line 613
void
sendResponse(Response $response)
Sends response and terminates presenter.
at line 625
void
terminate()
Correctly terminates presenter.
at line 637
void
forward(Request $destination, array|mixed $args = [])
Forward to another presenter or action.
at line 656
void
redirectUrl(string $url, int|null $httpCode = null)
Redirect to another URL and ends presenter execution.
at line 676
final Request|null
getLastCreatedRequest()
internal |
Returns the last created Request.
at line 686
final bool
getLastCreatedRequestFlag(string $flag)
internal |
Returns the last created Request flag.
at line 697
void
canonicalize(string|null $destination = null, mixed ...$args)
Conditional redirect to canonicalized URI.
at line 734
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 758
protected string|null
createRequest(Component $component, string $destination, array $args, string $mode)
internal |
Request/URL factory.
at line 952
static array
parseDestination(string $destination)
internal |
Parse destination in format "[//] [[[module:]presenter:]action | signal! | this] [?query] [#fragment]"
at line 976
protected string
requestToUrl(Request $request, bool|null $relative = null)
internal |
Converts Request to URL.
at line 1012
static void
argsToParams(string $class, string $method, array $args, array $supplemental = [], array|null $missing = null)
internal |
Converts list of arguments to named parameters.
at line 1081
protected string
handleInvalidLink(InvalidLinkException $e)
Invalid link handler. Descendant can override this method to change default behaviour.
at line 1101
string
storeRequest(string $expiration = '+ 10 minutes')
Stores current request to session.
at line 1117
void
restoreRequest(string $key)
Restores request from session.
at line 1145
static array
getPersistentComponents()
Returns array of persistent components.
This default implementation detects components by class-level annotation @persistent(cmp1, cmp2).
at line 1158
protected array
getGlobalState(string|null $forClass = null)
Saves state information for all subcomponents to $this->globalState.
at line 1232
void
saveState(array $params, ComponentReflection|null $reflection = null)
Saves state information for next request.
at line 1241
protected void
saveGlobalState()
Permanently saves state information for all subcomponents to $this->globalState.
at line 1316
final array
popGlobalParameters(string $id)
internal |
Pops parameters for specified component.
at line 1339
bool
hasFlashSession()
Checks if a flash session namespace exists.
at line 1350
SessionSection
getFlashSession()
Returns session namespace provided to pass temporary data between redirects.
at line 1364
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 1384
final IRequest
getHttpRequest()
No description
at line 1390
final IResponse
getHttpResponse()
No description
at line 1396
final SessionSection
getSession(string|null $namespace = null)
No description
at line 1408
final User
getUser()
No description
at line 1414
final TemplateFactory
getTemplateFactory()
No description