A

AbortException

The exception that is thrown when user attempts to terminate the current presenter or application.

AppForm

Web form as presenter component.

AppForm::attached() — Method in class AppForm

This method will be called when the component (or component's parent) becomes attached to a monitored object. Do not call this method yourself.

Application

Front Controller.

$ Application#allowedMethodsProperty in class Application
ApplicationException

Application fatal error.

$ Presenter#autoCanonicalizeProperty in class Presenter
$ Presenter#absoluteUrlsProperty in class Presenter
$ Presenter#actionProperty in class Presenter
$ Presenter#applicationProperty in class Presenter
Presenter::afterRender() — Method in class Presenter

Common render method.

PresenterComponent::attached() — Method in class PresenterComponent

This method will be called when the component (or component's parent) becomes attached to a monitored object. Do not call this method yourself.

PresenterComponent::ajaxLink() — Method in class PresenterComponent
PresenterHelpers::argsToParams() — Method in class PresenterHelpers

Converts list of arguments to named parameters.

Route::addStyle() — Method in class Route

Creates new style.

B

BadRequestException

Bad HTTP / presenter request exception.

BadSignalException

Signal exception.

Presenter::beforeRender() — Method in class Presenter

Common render method.

Presenter::backlink() — Method in class Presenter

Link to myself.

C

$ Application#catchExceptionsProperty in class Application
Application::createPresenterLoader() — Method in class Application
CliRouter

The unidirectional router for CLI. (experimental)

CliRouter::constructUrl() — Method in class CliRouter

This router is only unidirectional.

Control

Control is renderable component.

Control::createTemplate() — Method in class Control
IRouter::constructUrl() — Method in class IRouter

Constructs absolute URL from PresenterRequest object.

MultiRouter::constructUrl() — Method in class MultiRouter

Constructs absolute URL from PresenterRequest object.

Presenter::changeAction() — Method in class Presenter

Changes current action. Only alphanumeric characters are allowed.

Presenter::canonicalize() — Method in class Presenter

Conditional redirect to canonicalized URI.

Presenter::createRequest() — Method in class Presenter

PresenterRequest/URL factory.

$ PresenterLoader#caseSensitiveProperty in class PresenterLoader
Route::constructUrl() — Method in class Route

Constructs absolute URL from PresenterRequest object.

SimpleRouter::constructUrl() — Method in class SimpleRouter

Constructs absolute URL from PresenterRequest object.

D

$ Application#defaultServicesProperty in class Application
$ BadRequestException#defaultCodeProperty in class BadRequestException
$ BadSignalException#defaultCodeProperty in class BadSignalException
DownloadResponse

File download response.

$ Presenter#defaultActionProperty in class Presenter
$ Route#defaultFlagsProperty in class Route

E

$ Application#errorPresenterProperty in class Application

F

Control::flashMessage() — Method in class Control

Saves the message to template, that can be displayed after redirect.

ForwardingResponse

Forwards to new request.

Presenter::formatLayoutTemplateFiles() — Method in class Presenter

Formats layout template file names.

Presenter::formatTemplateFiles() — Method in class Presenter

Formats view template file names.

Presenter::formatActionMethod() — Method in class Presenter

Formats action method name.

Presenter::formatRenderMethod() — Method in class Presenter

Formats render view method name.

Presenter::forward() — Method in class Presenter

Forward to another presenter or action.

PresenterComponent::formatSignalMethod() — Method in class PresenterComponent

Formats signal handler method name -> case sensitivity doesn't matter.

PresenterLoader::formatPresenterClass() — Method in class PresenterLoader

Formats presenter class name from its name.

PresenterLoader::formatPresenterFile() — Method in class PresenterLoader

Formats presenter class file name.

$ PresenterRequest#filesProperty in class PresenterRequest

G

AppForm::getPresenter() — Method in class AppForm

Returns the presenter where this component belongs to.

Application::getRequests() — Method in class Application

Returns all processed requests.

Application::getPresenter() — Method in class Application

Returns current presenter.

Application::getServiceLocator() — Method in class Application

Gets the service locator (experimental).

Application::getService() — Method in class Application

Gets the service object of the specified type.

Application::getRouter() — Method in class Application

Returns router.

Application::getPresenterLoader() — Method in class Application

Returns presenter loader.

Application::getHttpRequest() — Method in class Application
Application::getHttpResponse() — Method in class Application
Application::getSession() — Method in class Application
CliRouter::getDefaults() — Method in class CliRouter

Returns default values.

Control::getTemplate() — Method in class Control
Control::getWidget() — Method in class Control

Returns widget component specified by name.

Control::getSnippetId() — Method in class Control

Returns snippet HTML ID.

DownloadResponse::getFile() — Method in class DownloadResponse

Returns the path to an downloaded file.

DownloadResponse::getName() — Method in class DownloadResponse

Returns the file name.

DownloadResponse::getContentType() — Method in class DownloadResponse

Returns the MIME content type of an downloaded file.

ForwardingResponse::getRequest() — Method in class ForwardingResponse
IPresenterLoader::getPresenterClass() — Method in class IPresenterLoader
JsonResponse::getPayload() — Method in class JsonResponse
Link::getDestination() — Method in class Link

Returns link destination.

Link::getParam() — Method in class Link

Returns link parameter.

Link::getParams() — Method in class Link

Returns link parameters.

Presenter::getRequest() — Method in class Presenter
Presenter::getPresenter() — Method in class Presenter

Returns self.

Presenter::getUniqueId() — Method in class Presenter

Returns a name that uniquely identifies component.

Presenter::getPhase() — Method in class Presenter

Returns current presenter life cycle phase.

Presenter::getSignal() — Method in class Presenter

Returns pair signal receiver and name.

Presenter::getAction() — Method in class Presenter

Returns current action name.

Presenter::getView() — Method in class Presenter

Returns current view.

Presenter::getLayout() — Method in class Presenter

Returns current layout name.

Presenter::getPayload() — Method in class Presenter
Presenter::getAjaxDriver() — Method in class Presenter
Presenter::getLastCreatedRequest() — Method in class Presenter

Returns the last created PresenterRequest.

Presenter::getLastCreatedRequestFlag() — Method in class Presenter

Returns the last created PresenterRequest flag.

Presenter::getPersistentComponents() — Method in class Presenter

Returns array of persistent components.

Presenter::getFlashSession() — Method in class Presenter

Returns session namespace provided to pass temporary data between redirects.

Presenter::getHttpRequest() — Method in class Presenter
Presenter::getHttpResponse() — Method in class Presenter
Presenter::getApplication() — Method in class Presenter
Presenter::getSession() — Method in class Presenter
Presenter::getUser() — Method in class Presenter
PresenterComponent::getPresenter() — Method in class PresenterComponent

Returns the presenter where this component belongs to.

PresenterComponent::getUniqueId() — Method in class PresenterComponent

Returns a fully-qualified name that uniquely identifies the component within the presenter hierarchy.

PresenterComponent::getParam() — Method in class PresenterComponent

Returns component param.

PresenterComponent::getParamId() — Method in class PresenterComponent

Returns a fully-qualified name that uniquely identifies the parameter.

PresenterComponent::getPersistentParams() — Method in class PresenterComponent

Returns array of classes persistent parameters. They have public visibility and are non-static.

PresenterHelpers::getPersistentParams() — Method in class PresenterHelpers

Returns array of classes persistent parameters.

PresenterHelpers::getPersistentComponents() — Method in class PresenterHelpers

Returns array of classes persistent components.

PresenterLoader::getPresenterClass() — Method in class PresenterLoader
PresenterRequest::getPresenterName() — Method in class PresenterRequest

Retrieve the presenter name.

PresenterRequest::getParams() — Method in class PresenterRequest

Returns all variables provided to the presenter (usually via URL).

PresenterRequest::getPost() — Method in class PresenterRequest

Returns all variables provided to the presenter via POST.

PresenterRequest::getFiles() — Method in class PresenterRequest

Returns all uploaded files.

PresenterRequest::getMethod() — Method in class PresenterRequest

Returns the method.

RedirectingResponse::getUri() — Method in class RedirectingResponse
RedirectingResponse::getCode() — Method in class RedirectingResponse
RenderResponse::getSource() — Method in class RenderResponse
Route::getMask() — Method in class Route

Returns mask.

Route::getDefaults() — Method in class Route

Returns default values.

Route::getTargetPresenter() — Method in class Route

Proprietary cache aim.

SimpleRouter::getDefaults() — Method in class SimpleRouter

Returns default values.

H

Presenter::handleInvalidLink() — Method in class Presenter

Invalid link handler. Descendant can override this method to change default behaviour.

Presenter::hasFlashSession() — Method in class Presenter

Checks if a flash session namespace exists.

PresenterRequest::hasFlag() — Method in class PresenterRequest

Checks the flag.

I

AppForm::isAnchored() — Method in class AppForm

Tells if the form is anchored.

Control::invalidateControl() — Method in class Control

Forces control or its snippet to repaint.

Control::isControlInvalid() — Method in class Control

Is required to repaint the control or its snippet?

IPartiallyRenderable
IPresenter

Defines method that must be implemented to allow a component to act like a presenter.

IPresenterLoader

Responsible for loading presenters.

IPresenterResponse

Any response returned by presenter.

IRenderable
IRenderable::invalidateControl() — Method in class IRenderable

Forces control to repaint.

IRenderable::isControlInvalid() — Method in class IRenderable

Is required to repaint the control?

IRouter

The bi-directional router.

ISignalReceiver

Component with ability to receive signal.

IStatePersistent

Component with ability to save and load its state.

InvalidLinkException

Link generation exception.

InvalidPresenterException

The exception that is thrown when a presenter cannot be loaded.

$ Presenter#invalidLinkModeProperty in class Presenter
Presenter::isSignalReceiver() — Method in class Presenter

Checks if the signal receiver is the given one.

Presenter::isAjax() — Method in class Presenter

Is AJAX request?

PresenterHelpers::isMethodCallable() — Method in class PresenterHelpers

Is a method callable? It means class is instantiable and method has public visibility, is non-static and non-abstract.

PresenterRequest::isMethod() — Method in class PresenterRequest

Checks if the method is the given one.

PresenterRequest::isPost() — Method in class PresenterRequest

Checks if the method is POST.

J

JsonResponse

JSON response used for AJAX requests.

L

IStatePersistent::loadState() — Method in class IStatePersistent

Loads state informations.

Link

Lazy encapsulation of PresenterComponent::link().

$ Presenter#layoutProperty in class Presenter
Presenter::lastModified() — Method in class Presenter

Attempts to cache the sent entity by its last modification date

PresenterComponent::loadState() — Method in class PresenterComponent

Loads state informations.

PresenterComponent::link() — Method in class PresenterComponent

Generates URL to presenter, action or signal.

PresenterComponent::lazyLink() — Method in class PresenterComponent

Returns destination as Link object.

M

$ Application#maxLoopProperty in class Application
CliRouter::match() — Method in class CliRouter

Maps command line arguments to a PresenterRequest object.

IRouter::match() — Method in class IRouter

Maps HTTP request to a PresenterRequest object.

MultiRouter

The router broker.

MultiRouter::match() — Method in class MultiRouter

Maps HTTP request to a PresenterRequest object.

Route::match() — Method in class Route

Maps HTTP request to a PresenterRequest object.

SimpleRouter::match() — Method in class SimpleRouter

Maps HTTP request to a PresenterRequest object.

O

$ Application#onStartupProperty in class Application
$ Application#onShutdownProperty in class Application
$ Application#onRequestProperty in class Application
$ Application#onErrorProperty in class Application
$ Presenter#onShutdownProperty in class Presenter
$ Presenter#oldLayoutModeProperty in class Presenter
$ Presenter#oldModuleModeProperty in class Presenter
PresenterComponent::offsetSet() — Method in class PresenterComponent

Adds the component to the container.

PresenterComponent::offsetGet() — Method in class PresenterComponent

Returns component specified by name. Throws exception if component doesn't exist.

PresenterComponent::offsetExists() — Method in class PresenterComponent

Does component specified by name exists?

PresenterComponent::offsetUnset() — Method in class PresenterComponent

Removes component from the container. Throws exception if component doesn't exist.

P

$ AppForm#presenterProperty in class AppForm
Presenter

Presenter object represents a webpage instance. It executes all the logic for the request.

$ Presenter#phaseProperty in class Presenter
$ Presenter#payloadProperty in class Presenter
Presenter::processSignal() — Method in class Presenter
Presenter::popGlobalParams() — Method in class Presenter

Pops parameters for specified component.

PresenterComponent

PresenterComponent is the base class for all presenters components.

$ PresenterComponent#paramsProperty in class PresenterComponent
$ PresenterComponent#presenterProperty in class PresenterComponent
PresenterHelpers

Helpers for Presenter & PresenterComponent.

PresenterHelpers::paramsToArgs() — Method in class PresenterHelpers

Converts named parameters to list of arguments.

PresenterLoader

Default presenter loader.

PresenterRequest

Presenter request. Immutable object.

$ PresenterRequest#presenterNameProperty in class PresenterRequest
$ PresenterRequest#paramsProperty in class PresenterRequest
$ PresenterRequest#postProperty in class PresenterRequest

R

AppForm::receiveHttpData() — Method in class AppForm

Internal: receives submitted HTTP data.

Application::run() — Method in class Application

Dispatch a HTTP request to a front controller.

Application::restoreRequest() — Method in class Application

Restores current request to session.

IPresenter::run() — Method in class IPresenter
$ Presenter#requestProperty in class Presenter
Presenter::run() — Method in class Presenter
Presenter::renderTemplate() — Method in class Presenter
Presenter::redirectUri() — Method in class Presenter

Redirect to another URL and ends presenter execution.

PresenterComponent::redirect() — Method in class PresenterComponent

Redirect to another presenter, action or signal.

RedirectingResponse

Redirects to new request.

RenderResponse

Rendering presenter response.

Route

The bidirectional route is responsible for mapping HTTP request to a PresenterRoute object for dispatch and vice-versa.

S

AppForm::signalReceived() — Method in class AppForm

This method is called by presenter.

Application::setRouter() — Method in class Application

Changes router.

Application::storeRequest() — Method in class Application

Stores current request to session.

DownloadResponse::send() — Method in class DownloadResponse

Sends response to output.

ForwardingResponse::send() — Method in class ForwardingResponse

Sends response to output.

IPresenterResponse::send() — Method in class IPresenterResponse

Sends response to output.

ISignalReceiver::signalReceived() — Method in class ISignalReceiver
IStatePersistent::saveState() — Method in class IStatePersistent

Saves state informations for next request.

JsonResponse::send() — Method in class JsonResponse

Sends response to output.

Link::setParam() — Method in class Link

Changes link parameter.

$ Presenter#signalProperty in class Presenter
Presenter::startup() — Method in class Presenter
Presenter::shutdown() — Method in class Presenter
Presenter::setView() — Method in class Presenter

Changes current view. Any name is allowed.

Presenter::setLayout() — Method in class Presenter

Changes or disables layout.

Presenter::sendTemplate() — Method in class Presenter
Presenter::sendPayload() — Method in class Presenter

Sends AJAX payload to the output.

Presenter::saveGlobalState() — Method in class Presenter

Permanently saves state information for all subcomponents to $this->globalState.

PresenterComponent::saveState() — Method in class PresenterComponent

Saves state informations for next request.

PresenterComponent::signalReceived() — Method in class PresenterComponent

Calls signal handler method.

PresenterRequest::setPresenterName() — Method in class PresenterRequest

Sets the presenter name.

PresenterRequest::setParams() — Method in class PresenterRequest

Sets variables provided to the presenter.

PresenterRequest::setPost() — Method in class PresenterRequest

Sets variables provided to the presenter via POST.

PresenterRequest::setFiles() — Method in class PresenterRequest

Sets all uploaded files.

PresenterRequest::setMethod() — Method in class PresenterRequest

Sets the method.

PresenterRequest::setFlag() — Method in class PresenterRequest

Sets the flag.

RedirectingResponse::send() — Method in class RedirectingResponse

Sends response to output.

RenderResponse::send() — Method in class RenderResponse

Sends response to output.

$ Route#stylesProperty in class Route
Route::setStyleProperty() — Method in class Route

Changes style property value.

SimpleRouter

The bidirectional route for trivial routing via query string.

T

$ Control#templateProperty in class Control
Control::templatePrepareFilters() — Method in class Control

Descendant can override this method to customize template compile-time filters.

Presenter::terminate() — Method in class Presenter

Correctly terminates presenter.

PresenterComponent::tryCall() — Method in class PresenterComponent

Calls public method if exists.

U

PresenterLoader::unformatPresenterClass() — Method in class PresenterLoader

Formats presenter name from class name.

V

Control::validateControl() — Method in class Control

Allows control or its snippet to not repaint.

$ Presenter#viewProperty in class Presenter

_

AppForm::__construct() — Method in class AppForm

Application form constructor.

ApplicationException::__construct() — Method in class ApplicationException
BadRequestException::__construct() — Method in class BadRequestException
CliRouter::__construct() — Method in class CliRouter
DownloadResponse::__construct() — Method in class DownloadResponse
ForwardingResponse::__construct() — Method in class ForwardingResponse
JsonResponse::__construct() — Method in class JsonResponse
Link::__construct() — Method in class Link

Link specification.

Link::__toString() — Method in class Link

Converts link to URL.

MultiRouter::__construct() — Method in class MultiRouter
PresenterComponent::__construct() — Method in class PresenterComponent
PresenterHelpers::__construct() — Method in class PresenterHelpers

Static class - cannot be instantiated.

PresenterLoader::__construct() — Method in class PresenterLoader
PresenterRequest::__construct() — Method in class PresenterRequest
RedirectingResponse::__construct() — Method in class RedirectingResponse
RenderResponse::__construct() — Method in class RenderResponse
Route::__construct() — Method in class Route
SimpleRouter::__construct() — Method in class SimpleRouter