fpoirotte\XRL\Types\ArrayType Class Reference

The XML-RPC "array" type. More...

Inheritance diagram for fpoirotte\XRL\Types\ArrayType:

Public Member Functions
	get ()
	key ()
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	set ($value)
	write (\XMLWriter $writer,\DateTimeZone $timezone, $stringTag)
Public Member Functions inherited from fpoirotte\XRL\Types\AbstractCollection
	__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)

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

Additional Inherited Members
Static Public Member Functions inherited from fpoirotte\XRL\Types\AbstractType
static	read ($value,\DateTimeZone $timezone=null)
Protected Attributes inherited from fpoirotte\XRL\Types\AbstractCollection
	$index = 0
	Current index in the collection.
Protected Attributes inherited from fpoirotte\XRL\Types\AbstractType
	$value
	Current value associated with this object.

Detailed Description

The XML-RPC "array" type.

Authors

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

Definition at line 20 of file ArrayType.php.

Member Function Documentation

fpoirotte\XRL\Types\ArrayType::get

(

)

Return this object's current value.

Return values

mixed

This object's current value.

Definition at line 23 of file ArrayType.php.

fpoirotte\XRL\Types\ArrayType::key

(

)

Return the current index of this collection's cursor.

Return values

mixed

Current index.

Implements Iterator.

Definition at line 132 of file ArrayType.php.

References fpoirotte\XRL\Types\AbstractCollection\$index.

fpoirotte\XRL\Types\ArrayType::offsetSet	(		$offset,
			$value
	)

Change the item at some index in the collection.

Parameters

int	$offset	Index of the item to modify.
mixed	$value	New value for the item at the given index.

Returns

This method does not return any value.

Implements ArrayAccess.

Definition at line 96 of file ArrayType.php.

References fpoirotte\XRL\Types\AbstractType\$value, and fpoirotte\XRL\Types\AbstractCollection\count().

fpoirotte\XRL\Types\ArrayType::offsetUnset

(

$offset

)

Remove an item from the collection.

Parameters

mixed

$offset

Index of the item to remove.

Returns

This method does not return any value.

Implements ArrayAccess.

Definition at line 118 of file ArrayType.php.

References fpoirotte\XRL\Types\AbstractType\$value.

static fpoirotte\XRL\Types\ArrayType::parse (   $value, \DateTimeZone  $timezone = null  )

staticprotected

Parse a string into a value compatible with this type.

Parameters

string	$value	String to parse.
DateTimeZone	$timezone	Timezone to use when converting dates/times.

Return values

mixed

A value compatible with this type.

Definition at line 79 of file ArrayType.php.

fpoirotte\XRL\Types\ArrayType::set

(

$value

)

Change the value associated with the object.

Parameters

mixed

$value

New value.

Returns

This method does not return any value.

Exceptions

InvalidArgumentException

The given value is invalid for this type of object.

Definition at line 33 of file ArrayType.php.

References fpoirotte\XRL\Types\AbstractType\$value, and fpoirotte\XRL\Types\AbstractCollection\count().

fpoirotte\XRL\Types\ArrayType::write	(	\XMLWriter	$writer,
		\DateTimeZone	$timezone,
			$stringTag
	)

Export this object's value to XML.

Parameters

XMLWriter	$writer	Writer the value will be exported to.
DateTimeZone	$timezone	Timezone to use when exporting dates/times.
bool	$stringTag	Whether to use <string> tags at all when encoding strings.

Returns

This method does not return any value.

Definition at line 65 of file ArrayType.php.

---

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

• src/Types/ArrayType.php