API Documentation

View/Helper/Cycle.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_View
subpackage
Helper
version
$Id: Cycle.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_View_Helper_Cycle

Description

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.

Zend_View_Helper_Cycle

Implements
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_View
subpackage
Helper
Constants
DEFAULT_NAME
Properties
$_pointers
$_data
$_name
Methods
cycle
assign
setName
getName
getAll
toString
__toString
next
prev
key
rewind
valid
current

Description

Helper for alternating between set of values

Constants

DEFAULT_NAME

string DEFAULT_NAME = 'default'

Default name

Details

value
default
DEFAULT_NAME
string

Properties

$_data

array $_data = 'array'

Array of values

Details

$_data
array
visibility
protected
default
array
final
false
static
false

$_name

string $_name = 'self'

Actual name of cycle

Details

$_name
string
visibility
protected
default
self
final
false
static
false

$_pointers

array $_pointers = 'array'

Pointers

Details

$_pointers
array
visibility
protected
default
array
final
false
static
false

Methods

__toString

__toString( ) : string

Cast to string

Output
string
Details
visibility
public
final
false
static
false

assign

assign( array $data, string $name = self ) : Zend_View_Helper_Cycle

Add elements to alternate

Arguments
$data
array
$name
string
Details
visibility
public
final
false
static
false

current

current( ) : mixed

Return current element

Output
mixed
Details
visibility
public
final
false
static
false

cycle

cycle( array $data = array, string $name = self ) : Zend_View_Helper_Cycle

Add elements to alternate

Arguments
$data
array
$name
string
Details
visibility
public
final
false
static
false

getAll

getAll( ) : array

Return all elements

Output
array
Details
visibility
public
final
false
static
false

getName

getName( ) : string

Gets actual name of cycle

Output
string
Details
visibility
public
final
false
static
false

key

key( ) : int

Return iteration number

Output
int
Details
visibility
public
final
false
static
false

next

next( ) : Zend_View_Helper_Cycle

Move to next value

Details
visibility
public
final
false
static
false

prev

prev( ) : Zend_View_Helper_Cycle

Move to previous value

Details
visibility
public
final
false
static
false

rewind

rewind( ) : Zend_View_Helper_Cycle

Rewind pointer

Details
visibility
public
final
false
static
false

setName

setName(  $name = self ) : Zend_View_Helper_Cycle

Sets actual name of cycle

Arguments
$name
Details
visibility
public
final
false
static
false

toString

toString( ) : string

Turn helper into string

Output
string
Details
visibility
public
final
false
static
false

valid

valid( ) : bool

Check if element is valid

Output
bool
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.