mirror of
https://github.com/silverstripe/silverstripe-userforms.git
synced 2024-10-22 17:05:42 +02:00
541 lines
15 KiB
PHP
Executable File
541 lines
15 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* User Defined Form Page type that lets users build a form in the CMS
|
|
* using the FieldEditor Field.
|
|
*
|
|
* @package userforms
|
|
*/
|
|
|
|
class UserDefinedForm extends Page {
|
|
|
|
/**
|
|
* @var String Add Action in the CMS
|
|
*/
|
|
static $add_action = "A User Form";
|
|
|
|
/**
|
|
* @var String Icon for the User Defined Form in the CMS. Without the extension
|
|
*/
|
|
static $icon = "cms/images/treeicons/task";
|
|
|
|
/**
|
|
* @var String What level permission is needed to edit / add
|
|
*/
|
|
static $need_permission = 'ADMIN';
|
|
|
|
/**
|
|
* @var Array Fields on the user defined form page.
|
|
*/
|
|
static $db = array(
|
|
"SubmitButtonText" => "Varchar",
|
|
"OnCompleteMessage" => "HTMLText",
|
|
"ShowClearButton" => "Boolean"
|
|
);
|
|
|
|
/**
|
|
* @var Array Default values of variables when this page is created
|
|
*/
|
|
static $defaults = array(
|
|
'Content' => '$UserDefinedForm',
|
|
'OnCompleteMessage' => '<p>Thanks, we\'ve received your submission.</p>'
|
|
);
|
|
|
|
/**
|
|
* @var Array
|
|
*/
|
|
static $has_many = array(
|
|
"Fields" => "EditableFormField",
|
|
"Submissions" => "SubmittedForm",
|
|
"EmailRecipients" => "UserDefinedForm_EmailRecipient"
|
|
);
|
|
|
|
/**
|
|
* Setup the CMS Fields for the User Defined Form
|
|
*
|
|
* @return FieldSet
|
|
*/
|
|
public function getCMSFields() {
|
|
$fields = parent::getCMSFields();
|
|
|
|
// field editor
|
|
$fields->addFieldToTab("Root.Content."._t('UserDefinedForm.FORM', 'Form'), new FieldEditor("Fields", 'Fields', "", $this ));
|
|
|
|
// view the submissions
|
|
$fields->addFieldToTab("Root.Content."._t('UserDefinedForm.SUBMISSIONS','Submissions'), new SubmittedFormReportField( "Reports", _t('UserDefinedForm.RECEIVED', 'Received Submissions'), "", $this ) );
|
|
|
|
// who do we email on submission
|
|
$emailRecipients = new HasManyComplexTableField($this,
|
|
'EmailRecipients',
|
|
'UserDefinedForm_EmailRecipient',
|
|
array(
|
|
'EmailAddress' => 'Email',
|
|
'EmailSubject' => 'Subject',
|
|
'EmailFrom' => 'From'
|
|
),
|
|
'getCMSFields_forPopup',
|
|
"FormID = '$this->ID'"
|
|
);
|
|
$emailRecipients->setAddTitle(_t('UserDefinedForm.AEMAILRECIPIENT', 'A Email Recipient'));
|
|
$fields->addFieldToTab("Root.Content."._t('UserDefinedForm.EMAILRECIPIENTS', 'Email Recipients'), $emailRecipients);
|
|
|
|
// text to show on complete
|
|
$onCompleteFieldSet = new FieldSet(
|
|
new HtmlEditorField( "OnCompleteMessage", _t('UserDefinedForm.ONCOMPLETELABEL', 'Show on completion'),3,"",_t('UserDefinedForm.ONCOMPLETEMESSAGE', $this->OnCompleteMessage), $this )
|
|
);
|
|
|
|
$fields->addFieldsToTab("Root.Content."._t('UserDefinedForm.ONCOMPLETE','On complete'), $onCompleteFieldSet);
|
|
|
|
return $fields;
|
|
}
|
|
|
|
/**
|
|
* Called on before delete remove all the fields from the database
|
|
*/
|
|
public function delete() {
|
|
foreach($this->Fields() as $field) {
|
|
$field->delete();
|
|
}
|
|
parent::delete();
|
|
}
|
|
|
|
/**
|
|
* Custom Form Actions for the form
|
|
*
|
|
* @param bool Is the Form readonly
|
|
* @return FieldSet
|
|
*/
|
|
public function customFormActions($isReadonly = false) {
|
|
return new FieldSet(
|
|
new TextField("SubmitButtonText", _t('UserDefinedForm.TEXTONSUBMIT', 'Text on submit button:'), $this->SubmitButtonText),
|
|
new CheckboxField("ShowClearButton", _t('UserDefinedForm.SHOWCLEARFORM', 'Show Clear Form Button'), $this->ShowClearButton)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Duplicate this UserDefinedForm page, and its form fields.
|
|
* Submissions, on the other hand, won't be duplicated.
|
|
*
|
|
* @return Page
|
|
*/
|
|
public function duplicate() {
|
|
$page = parent::duplicate();
|
|
foreach($this->Fields() as $field) {
|
|
$newField = $field->duplicate();
|
|
$newField->ParentID = $page->ID;
|
|
$newField->write();
|
|
}
|
|
return $page;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Controller for the {@link UserDefinedForm} page type.
|
|
*
|
|
* @package userform
|
|
* @subpackage pagetypes
|
|
*/
|
|
|
|
class UserDefinedForm_Controller extends Page_Controller {
|
|
|
|
/**
|
|
* Load all the custom jquery needed to run the custom
|
|
* validation
|
|
*/
|
|
public function init() {
|
|
// block prototype validation
|
|
Validator::set_javascript_validation_handler('none');
|
|
|
|
// load the jquery
|
|
Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
|
|
Requirements::javascript(THIRDPARTY_DIR . '/jquery/plugins/validate/jquery.validate.min.js');
|
|
|
|
parent::init();
|
|
}
|
|
|
|
/**
|
|
* Using $UserDefinedForm in the Content area of the page shows
|
|
* where the form should be rendered into. If it does not exist
|
|
* then default back to $Form
|
|
*
|
|
* @return Array
|
|
*/
|
|
public function index() {
|
|
if($this->Content && $form = $this->Form()) {
|
|
$hasLocation = stristr($this->Content, '$UserDefinedForm');
|
|
if($hasLocation) {
|
|
$content = str_ireplace('$UserDefinedForm', $form->forTemplate(), $this->Content);
|
|
return array(
|
|
'Content' => $content,
|
|
'Form' => ""
|
|
);
|
|
}
|
|
}
|
|
return array(
|
|
'Content' => $this->Content,
|
|
'Form' => $this->Form
|
|
);
|
|
}
|
|
|
|
/**
|
|
* User Defined Form. Feature of the user defined form is if you want the
|
|
* form to appear in a custom location on the page you can use $UserDefinedForm
|
|
* in the content area to describe where you want the form
|
|
*
|
|
* @return Form
|
|
*/
|
|
public function Form() {
|
|
$fields = new FieldSet();
|
|
$fieldValidation = array();
|
|
$fieldValidationRules = array();
|
|
$CustomDisplayRules = "";
|
|
$defaults = "";
|
|
$this->SubmitButtonText = ($this->SubmitButtonText) ? $this->SubmitButtonText : _t('UserDefinedForm.SUBMITBUTTON', 'Submit');
|
|
|
|
if($this->Fields()) {
|
|
foreach($this->Fields() as $field) {
|
|
|
|
$fieldToAdd = $field->getFormField();
|
|
|
|
if(!$fieldToAdd) break;
|
|
|
|
$fieldValidationOptions = array();
|
|
|
|
// Set the Error Messages
|
|
$errorMessage = sprintf(_t('Form.FIELDISREQUIRED').'.', strip_tags("'". ($field->Title ? $field->Title : $field->Name) . "'"));
|
|
$errorMessage = ($field->CustomErrorMessage) ? $field->CustomErrorMessage : $errorMessage;
|
|
$fieldToAdd->setCustomValidationMessage($errorMessage);
|
|
|
|
// Is this field required
|
|
if($field->Required) {
|
|
$fieldValidation[$field->Name] = $errorMessage;
|
|
$fieldValidationOptions['required'] = true;
|
|
}
|
|
|
|
// Add field to the form
|
|
$fields->push($fieldToAdd);
|
|
|
|
// Ask our form field for some more information on hour it should be validated
|
|
$fieldValidationOptions = array_merge($fieldValidationOptions, $field->getValidation());
|
|
|
|
// Check if we have need to update the global validation
|
|
if($fieldValidationOptions) {
|
|
$fieldValidationRules[$field->Name] = $fieldValidationOptions;
|
|
}
|
|
|
|
// Is this Field Show by Default
|
|
if(!$field->ShowOnLoad) {
|
|
$defaults .= "$(\"#" . $field->Name . "\").hide();\n";
|
|
}
|
|
|
|
// Check for field dependencies / default
|
|
if($field->Dependencies()) {
|
|
|
|
foreach($field->Dependencies() as $dependency) {
|
|
if(is_array($dependency) && isset($dependency['ConditionField']) && $dependency['ConditionField'] != "") {
|
|
// get the field which is effected
|
|
$formName = Convert::raw2sql($dependency['ConditionField']);
|
|
$formFieldWatch = DataObject::get_one("EditableFormField", "Name = '$formName'");
|
|
if(!$formFieldWatch) break;
|
|
|
|
$fieldToWatch = "$(\"#Form_Form_".$dependency['ConditionField']."\")";
|
|
|
|
// show or hide?
|
|
$view = (isset($dependency['Display']) && $dependency['Display'] == "Show") ? "show" : "hide";
|
|
$opposite = ($view == "show") ? "hide" : "show";
|
|
|
|
$Action = ($formFieldWatch->ClassName == "EditableTextField") ? "keyup" : "change";
|
|
|
|
switch($dependency['ConditionOption']) {
|
|
case 'IsNotBlank':
|
|
$matches = '!= ""';
|
|
break;
|
|
case 'IsBlank':
|
|
$matches = '== ""';
|
|
break;
|
|
case 'HasValue':
|
|
$matches = '== "'. $dependency['Value'] .'"';
|
|
break;
|
|
default:
|
|
$matches = '!= "'. $dependency['Value'] .'"';
|
|
break;
|
|
}
|
|
// put it all together
|
|
$CustomDisplayRules .= $fieldToWatch.".$Action(function() {
|
|
if($(this).val() ". $matches ." ) {
|
|
$(\"#". $field->Name ."\").".$view."();
|
|
}
|
|
else {
|
|
$(\"#". $field->Name ."\").".$opposite."();
|
|
}
|
|
});";
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
$referer = isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : '';
|
|
|
|
// Keep track of the referer
|
|
$fields->push( new HiddenField( "Referrer", "", $referer ) );
|
|
|
|
// Build actions
|
|
$actions = new FieldSet(
|
|
new FormAction("process", $this->SubmitButtonText)
|
|
);
|
|
|
|
// Do we want to add a clear form.
|
|
if($this->ShowClearButton) {
|
|
$actions->push(new ResetFormAction("clearForm"));
|
|
}
|
|
// return the form
|
|
$form = new Form( $this, "Form", $fields, $actions, new RequiredFields(array_keys($fieldValidation)));
|
|
$form->loadDataFrom($this->failover);
|
|
|
|
$FormName = $form->FormName();
|
|
|
|
// Set the Form Name
|
|
$rules = $this->array2json($fieldValidationRules);
|
|
$messages = $this->array2json($fieldValidation);
|
|
|
|
|
|
// set the custom script for this form
|
|
Requirements::customScript(<<<JS
|
|
(function($) {
|
|
$(document).ready(function() {
|
|
$defaults
|
|
$("#$FormName").validate({
|
|
errorClass: "required",
|
|
messages:
|
|
$messages
|
|
,
|
|
|
|
rules:
|
|
$rules
|
|
});
|
|
$CustomDisplayRules
|
|
});
|
|
})(jQuery);
|
|
JS
|
|
);
|
|
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Convert a PHP array to a JSON string. We cannot use {@link Convert::array2json}
|
|
* as it escapes our values with "" which appears to break the validate plugin
|
|
*
|
|
* @param Array array to convert
|
|
* @return JSON
|
|
*/
|
|
protected function array2json($array) {
|
|
foreach($array as $key => $value)
|
|
if(is_array( $value )) {
|
|
$result[] = "$key:" . $this->array2json($value);
|
|
} else {
|
|
$value = (is_bool($value)) ? $value : "\"$value\"";
|
|
$result[] = "$key:$value \n";
|
|
}
|
|
return (isset($result)) ? "{\n".implode( ', ', $result ) ."} \n": '{}';
|
|
}
|
|
|
|
/**
|
|
* Process the form that is submitted through the site
|
|
*
|
|
* @param Array Data
|
|
* @param Form Form
|
|
* @return Redirection
|
|
*/
|
|
function process($data, $form) {
|
|
// submitted form object
|
|
$submittedForm = new SubmittedForm();
|
|
$submittedForm->SubmittedBy = Member::currentUser();
|
|
$submittedForm->ParentID = $this->ID;
|
|
$submittedForm->Recipient = $this->EmailTo;
|
|
$submittedForm->write();
|
|
|
|
// email values
|
|
$values = array();
|
|
$recipientAddresses = array();
|
|
$sendCopy = false;
|
|
$attachments = array();
|
|
|
|
$submittedFields = new DataObjectSet();
|
|
|
|
foreach($this->Fields() as $field) {
|
|
$submittedField = new SubmittedFormField();
|
|
$submittedField->ParentID = $submittedForm->ID;
|
|
$submittedField->Name = $field->Name;
|
|
$submittedField->Title = $field->Title;
|
|
|
|
if($field->hasMethod('getValueFromData')) {
|
|
$submittedField->Value = $field->getValueFromData($data);
|
|
}
|
|
else {
|
|
if(isset($data[$field->Name])) $submittedField->Value = $data[$field->Name];
|
|
}
|
|
|
|
$submittedField->write();
|
|
$submittedFields->push($submittedField);
|
|
|
|
if(!empty($data[$field->Name])){
|
|
/**
|
|
* @todo this should be on the EditableFile class. Just need to sort out
|
|
* attachments array
|
|
*/
|
|
if($field->ClassName == "EditableFileField"){
|
|
if(isset($_FILES[$field->Name])) {
|
|
|
|
// create the file from post data
|
|
$upload = new Upload();
|
|
$file = new File();
|
|
$upload->loadIntoFile($_FILES[$field->Name], $file);
|
|
|
|
// write file to form field
|
|
$submittedField->UploadedFileID = $file->ID;
|
|
|
|
// Attach the file if its less than 1MB, provide a link if its over.
|
|
if($file->getAbsoluteSize() < 1024*1024*1){
|
|
$attachments[] = $file;
|
|
}
|
|
|
|
// Always provide the link if present.
|
|
if($file->ID) {
|
|
$submittedField->Value = "<a href=\"". $file->getFilename() ."\" title=\"". $file->getFilename() . "\">". $file->Title . "</a>";
|
|
} else {
|
|
$submittedField->Value = "";
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// make sure we save
|
|
$submittedField->write();
|
|
}
|
|
$emailData = array(
|
|
"Sender" => Member::currentUser(),
|
|
"Fields" => $submittedFields,
|
|
);
|
|
|
|
// email users on submit. All have their own custom options.
|
|
if($this->EmailRecipients()) {
|
|
$email = new UserDefinedForm_SubmittedFormEmail($submittedFields);
|
|
$email->populateTemplate($emailData);
|
|
if($attachments){
|
|
foreach($attachments as $file){
|
|
// bug with double decorated fields, valid ones should have an ID.
|
|
if($file->ID != 0) {
|
|
$email->attachFile($file->Filename,$file->Filename, $file->getFileType());
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach($this->EmailRecipients() as $recipient) {
|
|
$email->populateTemplate($emailData);
|
|
$email->setFrom($recipient->EmailFrom);
|
|
$email->setBody($recipient->EmailBody);
|
|
$email->setSubject($recipient->EmailSubject);
|
|
$email->setTo($recipient->EmailAddress);
|
|
// check to see if they are a dynamic recipient. eg based on a field
|
|
// a user selected
|
|
if($recipient->SendEmailFromFieldID) {
|
|
$name = Convert::raw2sql($recipient->SendEmailFromField()->Name);
|
|
$SubmittedFormField = DataObject::get_one("SubmittedFormField", "Name = '$name' AND ParentID = '$submittedForm->ID'");
|
|
if($SubmittedFormField) {
|
|
$email->setTo($SubmittedFormField->Value);
|
|
}
|
|
}
|
|
$email->send();
|
|
}
|
|
}
|
|
|
|
// Redirect to the finished method on this controller with the referrer data
|
|
Director::redirect($this->Link() . 'finished?referrer=' . urlencode($data['Referrer']));
|
|
}
|
|
|
|
/**
|
|
* This action handles rendering the "finished" message,
|
|
* which is customisable by editing the ReceivedFormSubmission.ss
|
|
* template.
|
|
*
|
|
* @return ViewableData
|
|
*/
|
|
function finished() {
|
|
$referrer = isset($_GET['referrer']) ? urldecode($_GET['referrer']) : null;
|
|
|
|
$templateData = $this->customise(array(
|
|
'Content' => $this->customise(
|
|
array(
|
|
'Link' => $referrer
|
|
))->renderWith('ReceivedFormSubmission'),
|
|
'Form' => ' ',
|
|
));
|
|
|
|
return $templateData;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* A Form can have multiply members / emails to email the submission
|
|
* to and custom subjects
|
|
*
|
|
* @package userforms
|
|
*/
|
|
class UserDefinedForm_EmailRecipient extends DataObject {
|
|
|
|
static $db = array(
|
|
'EmailAddress' => 'Varchar(200)',
|
|
'EmailSubject' => 'Varchar(200)',
|
|
'EmailFrom' => 'Varchar(200)',
|
|
'EmailBody' => 'HTMLText'
|
|
);
|
|
|
|
static $has_one = array(
|
|
'Form' => 'UserDefinedForm',
|
|
'SendEmailFromField' => 'EditableFormField'
|
|
);
|
|
|
|
/**
|
|
* Return the fields to edit this email.
|
|
*
|
|
* @return FieldSet
|
|
*/
|
|
public function getCMSFields_forPopup() {
|
|
$forms = DataObject::get("UserDefinedForm");
|
|
if($forms) $forms = $forms->toDropdownMap('ID', 'Title');
|
|
$fields = new FieldSet(
|
|
new TextField('EmailSubject', _t('UserDefinedForm.EMAILSUBJECT', 'Email Subject')),
|
|
new TextField('EmailFrom', _t('UserDefinedForm.FROMADDRESS','From Address')),
|
|
new TextField('EmailAddress', _t('UserDefinedForm.SENDEMAILTO','Send Email To')),
|
|
new DropdownField('FormID', 'Form', $forms)
|
|
);
|
|
|
|
if($this->Form()) {
|
|
$validEmailFields = DataObject::get("EditableFormField", "ParentID = '$this->FormID'");
|
|
|
|
if($validEmailFields) {
|
|
$validEmailFields = $validEmailFields->toDropdownMap('ID', 'Title');
|
|
$fields->push(new DropdownField('SendEmailFromFieldID', _t('UserDefinedForm.SENDEMAILINSTEAD', 'Send Email Instead To'),$validEmailFields, '', null, 'Use Fixed Email'));
|
|
}
|
|
}
|
|
$fields->push(new HTMLEditorField('EmailBody', 'Body'));
|
|
return $fields;
|
|
}
|
|
}
|
|
/**
|
|
* Email that gets sent to the people listed in the Email Recipients
|
|
* when a submission is made
|
|
*
|
|
* @package userforms
|
|
*/
|
|
class UserDefinedForm_SubmittedFormEmail extends Email {
|
|
protected $ss_template = "SubmittedFormEmail";
|
|
protected $data;
|
|
|
|
function __construct() {
|
|
parent::__construct();
|
|
}
|
|
}
|
|
|
|
?>
|