abstract class Component extends Container implements SignalReceiver, StatePersistent, ArrayAccess

Component 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

$onAnchor
protected $params

Methods

getPresenter()

Returns the presenter where this component belongs to.

Presenter|null
getPresenterIfExists()

Returns the presenter where this component belongs to.

bool
hasPresenter()

No description

string
getUniqueId()

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

addComponent(IComponent $component, string|null $name, string|null $insertBefore = null)

No description

void
validateParent(IContainer $parent)

No description

bool
tryCall(string $method, array $params)

Calls public method if exists.

void
checkRequirements($element)

Checks for requirements such as authorization.

getReflection()

Access to reflection.

void
loadState(array $params)

Loads state informations.

void
saveState(array $params)

Saves state informations for next request.

mixed
getParameter(string $name, $default = null)

Returns component param.

array
getParameters()

Returns component parameters.

string
getParameterId(string $name)

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

void
signalReceived(string $signal)

No description

static string
formatSignalMethod(string $signal)

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

string
link(string $destination, mixed ...$args)

Generates URL to presenter, action or signal.

lazyLink(string $destination, mixed ...$args)

Returns destination as Link object.

bool
isLinkCurrent(string|null $destination = null, mixed ...$args)

Determines whether it links to the current page.

void
redirect(string $destination, mixed ...$args)

Redirect to another presenter, action or signal.

void
redirectPermanent(string $destination, mixed ...$args)

Permanently redirects to presenter, action or signal.

void
error(string $message = '', int $httpCode = Nette\Http\IResponse::S404_NOT_FOUND)

Throws HTTP error.

Details

at line 38
Presenter getPresenter()

Returns the presenter where this component belongs to.

Return Value

Presenter

at line 47
Presenter|null getPresenterIfExists()

Returns the presenter where this component belongs to.

Return Value

Presenter|null

at line 53
bool hasPresenter()

No description

Return Value

bool

at line 63
string getUniqueId()

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

Return Value

string

at line 69
Component addComponent(IComponent $component, string|null $name, string|null $insertBefore = null)

No description

Parameters

IComponent $component
string|null $name
string|null $insertBefore

Return Value

Component

at line 82
protected void validateParent(IContainer $parent)

No description

Parameters

IContainer $parent

Return Value

void

at line 95
protected bool tryCall(string $method, array $params)

Calls public method if exists.

Parameters

string $method
array $params

Return Value

bool

at line 124
void checkRequirements($element)

Checks for requirements such as authorization.

Parameters

$element

Return Value

void

at line 148
static ComponentReflection getReflection()

Access to reflection.

Return Value

ComponentReflection

at line 160
void loadState(array $params)

Loads state informations.

Parameters

array $params

Return Value

void

at line 188
void saveState(array $params)

Saves state informations for next request.

Parameters

array $params

Return Value

void

at line 197
final mixed getParameter(string $name, $default = null)

Returns component param.

Parameters

string $name
$default

Return Value

mixed

at line 206
final array getParameters()

Returns component parameters.

Return Value

array

at line 215
final string getParameterId(string $name)

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

Parameters

string $name

Return Value

string

at line 229
void signalReceived(string $signal)

No description

Parameters

string $signal

Return Value

void

at line 241
static string formatSignalMethod(string $signal)

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

Parameters

string $signal

Return Value

string

Generates URL to presenter, action or signal.

Parameters

string $destination

in format "[//] [[[module:]presenter:]action | signal! | this] [#fragment]"

mixed ...$args

Return Value

string

Exceptions

InvalidLinkException

Returns destination as Link object.

Parameters

string $destination

in format "[//] [[[module:]presenter:]action | signal! | this] [#fragment]"

mixed ...$args

Return Value

Link

at line 290
bool isLinkCurrent(string|null $destination = null, mixed ...$args)

Determines whether it links to the current page.

Parameters

string|null $destination

in format "[//] [[[module:]presenter:]action | signal! | this] [#fragment]"

mixed ...$args

Return Value

bool

Exceptions

InvalidLinkException

at line 309
void redirect(string $destination, mixed ...$args)

Redirect to another presenter, action or signal.

Parameters

string $destination

in format "[//] [[[module:]presenter:]action | signal! | this] [#fragment]"

mixed ...$args

Return Value

void

Exceptions

AbortException

at line 325
void redirectPermanent(string $destination, mixed ...$args)

Permanently redirects to presenter, action or signal.

Parameters

string $destination

in format "[//] [[[module:]presenter:]action | signal! | this] [#fragment]"

mixed ...$args

Return Value

void

Exceptions

AbortException

at line 342
void error(string $message = '', int $httpCode = Nette\Http\IResponse::S404_NOT_FOUND)

Throws HTTP error.

Parameters

string $message
int $httpCode

Return Value

void

Exceptions

BadRequestException

Traits

ArrayAccess