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[] | $onShutdown | ||
| bool | $autoCanonicalize | ||
| bool | $absoluteUrls | ||
| string | $view | ||
| string | $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.
Throws HTTP error.
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.
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 124
__construct()
No description
at line 133
Request
getRequest()
No description
at line 143
Presenter|null
getPresenter($need = TRUE)
Returns self.
at line 153
string
getUniqueId()
Returns a name that uniquely identifies component.
at line 253
protected void
startup()
No description
at line 263
protected void
beforeRender()
Common render method.
at line 272
protected void
afterRender()
Common render method.
at line 281
protected void
shutdown($response)
No description
at line 290
void
checkRequirements($element)
Checks authorization.
at line 306
void
processSignal()
No description
at line 333
array|null
getSignal()
Returns pair signal receiver and name.
at line 345
bool
isSignalReceiver($component, $signal = NULL)
Checks if the signal receiver is the given one.
at line 374
string
getAction($fullyQualified = FALSE)
Returns current action name.
at line 385
void
changeAction($action)
Changes current action. Only alphanumeric characters are allowed.
at line 401
string
getView()
Returns current view.
at line 412
Presenter
setView($view)
Changes current view. Any name is allowed.
at line 423
string|false
getLayout()
Returns current layout name.
at line 434
Presenter
setLayout($layout)
Changes or disables layout.
at line 446
void
sendTemplate()
No description
at line 474
string
findLayoutTemplateFile()
| internal |
Finds layout template file name.
at line 498
array
formatLayoutTemplateFiles()
Formats layout template file names.
at line 521
array
formatTemplateFiles()
Formats view template file names.
at line 539
static string
formatActionMethod($action)
Formats action method name.
at line 550
static string
formatRenderMethod($view)
Formats render view method name.
at line 559
protected ITemplate
createTemplate()
No description
at line 571
stdClass
getPayload()
No description
at line 581
bool
isAjax()
Is AJAX request?
at line 595
void
sendPayload()
Sends AJAX payload to the output.
at line 607
void
sendJson($data)
Sends JSON data to the output.
at line 621
void
sendResponse(IResponse $response)
Sends response and terminates presenter.
at line 633
void
terminate()
Correctly terminates presenter.
at line 646
void
forward($destination, $args = array())
Forward to another presenter or action.
at line 664
void
redirectUrl($url, $code = NULL)
Redirect to another URL and ends presenter execution.
at line 686
void
error($message = NULL, $code = Http\IResponse::S404_NOT_FOUND)
Throws HTTP error.
at line 697
string
backlink()
deprecated
deprecated
Link to myself.
at line 708
Request
getLastCreatedRequest()
| internal |
Returns the last created Request.
at line 720
bool
getLastCreatedRequestFlag($flag)
| internal |
Returns the last created Request flag.
at line 731
void
canonicalize()
Conditional redirect to canonicalized URI.
at line 753
void
lastModified($lastModified, $etag = NULL, $expire = NULL)
Attempts to cache the sent entity by its last modification date.
at line 775
protected string
createRequest($component, $destination, array $args, $mode)
| internal |
Request/URL factory.
at line 1007
static void
argsToParams($class, $method, $args, $supplemental = array(), $ignoreMissing = FALSE)
| internal |
Converts list of arguments to named parameters.
at line 1061
protected string
handleInvalidLink(InvalidLinkException $e)
Invalid link handler. Descendant can override this method to change default behaviour.
at line 1082
string
storeRequest($expiration = '+ 10 minutes')
Stores current request to session.
at line 1100
void
restoreRequest($key)
Restores request from session.
at line 1124
static array
getPersistentComponents()
Returns array of persistent components.
This default implementation detects components by class-level annotation @persistent(cmp1, cmp2).
at line 1134
protected array
getGlobalState($forClass = NULL)
Saves state information for all subcomponents to $this->globalState.
at line 1202
protected void
saveGlobalState()
Permanently saves state information for all subcomponents to $this->globalState.
at line 1271
array
popGlobalParameters($id)
| internal |
Pops parameters for specified component.
at line 1291
bool
hasFlashSession()
Checks if a flash session namespace exists.
at line 1302
SessionSection
getFlashSession()
Returns session namespace provided to pass temporary data between redirects.
at line 1314
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 1337
Container
getContext()
deprecated
deprecated
Gets the context.
at line 1349
protected IRequest
getHttpRequest()
No description
at line 1358
protected IResponse
getHttpResponse()
No description
at line 1368
Session|SessionSection
getSession($namespace = NULL)
No description
at line 1380
User
getUser()
No description
at line 1392
ITemplateFactory
getTemplateFactory()
No description