Sgss_Imagen_Receipt
Represents an image generation receipt

Description

Implements:
Countable (internal interface), Iterator (internal interface)
Author:
Matsuda Shota
Copyright:
(c) 2007-2008 Matsuda Shota
License:
http://creativecommons.org/licenses/GPL/2.0/
Located in:
/Imagen/Receipt.php (line 51)

Class overview

Variables

protected array $_config

Definition of item types
protected int $_format

Image format indentifier of this receipt
protected array $_items

Items appended in this receipt
protected array $_numItems

Number of items in this receipt

Methods

__construct (array $config)

The constructor
int count ()
mixed current ()
int|Sgss_Imagen_Receipt format ([null|int $format = null])
string hash ([string|null $type = null])
mixed key ()
mixed next ()
Sgss_Imagen_Receipt put (string $type, string $label, array $params)
void rewind ()
int size ([string|null $type = null])
boolean valid ()
mixed __call (string $name, array $arguments)
mixed __get (mixed $name)
boolean __isset (mixed $name)

Variable detail

$_config 

Definition of item types

Signature:
protected array $_config

$_format 

Image format indentifier of this receipt

Signature:
protected int $_format = -1

$_items 

Items appended in this receipt

Signature:
protected array $_items = array()

$_numItems 

Number of items in this receipt

Signature:
protected array $_numItems = array()

Method detail

__construct

The constructor

Parameters:
  • array $config
Signature:
public __construct (array $config)

count

Specified by:
  • Countable::count
Uses:
Sgss_Imagen_Receipt::size()
Used by:
Sgss_Imagen_Receipt::valid()
Related subject:
Countable::count()
Signature:
public int count ()

current

Specified by:
  • Iterator::current
Uses:
Sgss_Imagen_Receipt::valid()
Used by:
Sgss_Imagen_Receipt::next()
Related subject:
Iterator::current()
Signature:
public mixed current ()

format

Parameters:
  • null|int $format
Signature:
public int|Sgss_Imagen_Receipt format ([null|int $format = null])

hash

Parameters:
  • string|null $type
Signature:
public string hash ([string|null $type = null])

key

Specified by:
  • Iterator::key
Related subject:
Iterator::key()
Signature:
public mixed key ()

next

Specified by:
  • Iterator::next
Uses:
Sgss_Imagen_Receipt::current()
Related subject:
Iterator::next()
Signature:
public mixed next ()

put

Parameters:
  • string $type
  • string $label
  • array $params
Returns:
Sgss_Imagen_Receipt -- This object for convenience
Signature:
public Sgss_Imagen_Receipt put (string $type, string $label, array $params)

rewind

Specified by:
  • Iterator::rewind
Related subject:
Iterator::rewind()
Signature:
public void rewind ()

size

Parameters:
  • string|null $type
Used by:
Sgss_Imagen_Receipt::count()
Signature:
public int size ([string|null $type = null])

valid

Specified by:
  • Iterator::valid
Uses:
Sgss_Imagen_Receipt::count()
Used by:
Sgss_Imagen_Receipt::current()
Related subject:
Iterator::valid()
Signature:
public boolean valid ()

__call

Parameters:
  • string $name
  • array $arguments
Signature:
public mixed __call (string $name, array $arguments)

__get

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

__isset

Parameters:
  • mixed $name
Signature:
public boolean __isset (mixed $name)