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:      * Render a checkbox element.
26:      *
27:      * Data supports the following keys:
28:      *
29:      * - `name` - The name of the input.
30:      * - `value` - The value attribute. Defaults to '1'.
31:      * - `val` - The current value. If it matches `value` the checkbox will be checked.
32:      *   You can also use the 'checked' attribute to make the checkbox checked.
33:      * - `disabled` - Whether or not the checkbox should be disabled.
34:      *
35:      * Any other attributes passed in will be treated as HTML attributes.
36:      *
37:      * @param array $data The data to create a checkbox with.
38:      * @param \Cake\View\Form\ContextInterface $context The current form context.
39:      * @return string Generated HTML string.
40:      */
41:     public function render(array $data, ContextInterface $context)
42:     {
43:         $data += [
44:             'name' => '',
45:             'value' => 1,
46:             'val' => null,
47:             'disabled' => false,
48:             'templateVars' => []
49:         ];
50:         if ($this->_isChecked($data)) {
51:             $data['checked'] = true;
52:         }
53:         unset($data['val']);
54: 
55:         $attrs = $this->_templates->formatAttributes(
56:             $data,
57:             ['name', 'value']
58:         );
59: 
60:         return $this->_templates->format('checkbox', [
61:             'name' => $data['name'],
62:             'value' => $data['value'],
63:             'templateVars' => $data['templateVars'],
64:             'attrs' => $attrs
65:         ]);
66:     }
67: 
68:     /**
69:      * Check whether or not the checkbox should be checked.
70:      *
71:      * @param array $data Data to look at and determine checked state.
72:      * @return bool
73:      */
74:     protected function _isChecked($data)
75:     {
76:         if (array_key_exists('checked', $data)) {
77:             return (bool)$data['checked'];
78:         }
79: 
80:         return (string)$data['val'] === (string)$data['value'];
81:     }
82: }
83: