API Documentation

View/Helper/FormSelect.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  
version
$Id: FormSelect.php 24158 2011-06-27 15:31:54Z ezimuel $  

\Zend_View_Helper_FormSelect

Helper to generate "select" list of options

Extends from
\Zend_View_Helper_FormElement
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  

Methods

methodprotected_build( string $value, string $label, array $selected, array|bool $disable ) : string

Builds the actual

Parameters
Name Type Description
$value string Options Value
$label string Options Label
$selected array

The option value(s) to mark as 'selected'

$disable array|bool Whether the select is disabled, or individual options are
Returns
Type Description
string Option Tag XHTML
methodprotected_getInfo(  $name,  $value = null,  $attribs = null,  $options = null,  $listsep = null ) : array

Converts parameter arguments to an element info array.

Inherited from: \Zend_View_Helper_FormElement::_getInfo()

E.g, formExample($name, $value, $attribs, $options, $listsep) is the same thing as formExample(array('name' => ...)).

Note that you cannot pass a 'disable' param; you need to pass it as an 'attribs' key.

Parameters
Name Type Description
$name
$value
$attribs
$options
$listsep
Returns
Type Description
array An element info array with keys for name, value, attribs, options, listsep, disable, and escape.
Details
access
protected  
methodprotected_hidden( string $name, string $value = null, array $attribs = null ) : string

Creates a hidden element.

Inherited from: \Zend_View_Helper_FormElement::_hidden()

We have this as a common method because other elements often need hidden elements for their operation.

Parameters
Name Type Description
$name string The element name.
$value string The element value.
$attribs array Attributes for the element.
Returns
Type Description
string A hidden element.
Details
access
protected  
methodprotected_htmlAttribs( array $attribs ) : string

Converts an associative array to a string of tag attributes.

Inherited from: \Zend_View_Helper_HtmlElement::_htmlAttribs()
Parameters
Name Type Description
$attribs array

From this array, each key-value pair is converted to an attribute name and value.

Returns
Type Description
string The XHTML for the attributes.
Details
access
public  
methodprotected_isStrictDoctype( ) : boolean

Is doctype strict?

Inherited from: \Zend_View_Helper_HtmlElement::_isStrictDoctype()
Returns
Type Description
boolean
methodprotected_isXhtml( ) : boolean

Is doctype XHTML?

Inherited from: \Zend_View_Helper_HtmlElement::_isXhtml()
Returns
Type Description
boolean
methodprotected_normalizeId( string $value ) : string

Normalize an ID

Inherited from: \Zend_View_Helper_HtmlElement::_normalizeId()
Parameters
Name Type Description
$value string
Returns
Type Description
string
methodpublicdirect( ) : void

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()
methodpublicformSelect( string|array $name, mixed $value = null, array|string $attribs = null, array $options = null, string $listsep =
\n )
: string

Generates 'select' list of options.

Parameters
Name Type Description
$name string|array If a string, the element name. If an array, all other parameters are ignored, and the array elements are extracted in place of added parameters.
$value mixed

The option value to mark as 'selected'; if an array, will mark all values in the array as 'selected' (used for multiple-select elements).

$attribs array|string

Attributes added to the 'select' tag.

$options array

An array of key-value pairs where the array key is the radio value, and the array value is the radio text.

$listsep string When disabled, use this list separator string between list values.
Returns
Type Description
string The select tag and options XHTML.
Details
access
public  
methodpublicgetClosingBracket( ) : string

Get the tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::getClosingBracket()
Returns
Type Description
string
methodpublicgetTranslator( ) : \Zend_Translate

Get translator

Inherited from: \Zend_View_Helper_FormElement::getTranslator()
Returns
Type Description
\Zend_Translate
methodpublicsetTranslator( \Zend_Translate $translator = null ) : \Zend_View_Helper_FormElement

Set translator

Inherited from: \Zend_View_Helper_FormElement::setTranslator()
Parameters
Name Type Description
$translator \Zend_Translate
Returns
Type Description
\Zend_View_Helper_FormElement
methodpublicsetView( \Zend_View_Interface $view ) : \Zend_View_Helper_Abstract

Set the View object

Inherited from: \Zend_View_Helper_Abstract::setView()
Parameters
Name Type Description
$view \Zend_View_Interface
Returns
Type Description
\Zend_View_Helper_Abstract
Documentation was generated by DocBlox 0.13.3.