org.puremvc.php.patterns.mediator
[ class tree: org.puremvc.php.patterns.mediator ] [ index: org.puremvc.php.patterns.mediator ] [ all elements ]
Packages:
org.puremvc.php.core
org.puremvc.php.demos
org.puremvc.php.demos.basic.controller.commands
org.puremvc.php.demos.basic.model.proxy
org.puremvc.php.demos.basic.model.vo
org.puremvc.php.demos.basic.view
org.puremvc.php.interfaces
org.puremvc.php.patterns.command
org.puremvc.php.patterns.facade
org.puremvc.php.patterns.mediator
org.puremvc.php.patterns.observer
org.puremvc.php.patterns.proxy


Files:
Mediator.php

Classes:
Mediator

Class: Mediator

Source Location: /patterns/mediator/Mediator.php

Class Overview

Notifier
   |
   ..Mediator

A base
  1. IMediator
implementation.


Author(s):

Implements interfaces:

Variables

Constants

Methods

Child classes:

ApplicationMediator
The ApplicationMediator updates the display of the view when data is ready to be displayed.

Inherited Methods

Class: Notifier

Notifier::__construct()
Notifier::sendNotification()

Class Details

[line 25]
A base
  1. IMediator
implementation.



Tags:

see:  org.puremvc.core.view.View View


[ Top ]

Class Variables

$facade =

[line 34]



Tags:

access:  protected

Type:   mixed
Overrides:   Array


[ Top ]

$mediatorName =

[line 29]



Tags:

access:  protected

Type:   mixed


[ Top ]

$viewComponent =

[line 32]



Tags:

access:  protected

Type:   mixed


[ Top ]


Class Methods

constructor __construct [line 49]

Mediator __construct( $mediatorName, [ $viewComponent = null])

Constructor.



Tags:

access:  public


Overridden in child classes as:

ApplicationMediator::__construct()
Constructor

Overrides Notifier::__construct() (parent method not documented)

Parameters:

   $mediatorName  
   $viewComponent  

[ Top ]

method getMediatorName [line 61]

void getMediatorName( )

Get the name of the
  1. Mediator
.

Override in subclass!




Tags:

access:  public


[ Top ]

method getViewComponent [line 69]

void getViewComponent( )

Get the
  1. Mediator
's view component.



Tags:

access:  public


[ Top ]

method handleNotification [line 98]

void handleNotification( $notification)

Handle
  1. INotification
s.

Typically this will be handled in a switch statement, with one 'case' entry per

  1. INotification
the
  1. Mediator
is interested in.




Tags:

access:  public


Overridden in child classes as:

ApplicationMediator::handleNotification()
Handles notifications sent by the PureMVC framework that this Mediator is interested in.

Parameters:

INotification   $notification  

[ Top ]

method listNotificationInterests [line 85]

Array listNotificationInterests( )

List the
  1. INotification
names this
  1. Mediator
is interested in being notified of.



Tags:

return:  the list of
  1. INotification
names
access:  public


Overridden in child classes as:

ApplicationMediator::listNotificationInterests()
Lists the notifications that this mediator is interested in.

[ Top ]

method onRegister [line 106]

void onRegister( )

Called when the View registers a Mediator.



Tags:

access:  public


[ Top ]

method onRemove [line 114]

void onRemove( )

Called when the View removes a Mediator.



Tags:

access:  public


[ Top ]

method setViewComponent [line 74]

void setViewComponent( $component)



Tags:

access:  public


Parameters:

   $component  

[ Top ]

Class Constants

NAME =  'Mediator'

[line 44]

The name of the
  1. Mediator
.

Typically, a

  1. Mediator
will be written to serve one specific control or group controls and so, will not have a need to be dynamically named.



[ Top ]


Documentation generated on Tue, 30 Sep 2008 08:05:45 -0700 by phpDocumentor 1.4.0