-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
ButtonWidget.php
93 lines (85 loc) · 2.71 KB
/
ButtonWidget.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\View\Widget;
use Cake\View\Form\ContextInterface;
use Cake\View\StringTemplate;
/**
* Button input class
*
* This input class can be used to render button elements.
* If you need to make basic submit inputs with type=submit,
* use the Basic input widget.
*/
class ButtonWidget implements WidgetInterface
{
/**
* StringTemplate instance.
*
* @var \Cake\View\StringTemplate
*/
protected $_templates;
/**
* Constructor.
*
* @param \Cake\View\StringTemplate $templates Templates list.
*/
public function __construct(StringTemplate $templates)
{
$this->_templates = $templates;
}
/**
* Render a button.
*
* This method accepts a number of keys:
*
* - `text` The text of the button. Unlike all other form controls, buttons
* do not escape their contents by default.
* - `escapeTitle` Set to false to disable escaping of button text.
* - `escape` Set to false to disable escaping of attributes.
* - `type` The button type defaults to 'submit'.
*
* Any other keys provided in $data will be converted into HTML attributes.
*
* @param array<string, mixed> $data The data to build a button with.
* @param \Cake\View\Form\ContextInterface $context The current form context.
* @return string
*/
public function render(array $data, ContextInterface $context): string
{
$data += [
'text' => '',
'type' => 'submit',
'escapeTitle' => true,
'escape' => true,
'templateVars' => [],
];
return $this->_templates->format('button', [
'text' => $data['escapeTitle'] ? h($data['text']) : $data['text'],
'templateVars' => $data['templateVars'],
'attrs' => $this->_templates->formatAttributes($data, ['text', 'escapeTitle']),
]);
}
/**
* @inheritDoc
*/
public function secureFields(array $data): array
{
if (!isset($data['name']) || $data['name'] === '') {
return [];
}
return [$data['name']];
}
}