1: <?php
 2: /**
 3:  * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 4:  * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 5:  *
 6:  * Licensed under The MIT License
 7:  * For full copyright and license information, please see the LICENSE.txt
 8:  * Redistributions of files must retain the above copyright notice.
 9:  *
10:  * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
11:  * @link          https://cakephp.org CakePHP(tm) Project
12:  * @since         3.0.0
13:  * @license       https://opensource.org/licenses/mit-license.php MIT License
14:  */
15: namespace Cake\View\Widget;
16: 
17: use Cake\View\Form\ContextInterface;
18: 
19: /**
20:  * Input widget for creating checkbox widgets.
21:  */
22: class CheckboxWidget extends BasicWidget
23: {
24: 
25:     /**
26:      * Render a checkbox element.
27:      *
28:      * Data supports the following keys:
29:      *
30:      * - `name` - The name of the input.
31:      * - `value` - The value attribute. Defaults to '1'.
32:      * - `val` - The current value. If it matches `value` the checkbox will be checked.
33:      *   You can also use the 'checked' attribute to make the checkbox checked.
34:      * - `disabled` - Whether or not the checkbox should be disabled.
35:      *
36:      * Any other attributes passed in will be treated as HTML attributes.
37:      *
38:      * @param array $data The data to create a checkbox with.
39:      * @param \Cake\View\Form\ContextInterface $context The current form context.
40:      * @return string Generated HTML string.
41:      */
42:     public function render(array $data, ContextInterface $context)
43:     {
44:         $data += [
45:             'name' => '',
46:             'value' => 1,
47:             'val' => null,
48:             'disabled' => false,
49:             'templateVars' => []
50:         ];
51:         if ($this->_isChecked($data)) {
52:             $data['checked'] = true;
53:         }
54:         unset($data['val']);
55: 
56:         $attrs = $this->_templates->formatAttributes(
57:             $data,
58:             ['name', 'value']
59:         );
60: 
61:         return $this->_templates->format('checkbox', [
62:             'name' => $data['name'],
63:             'value' => $data['value'],
64:             'templateVars' => $data['templateVars'],
65:             'attrs' => $attrs
66:         ]);
67:     }
68: 
69:     /**
70:      * Check whether or not the checkbox should be checked.
71:      *
72:      * @param array $data Data to look at and determine checked state.
73:      * @return bool
74:      */
75:     protected function _isChecked($data)
76:     {
77:         if (array_key_exists('checked', $data)) {
78:             return (bool)$data['checked'];
79:         }
80: 
81:         return (string)$data['val'] === (string)$data['value'];
82:     }
83: }
84: