fpoirotte\XRL\Types\AbstractCollection Class Reference

An abstract XML-RPC type representing a collection of values. More...

Inheritance diagram for fpoirotte\XRL\Types\AbstractCollection:

Public Member Functions
	__toString ()
	count ()
	current ()
	next ()
	offsetExists ($offset)
&	offsetGet ($offset)
	rewind ()
	valid ()
Public Member Functions inherited from fpoirotte\XRL\Types\AbstractType
	__construct ($value)
	__toString ()
	get ()
	set ($value)
	write (\XMLWriter $writer,\DateTimeZone $timezone, $stringTag)
Public Member Functions inherited from ArrayAccess
	offsetSet ($offset, $value)
	offsetUnset ($offset)
Public Member Functions inherited from Iterator
	key ()

Protected Attributes
	$index = 0
	Current index in the collection.
Protected Attributes inherited from fpoirotte\XRL\Types\AbstractType
	$value
	Current value associated with this object.

Additional Inherited Members
Static Public Member Functions inherited from fpoirotte\XRL\Types\AbstractType
static	read ($value,\DateTimeZone $timezone=null)
Static Protected Member Functions inherited from fpoirotte\XRL\Types\AbstractType
static	parse ($value,\DateTimeZone $timezone=null)

Detailed Description

An abstract XML-RPC type representing a collection of values.

Authors

François Poirotte click.nosp@m.y@er.nosp@m.ebot..nosp@m.net

Definition at line 21 of file AbstractCollection.php.

Member Function Documentation

fpoirotte\XRL\Types\AbstractCollection::__toString

(

)

Represent the collection as a string.

Return values

string

String representation of the collection.

Definition at line 35 of file AbstractCollection.php.

fpoirotte\XRL\Types\AbstractCollection::count

(

)

Return the number of items in the collection.

Return values

int	Items count.

Implements Countable.

Definition at line 46 of file AbstractCollection.php.

Referenced by fpoirotte\XRL\Types\ArrayType\offsetSet(), fpoirotte\XRL\Types\ArrayType\set(), and fpoirotte\XRL\Types\AbstractCollection\valid().

fpoirotte\XRL\Types\AbstractCollection::current

(

)

Return the item at the current position in the collection.

Return values

mixed

Item at the current position.

Implements Iterator.

Definition at line 90 of file AbstractCollection.php.

References Iterator\key().

fpoirotte\XRL\Types\AbstractCollection::next

(

)

Move the collection's cursor forward.

Returns

This method does not return any value.

Implements Iterator.

Definition at line 101 of file AbstractCollection.php.

fpoirotte\XRL\Types\AbstractCollection::offsetExists

(

$offset

)

Check whether the specified index exists within the collection.

Parameters

mixed

$offset

Index to test.

Return values

bool	true if the index exists in the collection, false otherwise.

Implements ArrayAccess.

Definition at line 78 of file AbstractCollection.php.

& fpoirotte\XRL\Types\AbstractCollection::offsetGet

(

$offset

)

Get an item from the collection based on its index.

Parameters

mixed

$offset

Index of the item to retrieve.

Return values

mixed

Item at the given index.

Implements ArrayAccess.

Definition at line 61 of file AbstractCollection.php.

fpoirotte\XRL\Types\AbstractCollection::rewind

(

)

Reset the position of the collection's cursor.

Returns

This method does not return any value.

Implements Iterator.

Definition at line 112 of file AbstractCollection.php.

fpoirotte\XRL\Types\AbstractCollection::valid

(

)

Test whether the collection's cursor points to a valid position.

Return values

bool	true if the current position is valid, false otherwise.

Implements Iterator.

Definition at line 125 of file AbstractCollection.php.

References fpoirotte\XRL\Types\AbstractCollection\count().

---

The documentation for this class was generated from the following file:

• src/Types/AbstractCollection.php