org-puremvc-php-multicore
[ class tree: org-puremvc-php-multicore ] [ index: org-puremvc-php-multicore ] [ all elements ]

Class: IModel

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

Interface Overview


The interface definition for a PureMVC Model.


Methods



Class Details

[line 38]
The interface definition for a PureMVC Model.

In PureMVC, IModel implementors provide access to IProxy objects by named lookup.

An IModel assumes these responsibilities:

  • Maintain a cache of IProxy instances.
  • Provide methods for registering, retrieving, and removing IProxy instances.




[ Top ]


Class Methods


method hasProxy [line 78]

bool hasProxy( string $proxyName)

Has Proxy

Check if a Proxy is registered for the given proxyName.




Tags:

return:  Boolean: Whether a Proxy is currently registered with the given proxyName.
access:  public


Parameters:

string   $proxyName   Name of the Proxy to check for.

[ Top ]

method registerProxy [line 48]

void registerProxy( IProxy $proxy)

Register Proxy

Register an IProxy with the Model.




Tags:

access:  public


Parameters:

IProxy   $proxy   The IProxy to be registered with the Model.

[ Top ]

method removeProxy [line 68]

IProxy removeProxy( string $proxyName)

Remove Proxy

Remove a previously registered IProxy instance from the Model by name.




Tags:

return:  The IProxy that was removed from the Model.
access:  public


Parameters:

string   $proxyName   Name of the IProxy to remove from the Model.

[ Top ]

method retrieveProxy [line 58]

IProxy retrieveProxy( string $proxyName)

Retreive Proxy

Retrieve a previously registered IProxy from the Model by name.




Tags:

return:  The IProxy previously regisetered by proxyName with the Model.
access:  public


Parameters:

string   $proxyName   Name of the IProxy instance to be retrieved.

[ Top ]


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