API Documentation

Tag/ItemList.php

Includes 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_Tag
subpackage
ItemList
version
$Id: ItemList.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Tag_ItemList

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_Tag_ItemList

Implements
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_Tag
Properties
$_items
Methods
count
spreadWeightValues
seek
current
next
key
valid
rewind
offsetExists
offsetGet
offsetSet
offsetUnset

Description

Properties

$_items

array $_items = 'array'

Items in this list

Details

$_items
array
visibility
protected
default
array
final
false
static
false

Methods

count

count( ) : integer

Count all items

Output
integer
Details
visibility
public
final
false
static
false

current

current( ) : mixed

Return the current element

Output
mixed
Details
visibility
public
final
false
static
false

key

key( ) : mixed

Return the key of the current element

Output
mixed
Details
visibility
public
final
false
static
false

next

next( ) : mixed

Move forward to next element

Output
mixed
Details
visibility
public
final
false
static
false

offsetExists

offsetExists( mixed $offset ) : boolean

Check if an offset exists

Arguments
$offset
mixed
Output
boolean
Details
visibility
public
final
false
static
false

offsetGet

offsetGet( mixed $offset ) : Zend_Tag_Taggable

Get the value of an offset

Arguments
$offset
mixed
Details
visibility
public
final
false
static
false

offsetSet

offsetSet( mixed $offset, Zend_Tag_Taggable $item ) : void

Append a new item

Arguments
$offset
mixed
$item
Zend_Tag_Taggable
Details
visibility
public
final
false
static
false
throws
When item does not implement Zend_Tag_Taggable

offsetUnset

offsetUnset( mixed $offset ) : void

Unset an item

Arguments
$offset
mixed
Details
visibility
public
final
false
static
false

rewind

rewind( ) : void

Rewind the Iterator to the first element

Details
visibility
public
final
false
static
false

seek

seek( integer $index ) : void

Seek to an absolute positio

Arguments
$index
integer
Details
visibility
public
final
false
static
false
throws
When the seek position is invalid

spreadWeightValues

spreadWeightValues( array $values ) : void

Spread values in the items relative to their weight

Arguments
$values
array
Details
visibility
public
final
false
static
false
throws
When value list is empty

valid

valid( ) : boolean

Check if there is a current element after calls to rewind() or next()

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