/
ContactFormRequiredFieldsPlugin.php
172 lines (150 loc) · 4.33 KB
/
ContactFormRequiredFieldsPlugin.php
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<?php
/**
* Contact Form Required Fields plugin for Craft CMS
*
* Adds required fields to the Contact Form Plugin
*
* @author Stephen Bowling
* @copyright Copyright (c) 2016 Stephen Bowling
* @link https://stephenbowling.com
* @package ContactFormRequiredFields
* @since 1.0.0.
*/
namespace Craft;
class ContactFormRequiredFieldsPlugin extends BasePlugin
{
/**
* @return mixed
*/
public function init()
{
craft()->on('contactForm.onBeforeSend', function(Event $event) {
/**
* fromEmail - value of `fromEmail` field (required)
* fromName - value of `fromName` field (optional)
* subject - subject of email to send
* messageFields - array of fields in message
* message - string containing body of message
*/
$message = $event->params['message'];
/**
* To determine form validation rules, the ID of the entry
* used to create the form should be submitted along with the form
*/
$formId = craft()->request->getPost('formId');
$formId = craft()->security->validateData($formId);
/**
* Get the form entry using the ID
*/
if ($formId)
{
$formEntry = craft()->entries->getEntryById($formId);
}
if ($formEntry)
{
/**
* The Matrix used to create the fields
*/
$formFields = $formEntry->fieldBlocks;
/**
* An array to keep track of any fields marked required
*/
$requiredFields = array();
/**
* Loop through each block on the entry the form was created
* on and if the block has a `required` field set to `true`
* add the field's label to the `requiredFields` array
*/
foreach ($formFields as $formField) {
if (isset($formField->required) && $formField->required == true)
{
$requiredFields[] = $formField->label;
}
}
/**
* If we've determined there are required fields on this form,
* loop through the required fields and make sure the required
* exists and fields aren't blank
*/
foreach ($requiredFields as $requiredField) {
if (!array_key_exists($requiredField, $message['messageFields'])|(array_key_exists($requiredField, $message['messageFields']) && $message['messageFields'][$requiredField] == ""))
{
/**
* If a required field is blank add an error to
* the message and set $isValid to false
*/
$message->addError($requiredField, $requiredField.' is required');
$event->isValid = false;
}
}
}
else
{
$event->isValid = false;
}
});
}
/**
* @return mixed
*/
public function getName()
{
return Craft::t('Contact Form Required Fields');
}
/**
* @return mixed
*/
public function getDescription()
{
return Craft::t('Adds required fields to the Contact Form Plugin');
}
/**
* @return string
*/
public function getDocumentationUrl()
{
return '???';
}
/**
* @return string
*/
public function getReleaseFeedUrl()
{
return '???';
}
/**
* @return string
*/
public function getVersion()
{
return '1.0.0.';
}
/**
* @return string
*/
public function getSchemaVersion()
{
return '1.0.0.';
}
/**
* @return string
*/
public function getDeveloper()
{
return 'Stephen Bowling';
}
/**
* @return string
*/
public function getDeveloperUrl()
{
return 'https://stephenbowling.com';
}
/**
* @return bool
*/
public function hasCpSection()
{
return false;
}
}