PresenterComponent
abstract class PresenterComponent extends Container implements ISignalReceiver, IStatePersistent, ArrayAccess
PresenterComponent is the base class for all Presenter components.
Components are persistent objects located on a presenter. They have ability to own other child components, and interact with user. Components have properties for storing their status, and responds to user command.
Properties
| protected array | $params | ||
| Presenter read-only | $presenter | ||
| string read-only | $uniqueId |
Methods
Returns the presenter where this component belongs to.
Returns a fully-qualified name that uniquely identifies the component within the presenter hierarchy.
This method will be called when the component (or component's parent) becomes attached to a monitored object. Do not call this method yourself.
No description
Calls public method if exists.
Checks for requirements such as authorization.
Access to reflection.
Loads state informations.
Saves state informations for next request.
Returns component param.
Returns a fully-qualified name that uniquely identifies the parameter.
Returns array of classes persistent parameters. They have public visibility and are non-static.
Calls signal handler method.
Formats signal handler method name -> case sensitivity doesn't matter.
Generates URL to presenter, action or signal.
Determines whether it links to the current page.
Redirect to another presenter, action or signal.
Adds the component to the container.
Returns component specified by name. Throws exception if component doesn't exist.
Does component specified by name exists?
Removes component from the container.
Details
at line 36
Presenter|null
getPresenter($need = TRUE)
Returns the presenter where this component belongs to.
at line 47
string
getUniqueId()
Returns a fully-qualified name that uniquely identifies the component within the presenter hierarchy.
at line 59
protected void
attached($presenter)
This method will be called when the component (or component's parent) becomes attached to a monitored object. Do not call this method yourself.
at line 70
protected void
validateParent(IContainer $parent)
No description
at line 83
protected bool
tryCall($method, array $params)
Calls public method if exists.
at line 102
void
checkRequirements($element)
Checks for requirements such as authorization.
at line 111
static PresenterComponentReflection
getReflection()
Access to reflection.
at line 125
void
loadState(array $params)
Loads state informations.
at line 149
void
saveState(array $params, $reflection = NULL)
Saves state informations for next request.
at line 186
mixed
getParameter($name = NULL, $default = NULL)
Returns component param.
If no key is passed, returns the entire array.
at line 205
string
getParameterId($name)
Returns a fully-qualified name that uniquely identifies the parameter.
at line 213
getParam($name = NULL, $default = NULL)
deprecated
deprecated
No description
at line 221
getParamId($name)
deprecated
deprecated
No description
at line 233
static array
getPersistentParams()
Returns array of classes persistent parameters. They have public visibility and are non-static.
This default implementation detects persistent parameters by annotation @persistent.
at line 255
void
signalReceived($signal)
Calls signal handler method.
at line 269
string
formatSignalMethod($signal)
Formats signal handler method name -> case sensitivity doesn't matter.
at line 285
string
link($destination, $args = array())
Generates URL to presenter, action or signal.
at line 302
Link
lazyLink($destination, $args = array())
Returns destination as Link object.
at line 315
bool
isLinkCurrent($destination = NULL, $args = array())
Determines whether it links to the current page.
at line 332
void
redirect($code, $destination = NULL, $args = array())
Redirect to another presenter, action or signal.
at line 358
void
offsetSet($name, $component)
Adds the component to the container.
at line 370
IComponent
offsetGet($name)
Returns component specified by name. Throws exception if component doesn't exist.
at line 381
bool
offsetExists($name)
Does component specified by name exists?
at line 392
void
offsetUnset($name)
Removes component from the container.