Class: IProxy

Source Location: /org/puremvc/php/multicore/interfaces/IProxy.php

Interface Overview

INotifier
   |
   --IProxy

The interface definition for a PureMVC Proxy.

Methods

Inherited Methods

Class: INotifier

INotifier::initializeNotifier(): Initialize this INotifier instance.
INotifier::sendNotification(): Send a INotification.

Class Details

[line 42]
The interface definition for a PureMVC Proxy.

In PureMVC, IProxy implementors assume these responsibilities:</P>

Implement a common method which returns the name of the Proxy.
Provide methods for setting and getting the data object.

Additionally, IProxys typically:

Maintain references to one or more pieces of model data.
Provide methods for manipulating that data.
Generate INotifications when their model data changes.
Expose their name as a public static const called NAME, if they are not instantiated multiple times.
Encapsulate interaction with local or remote services used to fetch and persist model data.

[ Top ]

Class Methods

method getData [line 69]

mixed getData(
)

Data getter

Get the data object

Tags:

return:	The data Object. null if not set
access:	public

[ Top ]

method getProxyName [line 50]

string getProxyName(
)

Get the Proxy name

Tags:

return:	The Proxy instance name
access:	public

[ Top ]

method onRegister [line 78]

void onRegister(
)

onRegister event

Called by the Model when the Proxy is registered

Tags:

access:

public

[ Top ]

method onRemove [line 86]

void onRemove(
)

onRemove event Called by the Model when the Proxy is removed

Tags:

access:

public

[ Top ]

method setData [line 60]

void setData(
mixed
$data)

Data setter

Set the data object

Tags:

access:

public

Parameters:

mixed

$data

the data object

[ Top ]

Documentation generated on Mon, 03 Aug 2009 04:57:57 +0000 by phpDocumentor 1.4.2