Namespaces

  • Nette
    • Application
      • Diagnostics
      • Responses
      • Routers
      • UI
    • Caching
      • Storages
    • ComponentModel
    • Config
      • Adapters
      • Extensions
    • Database
      • Diagnostics
      • Drivers
      • Reflection
      • Table
    • DI
      • Diagnostics
    • Diagnostics
    • Forms
      • Controls
      • Rendering
    • Http
    • Iterators
    • Latte
      • Macros
    • Loaders
    • Localization
    • Mail
    • Reflection
    • Security
      • Diagnostics
    • Templating
    • Utils
      • PhpGenerator
  • NetteModule
  • None
  • PHP

Classes

  • Control
  • Form
  • Multiplier
  • Presenter
  • PresenterComponent

Interfaces

  • IRenderable
  • ISignalReceiver
  • IStatePersistent

Exceptions

  • BadSignalException
  • InvalidLinkException
  • Overview
  • Namespace
  • Class
  • Tree

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.

Nette\Object
Extended by Nette\ComponentModel\Component implements Nette\ComponentModel\IComponent
Extended by Nette\ComponentModel\Container implements Nette\ComponentModel\IContainer
Extended by Nette\Application\UI\PresenterComponent implements Nette\Application\UI\ISignalReceiver, Nette\Application\UI\IStatePersistent, ArrayAccess

Direct known subclasses

Nette\Application\UI\Control, Nette\Application\UI\Multiplier

Indirect known subclasses

Nette\Application\UI\Presenter
Abstract
Namespace: Nette\Application\UI
Author: David Grudl
Located at Application/UI/PresenterComponent.php
Methods summary
public
# __construct( Nette\ComponentModel\IContainer $parent = NULL, $name = NULL )

Overrides

Nette\ComponentModel\Component::__construct
public Nette\Application\UI\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

Nette\Application\UI\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( Nette\ComponentModel\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
Nette\ComponentModel\IComponent

Overrides

Nette\ComponentModel\Component::attached
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 static PresenterComponentReflection
# getReflection( )

Access to reflection.

Access to reflection.

Returns

PresenterComponentReflection

Overrides

Nette\Object::getReflection
public
# loadState( array $params )

Loads state informations.

Loads state informations.

Parameters

$params
array

Implementation of

Nette\Application\UI\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

Nette\Application\UI\IStatePersistent::saveState
final 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
final 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 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

Nette\Application\UI\BadSignalException
if there is not handler method

Implementation of

Nette\Application\UI\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

Nette\Application\UI\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

Nette\Application\UI\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

Nette\Application\AbortException
final public
# offsetSet( string $name, Nette\ComponentModel\IComponent $component )

Adds the component to the container.

Adds the component to the container.

Parameters

$name
string
component name
$component
Nette\ComponentModel\IComponent

Implementation of

ArrayAccess::offsetSet
final public Nette\ComponentModel\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

Nette\ComponentModel\IComponent

Throws

Nette\InvalidArgumentException

Implementation of

ArrayAccess::offsetGet
final 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
final 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 Nette\ComponentModel\Container
__clone(), addComponent(), createComponent(), getComponent(), getComponents(), removeComponent(), validateChildComponent()
Methods inherited from Nette\ComponentModel\Component
__sleep(), __wakeup(), detached(), getName(), getParent(), lookup(), lookupPath(), monitor(), unmonitor(), validateParent()
Methods inherited from Nette\Object
__call(), __callStatic(), __get(), __isset(), __set(), __unset(), extensionMethod()
Methods inherited from Nette\ComponentModel\IComponent
setParent()
Constants inherited from Nette\ComponentModel\IComponent
NAME_SEPARATOR
Properties summary
protected array $params array()
#
Nette Framework 2.0.4 API API documentation generated by ApiGen 2.7.0