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 |
| internal SIGNAL_KEY |
|
| internal ACTION_KEY |
|
| internal FLASH_KEY |
|
| internal DEFAULT_ACTION |
|
Properties
| int | $invalidLinkMode | ||
| array | $onShutdown | ||
| bool | $autoCanonicalize | ||
| bool | $absoluteUrls | ||
| string | $view | ||
| string | $layout | ||
| Request read-only | $request | ||
| array|null read-only | $signal | ||
| string read-only | $action | ||
| stdClass read-only | $payload | ||
| bool read-only | $ajax | ||
| Request read-only | $lastCreatedRequest | ||
| SessionSection read-only | $flashSession | ||
| SystemContainer|Container read-only | $context | ||
| Application read-only | $application | ||
| 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
Is AJAX request?
Sends AJAX payload to the output.
Correctly terminates presenter.
Forward to another presenter or action.
Redirect to another URL and ends presenter execution.
Throws HTTP error.
Link to myself.
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.
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.
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
Gets the context.
No description
No description
No description
No description
No description
No description
Details
at line 110
__construct(Container $context = NULL)
No description
at line 122
Request
getRequest()
No description
at line 132
Presenter|null
getPresenter($need = TRUE)
Returns self.
at line 142
string
getUniqueId()
Returns a name that uniquely identifies component.
at line 237
protected void
startup()
No description
at line 247
protected void
beforeRender()
Common render method.
at line 256
protected void
afterRender()
Common render method.
at line 265
protected void
shutdown($response)
No description
at line 274
void
checkRequirements($element)
Checks authorization.
at line 290
void
processSignal()
No description
at line 316
array|null
getSignal()
Returns pair signal receiver and name.
at line 328
bool
isSignalReceiver($component, $signal = NULL)
Checks if the signal receiver is the given one.
at line 357
string
getAction($fullyQualified = FALSE)
Returns current action name.
at line 368
void
changeAction($action)
Changes current action. Only alphanumeric characters are allowed.
at line 384
string
getView()
Returns current view.
at line 395
Presenter
setView($view)
Changes current view. Any name is allowed.
at line 406
string|false
getLayout()
Returns current layout name.
at line 417
Presenter
setLayout($layout)
Changes or disables layout.
at line 429
void
sendTemplate()
No description
at line 460
string
findLayoutTemplateFile()
Finds layout template file name.
at line 484
array
formatLayoutTemplateFiles()
Formats layout template file names.
at line 510
array
formatTemplateFiles()
Formats view template file names.
at line 530
static protected string
formatActionMethod($action)
Formats action method name.
at line 541
static protected string
formatRenderMethod($view)
Formats render view method name.
at line 553
stdClass
getPayload()
No description
at line 563
bool
isAjax()
Is AJAX request?
at line 577
void
sendPayload()
Sends AJAX payload to the output.
at line 591
void
sendResponse(IResponse $response)
Sends response and terminates presenter.
at line 603
void
terminate()
Correctly terminates presenter.
at line 620
void
forward($destination, $args = array())
Forward to another presenter or action.
at line 638
void
redirectUrl($url, $code = NULL)
Redirect to another URL and ends presenter execution.
at line 653
redirectUri($url, $code = NULL)
deprecated
deprecated
No description
at line 667
void
error($message = NULL, $code = Http\IResponse::S404_NOT_FOUND)
Throws HTTP error.
at line 677
string
backlink()
Link to myself.
at line 687
Request
getLastCreatedRequest()
Returns the last created Request.
at line 698
bool
getLastCreatedRequestFlag($flag)
Returns the last created Request flag.
at line 709
void
canonicalize()
Conditional redirect to canonicalized URI.
at line 731
void
lastModified($lastModified, $etag = NULL, $expire = NULL)
deprecated
deprecated
Attempts to cache the sent entity by its last modification date.
at line 753
protected string
createRequest($component, $destination, array $args, $mode)
| internal |
Request/URL factory.
at line 1035
protected string
handleInvalidLink(InvalidLinkException $e)
Invalid link handler. Descendant can override this method to change default behaviour.
at line 1057
string
storeRequest($expiration = '+ 10 minutes')
Stores current request to session.
at line 1075
void
restoreRequest($key)
Restores request from session.
at line 1099
static array
getPersistentComponents()
Returns array of persistent components.
This default implementation detects components by class-level annotation @persistent(cmp1, cmp2).
at line 1178
protected void
saveGlobalState()
Permanently saves state information for all subcomponents to $this->globalState.
at line 1243
array
popGlobalParameters($id)
Pops parameters for specified component.
at line 1263
bool
hasFlashSession()
Checks if a flash session namespace exists.
at line 1274
SessionSection
getFlashSession()
Returns session namespace provided to pass temporary data between redirects.
at line 1289
void
injectPrimary(Container $context)
No description
at line 1299
SystemContainer|Container
getContext()
Gets the context.
at line 1308
getService($name)
deprecated
deprecated
No description
at line 1317
protected Request
getHttpRequest()
No description
at line 1326
protected Response
getHttpResponse()
No description
at line 1335
protected Context
getHttpContext()
No description
at line 1344
Application
getApplication()
No description
at line 1354
Session|SessionSection
getSession($namespace = NULL)
No description
at line 1364
User
getUser()
No description