File: CActionButtonList.php

package info (click to toggle)
zabbix 1%3A5.0.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 135,196 kB
  • sloc: ansic: 250,674; sql: 209,763; php: 195,264; xml: 167,194; javascript: 46,671; sh: 5,339; makefile: 1,723; java: 1,337; cpp: 620; perl: 41
file content (148 lines) | stat: -rw-r--r-- 4,766 bytes parent folder | download
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?php
/*
** Zabbix
** Copyright (C) 2001-2021 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
**/


/**
 * Class CActionButtonList
 *
 * Implements wrapper to handle output of mass action buttons as used in list views.
 */
class CActionButtonList extends CObject {

	/**
	 * CSubmit instances.
	 *
	 * @var CSubmit[]
	 */
	protected $buttons;

	/**
	 * Name of parameter which will hold values of checked checkboxes.
	 *
	 * @var string
	 */
	protected $checkboxes_name;

	/**
	 * Prefix for sessionStorage used for remembering which checkboxes have been checked when navigating between pages.
	 *
	 * @var string|null
	 */
	protected $name_prefix = null;

	/**
	 * Element that is used to show number of selected checkboxes.
	 *
	 * @var CObject
	 */
	protected $selected_count_element = null;

	/**
	 * @param string       $action_name                 Name of submit buttons.
	 * @param string       $checkboxes_name             Name of paramerer into which checked checkboxes will be put in.
	 * @param array        $buttons_data                Buttons data array.
	 * @param string       $buttons_data[]['name']      Button caption.
	 * @param string       $buttons_data[]['confirm']   Confirmation text (optional).
	 * @param string       $buttons_data[]['redirect']  Redirect URL (optional).
	 * @param bool         $buttons_data[]['disabled']  Set button state disabled (optional).
	 * @param string|null  $name_prefix                 Prefix for sessionStorage used for storing currently selected
	 *                                                  checkboxes.
	 */
	function __construct($action_name, $checkboxes_name, array $buttons_data, $name_prefix = null) {
		$this->checkboxes_name = $checkboxes_name;
		$this->name_prefix = $name_prefix ? $name_prefix : null;

		foreach ($buttons_data as $action => $button_data) {
			$button = (new CSubmit($action_name, $button_data['name']))
				->addClass(ZBX_STYLE_BTN_ALT)
				->removeAttribute('id');

			if (array_key_exists('redirect', $button_data)) {
				$button
					// Removing parameters not to conflict with the redirecting URL.
					->removeAttribute('name')
					->removeAttribute('value')
					->onClick('var $_form = jQuery(this).closest("form");'.
						// Save the original form action.
						'if (!$_form.data("action")) {'.
							'$_form.data("action", $_form.attr("action"));'.
						'}'.
						'$_form.attr("action", '.json_encode($button_data['redirect']).');'
					);
			}
			else {
				$button
					->setAttribute('value', $action)
					->onClick('var $_form = jQuery(this).closest("form");'.
						// Restore the original form action, if previously saved.
						'if ($_form.data("action")) {'.
							'$_form.attr("action", $_form.data("action"));'.
						'}'
					);
			}

			if (array_key_exists('disabled', $button_data)) {
				$button
					->setEnabled(!$button_data['disabled'])
					->setAttribute('data-disabled', $button_data['disabled']);
			}

			if (array_key_exists('confirm', $button_data)) {
				$button->setAttribute('confirm', $button_data['confirm']);
			}

			$this->buttons[$action] = $button;
		}
	}

	/**
	 * Returns current element for showing how many checkboxes are selected. If currently no
	 * element exists, constructs and returns default one.
	 *
	 * @return CObject
	 */
	public function getSelectedCountElement() {
		if (!$this->selected_count_element) {
			$this->selected_count_element = (new CSpan('0 '._('selected')))
				->setId('selected_count')
				->addClass(ZBX_STYLE_SELECTED_ITEM_COUNT);
		}

		return $this->selected_count_element;
	}

	/**
	 * Gets string representation of action button list.
	 *
	 * @param bool $destroy
	 *
	 * @return string
	 */
	public function toString($destroy = true) {
		zbx_add_post_js('chkbxRange.pageGoName = '.json_encode($this->checkboxes_name).';');
		zbx_add_post_js('chkbxRange.prefix = '.json_encode($this->name_prefix).';');

		$this->items[] = (new CDiv([$this->getSelectedCountElement(), $this->buttons]))
			->setId('action_buttons')
			->addClass(ZBX_STYLE_ACTION_BUTTONS);

		return parent::toString($destroy);
	}
}