1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- <?php
- /**
- * Elgg checkbox input
- * Displays a checkbox input field
- *
- * @note This also includes a hidden input with the same name as the checkboxes
- * to make sure something is sent to the server. The default value is 0.
- * If using JS, be specific to avoid selecting the hidden default value:
- * $('input[type=checkbox][name=name]')
- *
- * @warning Passing integers as labels does not currently work due to a
- * deprecated hack that will be removed in Elgg 1.9. To use integer labels,
- * the labels must be character codes: 1 would be 1
- *
- * @package Elgg
- * @subpackage Core
- *
- * @uses string $vars['name'] The name of the input fields
- * (Forced to an array by appending [])
- * @uses array $vars['options'] An array of strings representing the
- * label => option for the each checkbox field
- * @uses string $vars['default'] The default value to send if nothing is checked.
- * Optional, defaults to 0. Set to FALSE for no default.
- * @uses bool $vars['disabled'] Make all input elements disabled. Optional.
- * @uses string $vars['value'] The current value. Single value or array. Optional.
- * @uses string $vars['class'] Additional class of the list. Optional.
- * @uses string $vars['align'] 'horizontal' or 'vertical' Default: 'vertical'
- *
- */
- $defaults = array(
- 'align' => 'vertical',
- 'value' => array(),
- 'default' => 0,
- 'disabled' => false,
- 'options' => array(),
- 'name' => '',
- );
- $vars = array_merge($defaults, $vars);
- if (empty($vars['options'])) {
- return;
- }
- $list_class = (array) elgg_extract('class', $vars, []);
- unset($vars['class']);
- $list_class[] = 'elgg-input-checkboxes';
- $list_class[] = "elgg-{$vars['align']}";
- $id = elgg_extract('id', $vars, '');
- unset($vars['id']);
- if (is_array($vars['value'])) {
- $values = array_map('elgg_strtolower', $vars['value']);
- } else {
- $values = array(elgg_strtolower($vars['value']));
- }
- $input_vars = $vars;
- $input_vars['default'] = false;
- if ($vars['name']) {
- $input_vars['name'] = "{$vars['name']}[]";
- }
- unset($input_vars['align']);
- unset($input_vars['options']);
- // include a default value so if nothing is checked 0 will be passed.
- if ($vars['name'] && $vars['default'] !== false) {
- echo elgg_view('input/hidden', ['name' => $vars['name'], 'value' => $default]);
- }
- $checkboxes = '';
- foreach ($vars['options'] as $label => $value) {
- // @deprecated 1.8 Remove in 1.9
- if (is_integer($label)) {
- elgg_deprecated_notice('$vars[\'options\'] must be an associative array in input/checkboxes', 1.8);
- $label = $value;
- }
- $input_vars['checked'] = in_array(elgg_strtolower($value), $values);
- $input_vars['value'] = $value;
- $input_vars['label'] = $label;
-
- $input = elgg_view('input/checkbox', $input_vars);
- $checkboxes .= "<li>$input</li>";
- }
- echo elgg_format_element('ul', ['class' => $list_class, 'id' => $id], $checkboxes);
|