View/Helper/FormMultiCheckbox.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_View  
Subpackage
Helper  
Version
$Id$  

\Zend_View_Helper_FormMultiCheckbox

Package: Zend_View\Helper
Helper to generate a set of checkbox button elements
Parent(s)
\Zend_View_Helper_FormRadio < \Zend_View_Helper_FormElement < \Zend_View_Helper_HtmlElement < \Zend_View_Helper_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_inputType = 'checkbox'
Input type to use
Default value'checkbox'Details
Type
string
>VPropertyprotectedbool $_isArray = true
Whether or not this element represents an array collection by default
Default valuetrueDetails
Type
bool

Methods

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

Generates a set of checkbox button elements.

Parameters
NameTypeDescription
$namestring | 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.

$valuemixed

The checkbox value to mark as 'checked'.

$attribsarray | string

Attributes added to each radio.

$optionsarray

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

$listsep
Returns
TypeDescription
stringThe radio buttons XHTML.
Details
Access
public  
Documentation was generated by phpDocumentor 2.2.0 .