Presenter
abstract class Presenter extends Control implements IPresenter
Presenter component represents a webpage instance. It converts Request to IResponse.
Constants
| INVALID_LINK_SILENT |
bad link handling Presenter::$invalidLinkMode |
| INVALID_LINK_WARNING |
bad link handling Presenter::$invalidLinkMode |
| INVALID_LINK_EXCEPTION |
bad link handling Presenter::$invalidLinkMode |
| INVALID_LINK_TEXTUAL |
bad link handling Presenter::$invalidLinkMode |
| internal SIGNAL_KEY |
|
| internal ACTION_KEY |
|
| internal FLASH_KEY |
|
| internal DEFAULT_ACTION |
|
Properties
| int | $invalidLinkMode | ||
| callable[] | $onStartup | ||
| callable[] | $onShutdown | ||
| bool | $autoCanonicalize | ||
| bool | $absoluteUrls | ||
| string | $view | ||
| string|bool | $layout | ||
| Request read-only | $request | ||
| string read-only | $action | ||
| stdClass read-only | $payload | ||
| Container read-only | $context | ||
| Session read-only | $session | ||
| User read-only | $user |
Methods
No description
No description
Returns self.
Returns a name that uniquely identifies component.
No description
Common render method.
Common render method.
No description
Checks authorization.
No description
Returns pair signal receiver and name.
Checks if the signal receiver is the given one.
Returns current action name.
Changes current action. Only alphanumeric characters are allowed.
Returns current view.
Returns current layout name.
No description
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
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.
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 informations 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 131
__construct()
No description
at line 140
Request|null
getRequest()
No description
at line 150
Presenter|null
getPresenter($throw = true)
Returns self.
at line 160
string
getUniqueId()
Returns a name that uniquely identifies component.
at line 262
protected void
startup()
No description
at line 272
protected void
beforeRender()
Common render method.
at line 281
protected void
afterRender()
Common render method.
at line 290
protected void
shutdown($response)
No description
at line 299
void
checkRequirements($element)
Checks authorization.
at line 315
void
processSignal()
No description
at line 338
array|null
getSignal()
Returns pair signal receiver and name.
at line 350
bool
isSignalReceiver($component, $signal = null)
Checks if the signal receiver is the given one.
at line 379
string
getAction($fullyQualified = false)
Returns current action name.
at line 390
void
changeAction($action)
Changes current action. Only alphanumeric characters are allowed.
at line 406
string
getView()
Returns current view.
at line 417
Presenter
setView($view)
Changes current view. Any name is allowed.
at line 428
string|bool
getLayout()
Returns current layout name.
at line 439
Presenter
setLayout($layout)
Changes or disables layout.
at line 451
void
sendTemplate()
No description
at line 478
string|null
findLayoutTemplateFile()
| internal |
Finds layout template file name.
at line 501
array
formatLayoutTemplateFiles()
Formats layout template file names.
at line 526
array
formatTemplateFiles()
Formats view template file names.
at line 543
static string
formatActionMethod($action)
Formats action method name.
at line 554
static string
formatRenderMethod($view)
Formats render view method name.
at line 563
protected ITemplate
createTemplate()
No description
at line 575
stdClass
getPayload()
No description
at line 585
bool
isAjax()
Is AJAX request?
at line 599
void
sendPayload()
Sends AJAX payload to the output.
at line 611
void
sendJson($data)
Sends JSON data to the output.
at line 625
void
sendResponse(IResponse $response)
Sends response and terminates presenter.
at line 637
void
terminate()
Correctly terminates presenter.
at line 650
void
forward($destination, $args = [])
Forward to another presenter or action.
at line 669
void
redirectUrl($url, $httpCode = null)
Redirect to another URL and ends presenter execution.
at line 689
string
backlink()
deprecated
deprecated
Link to myself.
at line 701
Request|null
getLastCreatedRequest()
| internal |
Returns the last created Request.
at line 713
bool
getLastCreatedRequestFlag($flag)
| internal |
Returns the last created Request flag.
at line 725
void
canonicalize($destination = null, array $args = [])
Conditional redirect to canonicalized URI.
at line 754
void
lastModified($lastModified, $etag = null, $expire = null)
Attempts to cache the sent entity by its last modification date.
at line 776
protected string|null
createRequest($component, $destination, array $args, $mode)
| internal |
Request/URL factory.
at line 969
protected string
requestToUrl(Request $request, $relative = null)
| internal |
Converts Request to URL.
at line 1009
static void
argsToParams($class, $method, $args, $supplemental = [], $missing = [])
| internal |
Converts list of arguments to named parameters.
at line 1064
protected string
handleInvalidLink(InvalidLinkException $e)
Invalid link handler. Descendant can override this method to change default behaviour.
at line 1085
string
storeRequest($expiration = '+ 10 minutes')
Stores current request to session.
at line 1103
void
restoreRequest($key)
Restores request from session.
at line 1127
static array
getPersistentComponents()
Returns array of persistent components.
This default implementation detects components by class-level annotation @persistent(cmp1, cmp2).
at line 1137
protected array
getGlobalState($forClass = null)
Saves state information for all subcomponents to $this->globalState.
at line 1207
void
saveState(array $params, ComponentReflection $reflection = null)
Saves state informations for next request.
at line 1218
protected void
saveGlobalState()
Permanently saves state information for all subcomponents to $this->globalState.
at line 1289
array
popGlobalParameters($id)
| internal |
Pops parameters for specified component.
at line 1321
bool
hasFlashSession()
Checks if a flash session namespace exists.
at line 1333
SessionSection
getFlashSession()
Returns session namespace provided to pass temporary data between redirects.
at line 1346
injectPrimary(Container $context = null, IPresenterFactory $presenterFactory = null, IRouter $router = null, IRequest $httpRequest, IResponse $httpResponse, Session $session = null, User $user = null, ITemplateFactory $templateFactory = null)
No description
at line 1369
Container
getContext()
deprecated
deprecated
Gets the context.
at line 1381
IRequest
getHttpRequest()
No description
at line 1390
IResponse
getHttpResponse()
No description
at line 1400
Session|SessionSection
getSession($namespace = null)
No description
at line 1412
User
getUser()
No description
at line 1424
ITemplateFactory
getTemplateFactory()
No description