MDL-65069 mod_forum: Stripped out inpage form and advanced redirect
[moodle.git] / lib / form / submit.php
CommitLineData
a23f0aaf 1<?php
6c1fd304
RT
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17
18/**
19 * submit type form element
20 *
21 * Contains HTML class for a submit type element
22 *
23 * @package core_form
24 * @copyright 2006 Jamie Pratt <me@jamiep.org>
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 */
27
a23f0aaf 28require_once("HTML/QuickForm/submit.php");
344321e1 29require_once('templatable_form_element.php');
a23f0aaf 30
31/**
6c1fd304
RT
32 * submit type form element
33 *
a23f0aaf 34 * HTML class for a submit type element
35 *
6c1fd304
RT
36 * @package core_form
37 * @category form
38 * @copyright 2006 Jamie Pratt <me@jamiep.org>
39 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
a23f0aaf 40 */
91bda4cd 41class MoodleQuickForm_submit extends HTML_QuickForm_submit implements templatable {
344321e1
DW
42 use templatable_form_element {
43 export_for_template as export_for_template_base;
44 }
45
a91a4dd7
MN
46 /**
47 * @var bool $primary Is this button a primary button?
48 */
49 protected $primary;
50
6c1fd304
RT
51 /**
52 * constructor
53 *
54 * @param string $elementName (optional) name of the field
55 * @param string $value (optional) field label
56 * @param string $attributes (optional) Either a typical HTML attribute string or an associative array
a91a4dd7 57 * @param bool|null $primary Is this button a primary button?
6c1fd304 58 */
a91a4dd7 59 public function __construct($elementName=null, $value=null, $attributes=null, $primary = null) {
1a0df553 60 parent::__construct($elementName, $value, $attributes);
a91a4dd7
MN
61
62 // Fallback to legacy behaviour if no value specified.
63 if (is_null($primary)) {
64 $this->primary = $this->getName() != 'cancel';
65 } else {
66 $this->primary = $primary;
67 }
1a0df553
MG
68 }
69
70 /**
71 * Old syntax of class constructor. Deprecated in PHP7.
72 *
73 * @deprecated since Moodle 3.1
74 */
a91a4dd7 75 public function MoodleQuickForm_submit($elementName=null, $value=null, $attributes=null, $primary = null) {
1a0df553 76 debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
a91a4dd7 77 self::__construct($elementName, $value, $attributes, $primary);
3e8b394e 78 }
6c1fd304 79
a23f0aaf 80 /**
81 * Called by HTML_QuickForm whenever form event is made on this element
82 *
6c1fd304
RT
83 * @param string $event Name of event
84 * @param mixed $arg event arguments
85 * @param object $caller calling object
a23f0aaf 86 */
87 function onQuickFormEvent($event, $arg, &$caller)
88 {
89 switch ($event) {
90 case 'createElement':
91 parent::onQuickFormEvent($event, $arg, $caller);
92 if ($caller->isNoSubmitButton($arg[0])){
93 //need this to bypass client validation
94 //for buttons that submit but do not process the
95 //whole form.
96 $onClick = $this->getAttribute('onclick');
97 $skip = 'skipClientValidation = true;';
98 $onClick = ($onClick !== null)?$skip.' '.$onClick:$skip;
99 $this->updateAttributes(array('onclick'=>$onClick));
100 }
101 return true;
102 break;
103 }
104 return parent::onQuickFormEvent($event, $arg, $caller);
105
6c1fd304
RT
106 }
107
64360ee7 108 /**
109 * Slightly different container template when frozen. Don't want to display a submit
110 * button if the form is frozen.
111 *
112 * @return string
113 */
114 function getElementTemplateType(){
115 if ($this->_flagFrozen){
116 return 'nodisplay';
117 } else {
95114b18 118 return 'actionbuttons';
64360ee7 119 }
120 }
4a0e2e63 121
6c1fd304
RT
122 /**
123 * Freeze the element so that only its value is returned
124 */
64360ee7 125 function freeze(){
126 $this->_flagFrozen = true;
127 }
4a0e2e63 128
91bda4cd 129 public function export_for_template(renderer_base $output) {
344321e1 130 $context = $this->export_for_template_base($output);
a91a4dd7 131 if (!$this->primary) {
ce18fb1e 132 $context['secondary'] = true;
91bda4cd
DW
133 }
134 return $context;
135 }
a23f0aaf 136}