Tag/ItemList.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Tag
- Subpackage
- ItemList
- Version
- $Id$
\Zend_Tag_ItemList
Package: Zend_Tag
- Implements
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
count() : integerCount all items
Returns
| Type | Description |
|---|---|
| integer |
current() : mixedReturn the current element
Returns
| Type | Description |
|---|---|
| mixed |
key() : mixedReturn the key of the current element
Returns
| Type | Description |
|---|---|
| mixed |
next() : mixedMove forward to next element
Returns
| Type | Description |
|---|---|
| mixed |
offsetExists(mixed $offset) : booleanCheck if an offset exists
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $offset | mixed |
| Type | Description |
|---|---|
| boolean |
offsetGet(mixed $offset) : \Zend_Tag_TaggableGet the value of an offset
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $offset | mixed |
| Type | Description |
|---|---|
| \Zend_Tag_Taggable |
offsetSet(mixed $offset, \Zend_Tag_Taggable $item) : voidAppend a new item
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $offset | mixed | |
| $item | \Zend_Tag_Taggable |
| Exception | Description |
|---|---|
| \OutOfBoundsException | When item does not implement Zend_Tag_Taggable |
offsetUnset(mixed $offset) : voidUnset an item
Parameters
| Name | Type | Description |
|---|---|---|
| $offset | mixed |
rewind() : voidRewind the Iterator to the first element
seek(integer $index) : voidSeek to an absolute positio
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $index | integer |
| Exception | Description |
|---|---|
| \OutOfBoundsException | When the seek position is invalid |
spreadWeightValues(array $values) : voidSpread values in the items relative to their weight
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $values | array |
| Exception | Description |
|---|---|
| \Zend_Tag_Exception | When value list is empty |
valid() : booleanCheck if there is a current element after calls to rewind() or next()
Returns
| Type | Description |
|---|---|
| boolean |