Tag/Item.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
- Item
- Version
- $Id$
\Zend_Tag_Item
Package: Zend_Tag
- Implements
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Uses
Properties
string $_params = array()Custom parameters
Default value
array()Details- Type
- string
array $_skipOptions = array('options', 'param')Option keys to skip when calling setOptions()
Default value
array('options', 'param')Details- Type
- array
string $_title = nullTitle of the tag
Default value
nullDetails- Type
- string
float $_weight = nullWeight of the tag
Default value
nullDetails- Type
- float
Methods
__construct(array | \Zend_Config $options) : voidCreate a new tag according to the options
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config |
| Exception | Description |
|---|---|
| \Zend_Tag_Exception | When invalid options are provided |
| \Zend_Tag_Exception | When title was not set |
| \Zend_Tag_Exception | When weight was not set |
getParam(string $name) : mixedDefined by Zend_Tag_Taggable
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| mixed |
getTitle() : stringDefined by Zend_Tag_Taggable
Returns
| Type | Description |
|---|---|
| string |
getWeight() : floatDefined by Zend_Tag_Taggable
Returns
| Type | Description |
|---|---|
| float |
setOptions(array $options) : \Zend_Tag_ItemSet options of the tag
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Tag_Item |
setParam(string $name, mixed $value) : \Zend_Tag_ItemDefined by Zend_Tag_Taggable
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Tag_Item |
setParams(array $params) : \Zend_Tag_ItemSet multiple params at once
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $params | array |
| Type | Description |
|---|---|
| \Zend_Tag_Item |
setTitle(string $title) : \Zend_Tag_ItemSet the title
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $title | string |
| Type | Description |
|---|---|
| \Zend_Tag_Item |
| Exception | Description |
|---|---|
| \Zend_Tag_Exception | When title is no string |
setWeight(float $weight) : \Zend_Tag_ItemSet the weight
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $weight | float |
| Type | Description |
|---|---|
| \Zend_Tag_Item |
| Exception | Description |
|---|---|
| \Zend_Tag_Exception | When weight is not numeric |