API Documentation

Zend/View/Helper/Cycle.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_View  
Subpackage
Helper  
Version
$Id: Cycle.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_View_Helper_Cycle

Package: Zend\View\Helper

Helper for alternating between set of values

Implements
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constantstring  DEFAULT_NAME = 'default'

Default name

string

Properties

Propertyprotectedarray  $_data= 'array(self::DEFAULT_NAME=>array())'

Array of values

Default valuearray(self::DEFAULT_NAME=>array())Details
Type
array
Propertyprotectedstring  $_name= 'self::DEFAULT_NAME'

Actual name of cycle

Default valueself::DEFAULT_NAMEDetails
Type
string
Propertyprotectedarray  $_pointers= 'array(self::DEFAULT_NAME =>-1)'

Pointers

Default valuearray(self::DEFAULT_NAME =>-1)Details
Type
array

Methods

methodpublic__toString( ) : string

Cast to string

Returns
Type Description
string
methodpublicassign( array $data, string $name = self::DEFAULT_NAME ) : \Zend_View_Helper_Cycle

Add elements to alternate

Parameters
Name Type Description
$data array
$name string
Returns
Type Description
\Zend_View_Helper_Cycle
methodpubliccurrent( ) : mixed

Return current element

Returns
Type Description
mixed
methodpubliccycle( array $data = array(), string $name = self::DEFAULT_NAME ) : \Zend_View_Helper_Cycle

Add elements to alternate

Parameters
Name Type Description
$data array
$name string
Returns
Type Description
\Zend_View_Helper_Cycle
methodpublicgetAll( ) : array

Return all elements

Returns
Type Description
array
methodpublicgetName( ) : string

Gets actual name of cycle

Returns
Type Description
string
methodpublickey( ) : int

Return iteration number

Returns
Type Description
int
methodpublicnext( ) : \Zend_View_Helper_Cycle

Move to next value

Returns
Type Description
\Zend_View_Helper_Cycle
methodpublicprev( ) : \Zend_View_Helper_Cycle

Move to previous value

Returns
Type Description
\Zend_View_Helper_Cycle
methodpublicrewind( ) : \Zend_View_Helper_Cycle

Rewind pointer

Returns
Type Description
\Zend_View_Helper_Cycle
methodpublicsetName( string $name = self::DEFAULT_NAME ) : \Zend_View_Helper_Cycle

Sets actual name of cycle

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_View_Helper_Cycle
methodpublictoString( ) : string

Turn helper into string

Returns
Type Description
string
methodpublicvalid( ) : bool

Check if element is valid

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.