Button.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 1.3.1

matomo / app / libs / HTML / QuickForm2 / Element / Button.php

matomo / app / libs / HTML / QuickForm2 / Element Last commit date

Button.php 6 years ago Date.php 6 years ago Input.php 6 years ago InputButton.php 6 years ago InputCheckable.php 6 years ago InputCheckbox.php 6 years ago InputFile.php 6 years ago InputHidden.php 6 years ago InputImage.php 6 years ago InputPassword.php 6 years ago InputRadio.php 6 years ago InputReset.php 6 years ago InputSubmit.php 6 years ago InputText.php 6 years ago Select.php 6 years ago Static.php 6 years ago Textarea.php 6 years ago

Button.php

162 lines

1	<?php
2	/**
3	* Class for <button> elements
4	*
5	* PHP version 5
6	*
7	* LICENSE:
8	*
9	* Copyright (c) 2006-2010, Alexey Borzov <avb@php.net>,
10	* Bertrand Mansion <golgote@mamasam.com>
11	* All rights reserved.
12	*
13	* Redistribution and use in source and binary forms, with or without
14	* modification, are permitted provided that the following conditions
15	* are met:
16	*
17	* * Redistributions of source code must retain the above copyright
18	* notice, this list of conditions and the following disclaimer.
19	* * Redistributions in binary form must reproduce the above copyright
20	* notice, this list of conditions and the following disclaimer in the
21	* documentation and/or other materials provided with the distribution.
22	* * The names of the authors may not be used to endorse or promote products
23	* derived from this software without specific prior written permission.
24	*
25	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
26	* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27	* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
29	* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32	* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
33	* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34	* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36	*
37	* @category HTML
38	* @package HTML_QuickForm2
39	* @author Alexey Borzov <avb@php.net>
40	* @author Bertrand Mansion <golgote@mamasam.com>
41	* @license http://opensource.org/licenses/bsd-license.php New BSD License
42	* @version SVN: $Id: Button.php 300722 2010-06-24 10:15:52Z mansion $
43	* @link http://pear.php.net/package/HTML_QuickForm2
44	*/
45
46	/**
47	* Base class for simple HTML_QuickForm2 elements
48	*/
49	// require_once 'HTML/QuickForm2/Element.php';
50
51	/**
52	* Class for <button> elements
53	*
54	* Note that this element was named 'xbutton' in previous version of QuickForm,
55	* the name 'button' being used for current 'inputbutton' element.
56	*
57	* @category HTML
58	* @package HTML_QuickForm2
59	* @author Alexey Borzov <avb@php.net>
60	* @author Bertrand Mansion <golgote@mamasam.com>
61	* @version Release: @package_version@
62	*/
63	class HTML_QuickForm2_Element_Button extends HTML_QuickForm2_Element
64	{
65	/**
66	* Contains options and data used for the element creation
67	* - content: Content to be displayed between <button></button> tags
68	* @var array
69	*/
70	protected $data = array('content' => '');
71
72	/**
73	* Element's submit value
74	* @var string
75	*/
76	protected $submitValue = null;
77
78
79	public function getType()
80	{
81	return 'button';
82	}
83
84	/**
85	* Buttons can not be frozen
86	*
87	* @param bool Whether element should be frozen or editable. This
88	* parameter is ignored in case of buttons
89	* @return bool Always returns false
90	*/
91	public function toggleFrozen($freeze = null)
92	{
93	return false;
94	}
95
96	/**
97	* Sets the contents of the button element
98	*
99	* @param string Button content (HTML to add between <button></button> tags)
100	* @return HTML_QuickForm2_Element_Button
101	*/
102	function setContent($content)
103	{
104	$this->data['content'] = $content;
105	return $this;
106	}
107
108	/**
109	* Button's value cannot be set via this method
110	*
111	* @param mixed Element's value, this parameter is ignored
112	* @return HTML_QuickForm2_Element_Button
113	*/
114	public function setValue($value)
115	{
116	return $this;
117	}
118
119	/**
120	* Returns the element's value
121	*
122	* The value is only returned if the following is true
123	* - button has 'type' attribute set to 'submit' (or no 'type' attribute)
124	* - the form was submitted by clicking on this button
125	*
126	* This method returns the actual value submitted by the browser. Note that
127	* different browsers submit different values!
128	*
129	* @return string\|null
130	*/
131	public function getValue()
132	{
133	if ((empty($this->attributes['type']) \|\| 'submit' == $this->attributes['type']) &&
134	!$this->getAttribute('disabled'))
135	{
136	return $this->applyFilters($this->submitValue);
137	} else {
138	return null;
139	}
140	}
141
142	public function __toString()
143	{
144	return $this->getIndent() . '<button' . $this->getAttributes(true) .
145	'>' . $this->data['content'] . '</button>';
146	}
147
148	public function updateValue()
149	{
150	foreach ($this->getDataSources() as $ds) {
151	if ($ds instanceof HTML_QuickForm2_DataSource_Submit &&
152	null !== ($value = $ds->getValue($this->getName())))
153	{
154	$this->submitValue = $value;
155	return;
156	}
157	}
158	$this->submitValue = null;
159	}
160	}
161	?>
162