Sgss_Imagen_Collector_File

Description

Class diagram:

Sgss_Imagen_Actor_Abstract
 + Sgss_Imagen_Collector_File

Implements:

Sgss_Imagen_Collector_Interface

Author:

Matsuda Shota

Copyright:

(c) 2007-2008 Matsuda Shota

License:

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

Located in:

/Imagen/Collector/File.php (line 69)

Class overview

Variable

Inherited from Sgss_Imagen_Actor_Abstract:

Sgss_Imagen_Actor_Abstract::$_config, Sgss_Imagen_Actor_Abstract::$_params

Methods

Inherited from Sgss_Imagen_Actor_Abstract:

getConfig(), getParam(), getParams(), setConfig(), setParam(), setParams(), _getRequiredParam(), __get(), __set()

Variable detail

$_defaultParams 

Overrides:

• Sgss_Imagen_Actor_Abstract::$_defaultParams

  Default parameters of this actor

Signature:

protected array $_defaultParams = array(...)

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

Throws:

• Sgss_Imagen_Collector_Exception

Specified by:

• Sgss_Imagen_Collector_Interface::collectImage()

  Adds the specified receipt and image to this collection

Related subject:

Sgss_Imagen_Collector_Abstract::collectImage()

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

Specified by:

• Sgss_Imagen_Collector_Interface::hasImage()

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

Related subject:

Sgss_Imagen_Collector_Abstract::hasImage()

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 the image to be retrieved

Returns:

Sgss_Imagen_Image -- Retrieved image

Throws:

• Sgss_Imagen_Collector_Exception

Specified by:

• Sgss_Imagen_Collector_Interface::retrieveImage()

  Retrieves the image corresponding to the specified receipt from this collection

Related subject:

Sgss_Imagen_Collector_Abstract::retrieveImage()

Signature:

public Sgss_Imagen_Image retrieveImage (Sgss_Imagen_Receipt $receipt)

_makePath 

Parameters:

• Sgss_Imagen_Receipt $receipt

Throws:

• Sgss_Imagen_Collector_Exception

Signature:

protected string _makePath (Sgss_Imagen_Receipt $receipt)