Sgss_Imagen_Collector_Interface 
Provides for collecting and retrieving generated images

Description

Author:

Matsuda Shota

Copyright:

(c) 2007-2008 Matsuda Shota

License:

http://creativecommons.org/licenses/GPL/2.0/

Located in:

/Imagen/Collector/Interface.php (line 46)

Class overview

Methods

Inherited from Sgss_Imagen_Actor_Interface:

getConfig(), getParam(), getParams(), setConfig(), setParam(), setParams()

Method detail

collectImage

Adds the specified receipt and image to this collection

Parameters:

• Sgss_Imagen_Receipt $receipt

  Receipt to be associated with the image

• Sgss_Imagen_Image $image

  Image to be collected

Signature:

public Sgss_Imagen_Image collectImage (Sgss_Imagen_Receipt $receipt, Sgss_Imagen_Image $image)

hasImage

Determines if this collection contains the image corresponding to the specified receipt

Parameters:

• Sgss_Imagen_Receipt $receipt

  Receipt of the image to be determined

Returns:

boolean -- True when this collection contains the image corresponding to the specified receipt

Signature:

public boolean hasImage (Sgss_Imagen_Receipt $receipt)

retrieveImage

Retrieves the image corresponding to the specified receipt from this collection

Parameters:

• Sgss_Imagen_Receipt $receipt

  Receipt of image to be retrieved

Returns:

Sgss_Imagen_Image -- Retrieved image

Signature:

public Sgss_Imagen_Image retrieveImage (Sgss_Imagen_Receipt $receipt)