Sgss_Imagen_Actor_Abstract 

Description

Implements:
Sgss_Imagen_Actor_Interface
Author:
Matsuda Shota
Copyright:
(c) 2007-2008 Matsuda Shota
License:
http://creativecommons.org/licenses/GPL/2.0/
Located in:
/Imagen/Actor/Abstract.php (line 44)

Direct descendants

Sgss_Imagen_Collector_File
Sgss_Imagen_Generator_Abstract Abstract class for generating image in accordance with receipt
Sgss_Imagen_Requester_Abstract

Class overview

Variables

protected array|null $_config

Config of this actor
protected array $_defaultParams

Default parameters of this actor
protected array $_params

Parameters of this actor

Methods

array getConfig ()

Returns the config of this actor
mixed getParam (string $name)

Returns parameter value associated with the specified name
array getParams ([array|null $names = null])

Returns all the parameter values associated with the specified names
Sgss_Imagen_Actor_Interface setConfig (array|Zend_Config $config)

Sets the config of this actor to the specified value
Sgss_Imagen_Actor_Interface setParam (string $name, mixed $value)

Sets parameter value associated with the specified name to the specified value
Sgss_Imagen_Actor_Interface setParams (array $params)

Sets all the specified parameters into this actor
protected mixed _getRequiredParam (string $name)
mixed __get (string $name)
mixed __set (string $name, mixed $value)

Variable detail

$_config 

Config of this actor

Signature:
protected array|null $_config = null

$_defaultParams 

Default parameters of this actor

Overridden by:
Signature:
protected array $_defaultParams = array()

$_params 

Parameters of this actor

Signature:
protected array $_params = array()

Method detail

getConfig

Returns the config of this actor

Returns:
array -- Config of this actor
Specified by:
Related subject:
Sgss_Imagen_Actor_Interface::getConfig()
Signature:
public array getConfig ()

getParam

Returns parameter value associated with the specified name

Parameters:
  • string $name

    Name of parameter

Returns:
mixed -- Parameter value associated with the specified name
Specified by:
Related subject:
Sgss_Imagen_Actor_Interface::getParam()
Signature:
public mixed getParam (string $name)

getParams

Returns all the parameter values associated with the specified names

Parameters:
  • array|null $names

    Name of parameters, or null for all parameters

Returns:
array -- Parameter values associated with the specified names
Specified by:
Related subject:
Sgss_Imagen_Actor_Interface::getParams()
Signature:
public array getParams ([array|null $names = null])

setConfig

Sets the config of this actor to the specified value

Parameters:
  • array|Zend_Config $config

    Config to set

Returns:
Sgss_Imagen_Actor_Interface -- This object for convenience
Specified by:
Related subject:
Sgss_Imagen_Actor_Interface::setConfig()
Signature:
public Sgss_Imagen_Actor_Interface setConfig (array|Zend_Config $config)

setParam

Sets parameter value associated with the specified name to the specified value

Parameters:
  • string $name

    Name of parameter

  • mixed $value

    Parameter value to set

Returns:
Sgss_Imagen_Actor_Interface -- This object for convenience
Specified by:
Related subject:
Sgss_Imagen_Actor_Interface::setParam()
Signature:
public Sgss_Imagen_Actor_Interface setParam (string $name, mixed $value)

setParams

Sets all the specified parameters into this actor

Parameters:
  • array $params

    Parameters to set

Returns:
Sgss_Imagen_Actor_Interface -- This object for convenience
Specified by:
Related subject:
Sgss_Imagen_Actor_Interface::setParams()
Signature:
public Sgss_Imagen_Actor_Interface setParams (array $params)

_getRequiredParam 

Parameters:
  • string $name
Throws:
  • Sgss_Imagen_Actor_Exception
Signature:
protected mixed _getRequiredParam (string $name)

__get

Parameters:
  • string $name
Signature:
public mixed __get (string $name)

__set

Parameters:
  • string $name
  • mixed $value
Signature:
public mixed __set (string $name, mixed $value)