Packages

  • Nette
    • Application
    • Caching
    • Collections
    • Config
    • Forms
    • IO
    • Loaders
    • Mail
    • Reflection
    • Security
    • Templates
    • Web
  • None
  • PHP

Classes

  • NAppForm
  • NApplication
  • NCliRouter
  • NControl
  • NDownloadResponse
  • NForwardingResponse
  • NJsonResponse
  • NLink
  • NMultiRouter
  • NPresenter
  • NPresenterComponent
  • NPresenterLoader
  • NPresenterRequest
  • NRedirectingResponse
  • NRenderResponse
  • NRoute
  • NSimpleRouter

Interfaces

  • IPartiallyRenderable
  • IPresenter
  • IPresenterLoader
  • IPresenterResponse
  • IRenderable
  • IRouter
  • ISignalReceiver
  • IStatePersistent

Exceptions

  • NAbortException
  • NApplicationException
  • NBadRequestException
  • NBadSignalException
  • NForbiddenRequestException
  • NInvalidLinkException
  • NInvalidPresenterException
  • Overview
  • Package
  • Class
  • Tree
  • Other releases

Class NPresenterComponent

PresenterComponent is the base class for all presenters 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.

NObject
Extended by NComponent implements IComponent
Extended by NComponentContainer implements IComponentContainer
Extended by NPresenterComponent implements ISignalReceiver, IStatePersistent, ArrayAccess

Direct known subclasses

NControl

Indirect known subclasses

NPresenter
Abstract
Package: Nette\Application
Author: David Grudl
Located at Application/PresenterComponent.php
Methods summary
public
# __construct( IComponentContainer $parent = NULL, $name = NULL )
public NPresenter|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

NPresenter|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
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 NPresenterComponentReflection
# getReflection( )

Access to reflection.

Access to reflection.

Returns

NPresenterComponentReflection
public
# loadState( array $params )

Loads state informations.

Loads state informations.

Parameters

$params
array

Implementation of

IStatePersistent::loadState
public
# saveState( array & $params, NPresenterComponentReflection $reflection = NULL )

Saves state informations for next request.

Saves state informations for next request.

Parameters

$params
array
$reflection
NPresenterComponentReflection
(internal, used by Presenter)

Implementation of

IStatePersistent::saveState
final public mixed
# getParam( 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
# getParamId( $name )

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

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

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

NBadSignalException
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

NInvalidLinkException
public NLink
# 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

NLink
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

NAbortException
final 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
final 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
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 NComponentContainer
__clone(), addComponent(), createComponent(), getComponent(), getComponents(), removeComponent(), validateChildComponent()
Methods inherited from NComponent
__wakeup(), detached(), getName(), getParent(), lookup(), lookupPath(), monitor(), setParent(), unmonitor(), validateParent()
Methods inherited from NObject
__call(), __callStatic(), __get(), __isset(), __set(), __unset(), extensionMethod()
Constants inherited from IComponent
NAME_SEPARATOR
Properties summary
protected array $params array()
#
Nette Framework 0.9.7 (for PHP 5.2) API documentation generated by ApiGen 2.3.0