API Documentation

Zend/Tag/ItemList.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_Tag  
Subpackage
ItemList  
Version
$Id: ItemList.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Tag_ItemList

Package: Zend\Tag

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

Properties

Propertyprotectedarray  $_items= 'array()'

Items in this list

Default valuearray()Details
Type
array

Methods

methodpubliccount( ) : integer

Count all items

Returns
Type Description
integer
methodpubliccurrent( ) : mixed

Return the current element

Returns
Type Description
mixed
methodpublickey( ) : mixed

Return the key of the current element

Returns
Type Description
mixed
methodpublicnext( ) : mixed

Move forward to next element

Returns
Type Description
mixed
methodpublicoffsetExists( mixed $offset ) : boolean

Check if an offset exists

Parameters
Name Type Description
$offset mixed
Returns
Type Description
boolean
methodpublicoffsetGet( mixed $offset ) : \Zend_Tag_Taggable

Get the value of an offset

Parameters
Name Type Description
$offset mixed
Returns
Type Description
\Zend_Tag_Taggable
methodpublicoffsetSet( mixed $offset, \Zend_Tag_Taggable $item ) : void

Append a new item

Parameters
Name Type Description
$offset mixed
$item \Zend_Tag_Taggable
Throws
Exception Description
\OutOfBoundsException When item does not implement Zend_Tag_Taggable
methodpublicoffsetUnset( mixed $offset ) : void

Unset an item

Parameters
Name Type Description
$offset mixed
methodpublicrewind( ) : void

Rewind the Iterator to the first element

methodpublicseek( integer $index ) : void

Seek to an absolute positio

Parameters
Name Type Description
$index integer
Throws
Exception Description
\OutOfBoundsException When the seek position is invalid
methodpublicspreadWeightValues( array $values ) : void

Spread values in the items relative to their weight

Parameters
Name Type Description
$values array
Throws
Exception Description
\Zend_Tag_Exception When value list is empty
methodpublicvalid( ) : boolean

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

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.15.1.