EntrySortIterator Class Reference

This class contains all the function needed to sort list go up, go down , back , next. etc... More...

Inheritance diagram for EntrySortIterator:

Public Member Functions
	__construct (array $entries, Column $column=NULL, bool $direction=FALSE)
	EntrySortIterator constructor. More...
	rewind ()
	Put the array pointer to the first element.
	current ()
	Get the current data element. More...
	key ()
	Get the key element. More...
	next ()
	Get the next data element.
	valid ()
	Check if the data array is valid. More...

Detailed Description

This class contains all the function needed to sort list go up, go down , back , next. etc...

Definition at line 26 of file class_EntrySortIterator.inc.

Constructor & Destructor Documentation

__construct()

__construct	(	array	$entries,
		Column	$column = NULL,
		bool	$direction = FALSE
	)

EntrySortIterator constructor.

Parameters

array	$entries	entries array
Column	$column	Column to sort by
bool	$direction	Direction

Definition at line 39 of file class_EntrySortIterator.inc.

Member Function Documentation

current()

current

(

)

Get the current data element.

Returns

The current element pointed by array pointer

Definition at line 73 of file class_EntrySortIterator.inc.

key()

key

(

)

Get the key element.

Returns

the key element of the array

Definition at line 83 of file class_EntrySortIterator.inc.

Referenced by valid().

valid()

valid

(

)

Check if the data array is valid.

Returns

TRUE if the array is valid, return FALSE otherwise

Definition at line 101 of file class_EntrySortIterator.inc.

References key().

---

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

• include/management/class_EntrySortIterator.inc