Class PresenterComponent

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.

Object

Component implements IComponent

ComponentContainer implements IComponentContainer

PresenterComponent implements ISignalReceiver, IStatePersistent, ArrayAccess

Direct known subclasses

Control, Multiplier

Indirect known subclasses

Presenter

Abstract
Package: Nette\Application\UI
Author: David Grudl
Located at Application/UI/PresenterComponent.php

Methods summary
`public Presenter\|null`	# `getPresenter( boolean $need = TRUE )` Returns the presenter where this component belongs to. Returns the presenter where this component belongs to. Parameters `$need` `boolean` throw exception if presenter doesn't exist? Returns `Presenter\|null`
`public string`	# `getUniqueId( )` Returns a fully-qualified name that uniquely identifies the component within the presenter hierarchy. Returns a fully-qualified name that uniquely identifies the component within the presenter hierarchy. Returns `string`
`protected`	# `attached( IComponent $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. This method will be called when the component (or component's parent) becomes attached to a monitored object. Do not call this method yourself. Parameters `$presenter` `IComponent` Overrides `Component::attached()`
`protected`	# `validateParent( IComponentContainer $parent )` Throws `InvalidStateException` Overrides `Component::validateParent()`
`protected boolean`	# `tryCall( string $method, array $params )` Calls public method if exists. Calls public method if exists. Parameters `$method` `string` `$params` `array` Returns `boolean` does method exist?
`public`	# `checkRequirements( $element )` Checks for requirements such as authorization. Checks for requirements such as authorization.
`public PresenterComponentReflection`	# `getReflection( )` Access to reflection. Access to reflection. Returns `PresenterComponentReflection` Overrides `Object::getReflection()`
`public`	# `loadState( array $params )` Loads state informations. Loads state informations. Parameters `$params` `array` Implementation of `IStatePersistent::loadState()`
`public`	# `saveState( array & $params, PresenterComponentReflection $reflection = NULL )` Saves state informations for next request. Saves state informations for next request. Parameters `$params` `array` `$reflection` `PresenterComponentReflection` (internal, used by Presenter) Implementation of `IStatePersistent::saveState()`
`public mixed`	# `getParameter( string $name = NULL, mixed $default = NULL )` Returns component param. If no key is passed, returns the entire array. Returns component param. If no key is passed, returns the entire array. Parameters `$name` `string` key `$default` `mixed` default value Returns `mixed`
`public string`	# `getParameterId( string $name )` Returns a fully-qualified name that uniquely identifies the parameter. Returns a fully-qualified name that uniquely identifies the parameter. Parameters `$name` `string` Returns `string`
`public`	# `getParam( $name = NULL, $default = NULL )` Deprecated
`public`	# `getParamId( $name )` Deprecated
`public 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. Returns array of classes persistent parameters. They have public visibility and are non-static. This default implementation detects persistent parameters by annotation @persistent. Returns `array`
`public`	# `signalReceived( string $signal )` Calls signal handler method. Calls signal handler method. Parameters `$signal` `string` Throws `BadSignalException` if there is not handler method Implementation of `ISignalReceiver::signalReceived()`
`public string`	# `formatSignalMethod( string $signal )` Formats signal handler method name -> case sensitivity doesn't matter. Formats signal handler method name -> case sensitivity doesn't matter. Parameters `$signal` `string` Returns `string`
`public string`	# `link( string $destination, array\|mixed $args = array() )` Generates URL to presenter, action or signal. Generates URL to presenter, action or signal. Parameters `$destination` `string` destination in format "[[module:]presenter:]action" or "signal!" or "this" `$args` `array\|mixed` Returns `string` Throws `InvalidLinkException`
`public Link`	# `lazyLink( string $destination, array\|mixed $args = array() )` Returns destination as Link object. Returns destination as Link object. Parameters `$destination` `string` destination in format "[[module:]presenter:]view" or "signal!" `$args` `array\|mixed` Returns `Link`
`public boolean`	# `isLinkCurrent( string $destination = NULL, array\|mixed $args = array() )` Determines whether it links to the current page. Determines whether it links to the current page. Parameters `$destination` `string` destination in format "[[module:]presenter:]action" or "signal!" or "this" `$args` `array\|mixed` Returns `boolean` Throws `InvalidLinkException`
`public`	# `redirect( integer $code, string $destination = NULL, array\|mixed $args = array() )` Redirect to another presenter, action or signal. Redirect to another presenter, action or signal. Parameters `$code` `integer` [optional] HTTP error code `$destination` `string` destination in format "[[module:]presenter:]view" or "signal!" `$args` `array\|mixed` Throws `AbortException`
`public`	# `offsetSet( string $name, IComponent $component )` Adds the component to the container. Adds the component to the container. Parameters `$name` `string` component name `$component` `IComponent` Implementation of `ArrayAccess::offsetSet()`
`public IComponent`	# `offsetGet( string $name )` Returns component specified by name. Throws exception if component doesn't exist. Returns component specified by name. Throws exception if component doesn't exist. Parameters `$name` `string` component name Returns `IComponent` Throws `InvalidArgumentException` Implementation of `ArrayAccess::offsetGet()`
`public boolean`	# `offsetExists( string $name )` Does component specified by name exists? Does component specified by name exists? Parameters `$name` `string` component name Returns `boolean` Implementation of `ArrayAccess::offsetExists()`
`public`	# `offsetUnset( string $name )` Removes component from the container. Removes component from the container. Parameters `$name` `string` component name Implementation of `ArrayAccess::offsetUnset()`

Methods inherited from ComponentContainer
`__clone(), addComponent(), createComponent(), getComponent(), getComponents(), removeComponent(), validateChildComponent()`

Methods inherited from Component
`__construct(), __sleep(), __wakeup(), detached(), getName(), getParent(), lookup(), lookupPath(), monitor(), unmonitor()`

Methods inherited from Object
`__call(), __callStatic(), __get(), __isset(), __set(), __unset(), extensionMethod()`

Methods inherited from IComponent
`setParent()`

Constants inherited from IComponent
`NAME_SEPARATOR`

Properties summary
`protected array`	`$params`	`array()`	#

Magic properties summary
`public read-only Presenter`	`$presenter`	#
`public read-only string`	`$uniqueId`	#

Magic properties inherited from ComponentContainer
`$components`

Magic properties inherited from Component
`$name, $parent`

Magic properties inherited from Object
`$reflection`

Packages

Classes

Interfaces

Exceptions

Class PresenterComponent

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Returns

Parameters

Overrides

Throws

Overrides

Parameters

Returns

Returns

Overrides

Parameters

Implementation of

Parameters

Implementation of

Parameters

Returns

Parameters

Returns

Deprecated

Deprecated

Returns

Parameters

Throws

Implementation of

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Parameters

Throws

Parameters

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of