API Documentation

Tag/Item.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
Item
version
$Id: Item.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Tag_Item

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_Item

Implements
Zend_Tag_Taggable
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
uses
Zend_Tag_Taggable
Properties
$_title
$_weight
$_params
$_skipOptions
Methods
__construct
setOptions
getTitle
setTitle
getWeight
setWeight
setParams
setParam
getParam

Description

Properties

$_params

string $_params = 'array'

Custom parameters

Details

$_params
string
visibility
protected
default
array
final
false
static
false

$_skipOptions

array $_skipOptions = 'array'

Option keys to skip when calling setOptions()

Details

$_skipOptions
array
visibility
protected
default
array
final
false
static
false

$_title

string $_title = 'null'

Title of the tag

Details

$_title
string
visibility
protected
default
null
final
false
static
false

$_weight

float $_weight = 'null'

Weight of the tag

Details

$_weight
float
visibility
protected
default
null
final
false
static
false

Methods

__construct

__construct( array|Zend_Config $options ) : void

Create a new tag according to the options

Arguments
$options
arrayZend_Config
Details
visibility
public
final
false
static
false
throws
When invalid options are provided
throws
When title was not set
throws
When weight was not set

getParam

getParam( string $name ) : mixed

Defined by Zend_Tag_Taggable

Arguments
$name
string
Output
mixed
Details
visibility
public
final
false
static
false

getTitle

getTitle( ) : string

Defined by Zend_Tag_Taggable

Output
string
Details
visibility
public
final
false
static
false

getWeight

getWeight( ) : float

Defined by Zend_Tag_Taggable

Output
float
Details
visibility
public
final
false
static
false

setOptions

setOptions( array $options ) : Zend_Tag_Item

Set options of the tag

Arguments
$options
array
Output
Zend_Tag_Item
Details
visibility
public
final
false
static
false

setParam

setParam( string $name, mixed $value ) : Zend_Tag_Item

Defined by Zend_Tag_Taggable

Arguments
$name
string
$value
mixed
Output
Zend_Tag_Item
Details
visibility
public
final
false
static
false

setParams

setParams( array $params ) : Zend_Tag_Item

Set multiple params at once

Arguments
$params
array
Output
Zend_Tag_Item
Details
visibility
public
final
false
static
false

setTitle

setTitle( string $title ) : Zend_Tag_Item

Set the title

Arguments
$title
string
Output
Zend_Tag_Item
Details
visibility
public
final
false
static
false
throws
When title is no string

setWeight

setWeight( float $weight ) : Zend_Tag_Item

Set the weight

Arguments
$weight
float
Output
Zend_Tag_Item
Details
visibility
public
final
false
static
false
throws
When weight is not numeric
Documentation was generated by DocBlox.