Cycle Class Reference

Helper for alternating between set of values. More...

Public Member Functions
	__invoke (array $data=[], $name=self::DEFAULT_NAME)
	Add elements to alternate.
	__toString ()
	Cast to string.
	toString ()
	Turn helper into string.
	assign (array $data, $name=self::DEFAULT_NAME)
	Add elements to alternate.
	setName ($name=self::DEFAULT_NAME)
	Sets actual name of cycle.
	getName ()
	Gets actual name of cycle.
	getAll ()
	Return all elements.
	next ()
	Move to next value.
	prev ()
	Move to previous value.
	key ()
	Return iteration number.
	rewind ()
	Rewind pointer.
	valid ()
	Check if element is valid.
	current ()
	Return current element.
Public Member Functions inherited from AbstractHelper
	setView (Renderer $view)
	Set the View object.
	getView ()
	Get the view object.

Public Attributes
const	DEFAULT_NAME = 'default'

Protected Attributes
	$data = [self::DEFAULT_NAME=>[]]
	$name = self::DEFAULT_NAME
	$pointers = [self::DEFAULT_NAME =>-1]
Protected Attributes inherited from AbstractHelper
	$view = null

Detailed Description

Helper for alternating between set of values.

Member Function Documentation

__invoke	(	array	$data = [],
			$name = self::DEFAULT_NAME
	)

Add elements to alternate.

Parameters

array	$data
string	$name

Returns

Cycle

__toString

(

)

Cast to string.

Returns

string

assign	(	array	$data,
			$name = self::DEFAULT_NAME
	)

Add elements to alternate.

Parameters

array	$data
string	$name

Returns

Cycle

current

(

)

Return current element.

Returns

mixed

getAll

(

)

Return all elements.

Returns

array

getName

(

)

Gets actual name of cycle.

Returns

string

key

(

)

Return iteration number.

Returns

int

next

(

)

Move to next value.

Returns

Cycle

prev

(

)

Move to previous value.

Returns

Cycle

rewind

(

)

Rewind pointer.

Returns

Cycle

setName

(

$name = self::DEFAULT_NAME

)

Sets actual name of cycle.

Parameters

$name

Returns

Cycle

toString

(

)

Turn helper into string.

Returns

string

valid

(

)

Check if element is valid.

Returns

bool

Member Data Documentation

$data = [self::DEFAULT_NAME=>[]]

protected

$name = self::DEFAULT_NAME

protected

$pointers = [self::DEFAULT_NAME =>-1]

protected

const DEFAULT_NAME = 'default'