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 array $params
Presenter read-only $presenter
bool read-only $linkCurrent

Methods

Presenter|null
getPresenter()

Returns the presenter where this component belongs to.

Presenter|null
getPresenterIfExists()

Returns the presenter where this component belongs to.

bool
hasPresenter() deprecated

No description

string
getUniqueId()

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

IComponent|null
createComponent(string $name)

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, array|mixed $args = [])

Generates URL to presenter, action or signal.

lazyLink(string $destination, array|mixed $args = [])

Returns destination as Link object.

bool
isLinkCurrent(string|null $destination = null, array|mixed $args = [])

Determines whether it links to the current page.

void
redirect(string $destination, array|mixed $args = [])

Redirect to another presenter, action or signal.

void
redirectPermanent(string $destination, array|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 40
Presenter|null getPresenter()

Returns the presenter where this component belongs to.

Return Value

Presenter|null

at line 54
Presenter|null getPresenterIfExists()

Returns the presenter where this component belongs to.

Return Value

Presenter|null

at line 61
bool hasPresenter() deprecated

deprecated

No description

Return Value

bool

at line 71
string getUniqueId()

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

Return Value

string

at line 77
protected IComponent|null createComponent(string $name)

No description

Parameters

string $name

Return Value

IComponent|null

at line 89
protected void validateParent(IContainer $parent)

No description

Parameters

IContainer $parent

Return Value

void

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

Calls public method if exists.

Parameters

string $method
array $params

Return Value

bool

does method exist?

at line 132
void checkRequirements($element)

Checks for requirements such as authorization.

Parameters

$element

Return Value

void

at line 149
static ComponentReflection getReflection()

Access to reflection.

Return Value

ComponentReflection

at line 161
void loadState(array $params)

Loads state informations.

Parameters

array $params

Return Value

void

at line 189
void saveState(array $params)

Saves state informations for next request.

Parameters

array $params

Return Value

void

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

Returns component param.

Parameters

string $name
$default

Return Value

mixed

at line 208
final array getParameters()

Returns component parameters.

Return Value

array

at line 217
final string getParameterId(string $name)

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

Parameters

string $name

Return Value

string

at line 231
void signalReceived(string $signal)

No description

Parameters

string $signal

Return Value

void

at line 243
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]"

array|mixed $args

Return Value

string

Exceptions

InvalidLinkException

Returns destination as Link object.

Parameters

string $destination

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

array|mixed $args

Return Value

Link

at line 292
bool isLinkCurrent(string|null $destination = null, array|mixed $args = [])

Determines whether it links to the current page.

Parameters

string|null $destination

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

array|mixed $args

Return Value

bool

Exceptions

InvalidLinkException

at line 311
void redirect(string $destination, array|mixed $args = [])

Redirect to another presenter, action or signal.

Parameters

string $destination

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

array|mixed $args

Return Value

void

Exceptions

AbortException

at line 327
void redirectPermanent(string $destination, array|mixed $args = [])

Permanently redirects to presenter, action or signal.

Parameters

string $destination

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

array|mixed $args

Return Value

void

Exceptions

AbortException

at line 344
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