Class: pnFormCheckboxList

pnFormPlugin
   |
   --pnFormStyledPlugin
      |
      --pnFormBaseListSelector
         |
         --pnFormCheckboxList

[line 74]
Checkbox list

Renders a list of checkboxes with the supplied items. Usefull for selecting multiple items.

You can set the items directly like this:

1.  <!--[pnformcheckboxlist id="mylist" items=$items]-->

with the form event handler code like this:

1.  class mymodule_user_testHandler extends pnFormHandler
2.  {
3.    function initialize(&$render)
4.    {
5.        $items = array( array('text' => 'A', 'value' => '1'),
6.                        array('text' => 'B', 'value' => '2'),
7.                        array('text' => 'C', 'value' => '3') );
8.  
9.        $render->assign('items', $items); // Supply items
10.        $render->assign('mylist', 2);     // Supply selected value
11.    }
12.  }

Or you can set them indirectly using the plugin's databased features:

1.  <!--[pnformchekboxlist id="mylist"]-->

with the form event handler code like this:

1.  class mymodule_user_testHandler extends pnFormHandler
2.  {
3.    function initialize(&$render)
4.    {
5.        $items = array( array('text' => 'A', 'value' => '1'),
6.                        array('text' => 'B', 'value' => '2'),
7.                        array('text' => 'C', 'value' => '3') );
8.  
9.        $render->assign('mylistItems', $items);  // Supply items
10.        $render->assign('mylist', 2);            // Supply selected value
11.    }
12.  }

The resulting dataset is a list of strings representing the selected values. So when you do a $data = $render->pnFormGetValues(); you will get a dataset like this:

1.    array('xxx' => 'valueXX',
2.          'checkboxes' => array('15','17','22','34'),
3.          'yyy' => 'valueYYY')

Tags:

$inputName =

[line 94]

HTML input name for this plugin. Defaults to the ID of the plugin.

$repeatColumns =

[line 100]

Number of columns to display checkboxes in

$repeatWidth =

[line 106]

Width of each checkbox list item (combination of checkbox and label).

Tags:

$saveAsString =

[line 116]

Enable saving of selected values as a colon delimited string

Enable this to save the selected values as a single string instead of an array of selected values. The result is a colon separated string like ":10:20:30".

$selectedValue =

[line 88]

Selected value(s)

The selected value(s) of a checkboxlist is an array of the item values. You can assign to this in your templates like:

1.    <!--[pnformcheckboxlist selectedValue=B]-->

But in your code you should use pnFormCheckboxList::setSelectedValue() and pnFormCheckboxList::getSelectedValue().

---

method clearValidation [line 253]

---

method create [line 125]

---

method decode [line 218]

---

method getFilename [line 119]

---

method getSelectedValue [line 326]

---

method load [line 131]

---

method loadValue [line 280]

---

method render [line 140]

---

method saveValue [line 260]

---

method setError [line 246]

---

method setSelectedValue [line 316]

---

method validate [line 235]