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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Backend\Block\Widget\Button;
/**
* Button list widget
*
* @api
* @since 100.0.2
*/
class ButtonList
{
/**
* @var ItemFactory
*/
protected $itemFactory;
/**
* @param ItemFactory $itemFactory
*/
public function __construct(ItemFactory $itemFactory)
{
$this->itemFactory = $itemFactory;
}
/**
* @var array
*/
protected $_buttons = [-1 => [], 0 => [], 1 => []];
/**
* Add a button
*
* @param string $buttonId
* @param array $data
* @param integer $level
* @param integer $sortOrder
* @param string|null $region That button should be displayed in ('toolbar', 'header', 'footer', null)
* @return void
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
public function add($buttonId, $data, $level = 0, $sortOrder = 0, $region = 'toolbar')
{
if (!isset($this->_buttons[$level])) {
$this->_buttons[$level] = [];
}
$data['id'] = empty($data['id']) ? $buttonId : $data['id'];
$data['button_key'] = $data['id'] . '_button';
$data['region'] = empty($data['region']) ? $region : $data['region'];
$data['level'] = $level;
$sortOrder = $sortOrder ?: (count($this->_buttons[$level]) + 1) * 10;
$data['sort_order'] = empty($data['sort_order']) ? $sortOrder : $data['sort_order'];
$this->_buttons[$level][$buttonId] = $this->itemFactory->create(['data' => $data]);
}
/**
* Remove existing button
*
* @param string $buttonId
* @return void
*/
public function remove($buttonId)
{
foreach ($this->_buttons as $level => $buttons) {
if (isset($buttons[$buttonId])) {
/** @var Item $item */
$item = $buttons[$buttonId];
$item->isDeleted(true);
unset($this->_buttons[$level][$buttonId]);
}
}
}
/**
* Update specified button property
*
* @param string $buttonId
* @param string|null $key
* @param string $data
* @return void
*/
public function update($buttonId, $key, $data)
{
foreach ($this->_buttons as $level => $buttons) {
if (isset($buttons[$buttonId])) {
if (!empty($key)) {
if ('level' == $key) {
$this->_buttons[$data][$buttonId] = $this->_buttons[$level][$buttonId];
unset($this->_buttons[$level][$buttonId]);
} else {
/** @var Item $item */
$item = $this->_buttons[$level][$buttonId];
$item->setData($key, $data);
}
} else {
/** @var Item $item */
$item = $this->_buttons[$level][$buttonId];
$item->setData($data);
}
break;
}
}
}
/**
* Get all buttons
*
* @return array
*/
public function getItems()
{
array_walk($this->_buttons, function (&$item) {
uasort($item, [$this, 'sortButtons']);
});
return $this->_buttons;
}
/**
* Sort buttons by sort order
*
* @param Item $itemA
* @param Item $itemB
* @return int
*/
public function sortButtons(Item $itemA, Item $itemB)
{
return (int)$itemA->getSortOrder() <=> (int)$itemB->getSortOrder();
}
}