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

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

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

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

Button.php

148 lines

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