org.puremvc.php.interfaces
[ class tree: org.puremvc.php.interfaces ] [ index: org.puremvc.php.interfaces ] [ all elements ]

Class: IProxy

Source Location: /interfaces/IProxy.php

Interface Overview


The interface definition for a PureMVC Proxy.


Methods



Class Details

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

In PureMVC,

implementors assume these responsibilities:

  • Implement a common method which returns the name of the Proxy.
Additionally,
s typically:

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




[ Top ]


Class Methods


method getData [line 46]

void getData( )

Get the data object



Tags:

access:  public


[ Top ]

method getProxyName [line 41]

the getProxyName( )

Get the Proxy name



Tags:

return:  Proxy instance name
access:  public


[ Top ]

method onRegister [line 56]

void onRegister( )

Called when the Model registers a Proxy.



Tags:

access:  public


[ Top ]

method onRemove [line 61]

void onRemove( )

Called when the Model removes a Proxy.



Tags:

access:  public


[ Top ]

method setData [line 51]

void setData( $data)

Set the data object.



Tags:

access:  public


Parameters:

   $data  

[ Top ]


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