API Documentation

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

\Zend_Tag_Item

Package: Zend\Tag

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

Properties

Propertyprotectedstring  $_params= 'array()'

Custom parameters

Default valuearray()Details
Type
string
Propertyprotectedarray  $_skipOptions= 'array( 'options''

Option keys to skip when calling setOptions()

Default valuearray( 'options'Details
Type
array
Propertyprotectedstring  $_title= 'null'

Title of the tag

Default valuenullDetails
Type
string
Propertyprotectedfloat  $_weight= 'null'

Weight of the tag

Default valuenullDetails
Type
float

Methods

methodpublic__construct( array|\Zend_Config $options ) : void

Create a new tag according to the options

Parameters
Name Type Description
$options array|\Zend_Config
Throws
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
methodpublicgetParam( string $name ) : mixed

Defined by Zend_Tag_Taggable

Parameters
Name Type Description
$name string
Returns
Type Description
mixed
methodpublicgetTitle( ) : string

Defined by Zend_Tag_Taggable

Returns
Type Description
string
methodpublicgetWeight( ) : float

Defined by Zend_Tag_Taggable

Returns
Type Description
float
methodpublicsetOptions( array $options ) : \Zend_Tag_Item

Set options of the tag

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Tag_Item
methodpublicsetParam( string $name, mixed $value ) : \Zend_Tag_Item

Defined by Zend_Tag_Taggable

Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
\Zend_Tag_Item
methodpublicsetParams( array $params ) : \Zend_Tag_Item

Set multiple params at once

Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Tag_Item
methodpublicsetTitle( string $title ) : \Zend_Tag_Item

Set the title

Parameters
Name Type Description
$title string
Returns
Type Description
\Zend_Tag_Item
Throws
Exception Description
\Zend_Tag_Exception When title is no string
methodpublicsetWeight( float $weight ) : \Zend_Tag_Item

Set the weight

Parameters
Name Type Description
$weight float
Returns
Type Description
\Zend_Tag_Item
Throws
Exception Description
\Zend_Tag_Exception When weight is not numeric
Documentation was generated by DocBlox 0.15.1.