View/Helper/FormMultiCheckbox.php

Show:

inherited

Classes
- \Zend_View_Helper_FormMultiCheckbox

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 [email protected] 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_View
Subpackage: Helper
Version: $Id: FormMultiCheckbox.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_View_Helper_FormMultiCheckbox
jump to top

Package: Zend\View\Helper

Helper to generate a set of checkbox button elements

Extend this, don't use it on its own.

Parent(s): \Zend_View_Helper_FormRadio < \Zend_View_Helper_FormElement < \Zend_View_Helper_HtmlElement < \Zend_View_Helper_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                EOL
                = "\n"

inherited

EOL character

Inherited from: \Zend_View_Helper_HtmlElement::EOL \Zend_View_Helper_FormElement::EOL \Zend_View_Helper_FormRadio::EOL

Inherited_from: \Zend_View_Helper_HtmlElement::EOL
Inherited_from: \Zend_View_Helper_FormElement::EOL
Inherited_from: \Zend_View_Helper_FormRadio::EOL

Properties

string $_closingBracket = null

inherited

The tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::$$_closingBracket \Zend_View_Helper_FormElement::$$_closingBracket \Zend_View_Helper_FormRadio::$$_closingBracket

Default valuenullDetails

Type: string
Inherited_from: \Zend_View_Helper_HtmlElement::$$_closingBracket
Inherited_from: \Zend_View_Helper_FormElement::$$_closingBracket
Inherited_from: \Zend_View_Helper_FormRadio::$$_closingBracket

string $_inputType = 'checkbox'

Input type to use

Default value'checkbox'Details

Type: string

bool $_isArray = true

Whether or not this element represents an array collection by default

Default valuetrueDetails

Type: bool

\Zend_Translate_Adapter|null $_translator =

inherited

Inherited from: \Zend_View_Helper_FormElement::$$_translator \Zend_View_Helper_FormRadio::$$_translator

Details

Type: \Zend_Translate_Adapter | null
Inherited_from: \Zend_View_Helper_FormElement::$$_translator
Inherited_from: \Zend_View_Helper_FormRadio::$$_translator

\Zend_View_Interface $view = null

inherited

View object

Inherited from: \Zend_View_Helper_Abstract::$$view \Zend_View_Helper_HtmlElement::$$view \Zend_View_Helper_FormElement::$$view \Zend_View_Helper_FormRadio::$$view

Default valuenullDetails

Type: \Zend_View_Interface
Inherited_from: \Zend_View_Helper_Abstract::$$view
Inherited_from: \Zend_View_Helper_HtmlElement::$$view
Inherited_from: \Zend_View_Helper_FormElement::$$view
Inherited_from: \Zend_View_Helper_FormRadio::$$view

Methods

_getInfo( $name, $value = null, $attribs = null, $options = null, $listsep = null) : array

inherited

Converts parameter arguments to an element info array.

Inherited from: \Zend_View_Helper_FormElement::_getInfo()\Zend_View_Helper_FormRadio::_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

_hidden(string $name, string $value = null, array $attribs = null) : string

inherited

Creates a hidden element.

Inherited from: \Zend_View_Helper_FormElement::_hidden()\Zend_View_Helper_FormRadio::_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

_htmlAttribs(array $attribs) : string

inherited

Converts an associative array to a string of tag attributes.

Inherited from: \Zend_View_Helper_HtmlElement::_htmlAttribs()\Zend_View_Helper_FormElement::_htmlAttribs()\Zend_View_Helper_FormRadio::_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

_isStrictDoctype() : boolean

inherited

Is doctype strict?

Inherited from: \Zend_View_Helper_HtmlElement::_isStrictDoctype()\Zend_View_Helper_FormElement::_isStrictDoctype()\Zend_View_Helper_FormRadio::_isStrictDoctype()

Returns

Type	Description
boolean

_isXhtml() : boolean

inherited

Is doctype XHTML?

Inherited from: \Zend_View_Helper_HtmlElement::_isXhtml()\Zend_View_Helper_FormElement::_isXhtml()\Zend_View_Helper_FormRadio::_isXhtml()

Returns

Type	Description
boolean

_normalizeId(string $value) : string

inherited

Normalize an ID

Inherited from: \Zend_View_Helper_HtmlElement::_normalizeId()\Zend_View_Helper_FormElement::_normalizeId()\Zend_View_Helper_FormRadio::_normalizeId()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

direct() : void

inherited

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_HtmlElement::direct()\Zend_View_Helper_FormElement::direct()\Zend_View_Helper_FormRadio::direct()

formMultiCheckbox(string | array $name, mixed $value = null, array | string $attribs = null, array $options = null,  $listsep = "
\n") : string

Generates a set of checkbox button elements.

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 checkbox value to mark as 'checked'.
$attribs	array \| string	Attributes added to each radio.
$options	array	An array of key-value pairs where the array key is the checkbox value, and the array value is the radio text.
$listsep

Returns

Type	Description
string	The radio buttons XHTML.

Details

Access: public

formRadio(string | array $name, mixed $value = null, array | string $attribs = null, array $options = null,  $listsep = "
\n") : string

inherited

Generates a set of radio button elements.

Inherited from: \Zend_View_Helper_FormRadio::formRadio()

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 radio value to mark as 'checked'.
$attribs	array \| string	Attributes added to each radio.
$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

Returns

Type	Description
string	The radio buttons XHTML.

Details

Access: public

getClosingBracket() : string

inherited

Get the tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::getClosingBracket()\Zend_View_Helper_FormElement::getClosingBracket()\Zend_View_Helper_FormRadio::getClosingBracket()

Returns

Type	Description
string

getTranslator() : \Zend_Translate_Adapter | null

inherited

Get translator

Inherited from: \Zend_View_Helper_FormElement::getTranslator()\Zend_View_Helper_FormRadio::getTranslator()

Returns

Type	Description
\Zend_Translate_Adapter \| null

setTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_View_Helper_FormElement

inherited

Set translator

Inherited from: \Zend_View_Helper_FormElement::setTranslator()\Zend_View_Helper_FormRadio::setTranslator()

Parameters

Name	Type	Description
$translator	\Zend_Translate \| \Zend_Translate_Adapter \| null

Returns

Type	Description
\Zend_View_Helper_FormElement

setView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract

inherited

Set the View object

Inherited from: \Zend_View_Helper_Abstract::setView()\Zend_View_Helper_HtmlElement::setView()\Zend_View_Helper_FormElement::setView()\Zend_View_Helper_FormRadio::setView()

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_View_Helper_Abstract

View/Helper/FormMultiCheckbox.php

\Zend_View_Helper_FormMultiCheckboxjump to top

Constants

Properties

Methods

\Zend_View_Helper_FormMultiCheckbox
jump to top