FEATURE: added ability to have a clear form button. MINOR: setting up functions for deleting submissions

This commit is contained in:
Will Rossiter 2009-04-14 22:59:46 +00:00
parent d3a3122b84
commit 74442bfd89
5 changed files with 115 additions and 30 deletions

View File

@ -41,6 +41,7 @@ class UserDefinedForm extends Page {
"EmailOnSubmitSubject" => "Varchar(200)",
"SubmitButtonText" => "Varchar",
"OnCompleteMessage" => "HTMLText",
"ShowClearButton" => "Boolean"
);
/**
@ -63,8 +64,6 @@ class UserDefinedForm extends Page {
"EmailRecipients" => "UserDefinedForm_EmailRecipient"
);
protected $fields;
/**
* Setup the CMS Fields for the User Defined Form
*
@ -74,11 +73,36 @@ class UserDefinedForm extends Page {
$fields = parent::getCMSFields();
// field editor
$fields->addFieldToTab("Root."._t('UserDefinedForm.FORM', 'Form'), new FieldEditor("Fields", 'Fields', "", $this ));
$fields->addFieldToTab("Root.Content."._t('UserDefinedForm.FORM', 'Form'), new FieldEditor("Fields", 'Fields', "", $this ));
// view the submissions
$fields->addFieldToTab("Root."._t('UserDefinedForm.SUBMISSIONS','Submissions'), new SubmittedFormReportField( "Reports", _t('UserDefinedForm.RECEIVED', 'Received Submissions'), "", $this ) );
$fields->addFieldToTab("Root.Content."._t('UserDefinedForm.SUBMISSIONS','Submissions'), new SubmittedFormReportField( "Reports", _t('UserDefinedForm.RECEIVED', 'Received Submissions'), "", $this ) );
/*
Trying to get submissions working as a tablelistfield. close, but not close enough
$query = new SQLQuery();
$query->from("SubmittedForm");
$query->where("SubmittedForm.ParentID = '$this->ID'");
$query->orderby("SubmittedForm.Created");
$query->limit("20");
$query->leftJoin("SubmittedFormField", "SubmittedFormField.ParentID = SubmittedForm.ID");
$myTableListField = new TableListField(
'Submissions',
'SubmittedForm'
);
$myTableListField->setCustomQuery($query);
$fieldValues = array(
"Title" => "Title",
"Value" => "$Value",
"Name" => "$Name",
"ID" => "$ID",
"ParentID" => "$ParentID"
);
$myTableListField->setFieldList($fieldValues);
$fields->addFieldToTab("Root.Test", $myTableListField);
*/
// who do we email on submission
$emailRecipients = new HasManyComplexTableField($this,
'EmailRecipients',
@ -91,7 +115,7 @@ class UserDefinedForm extends Page {
'getCMSFields_forPopup'
);
$emailRecipients->setAddTitle(_t('UserDefinedForm.AEMAILRECIPIENT', 'A Email Recipient'));
$fields->addFieldToTab("Root."._t('UserDefinedForm.EMAILRECIPIENTS', 'Email Recipients'), $emailRecipients);
$fields->addFieldToTab("Root.Content."._t('UserDefinedForm.EMAILRECIPIENTS', 'Email Recipients'), $emailRecipients);
// text to show on complete
$onCompleteFieldSet = new FieldSet(
@ -187,21 +211,34 @@ class UserDefinedForm extends Page {
return new SubmittedFormReportField_FilterForm( $this, 'ReportFilterForm' );
}
function delete() {
// remove all the fields associated with this page
foreach( $this->Fields() as $field )
/**
* Called on before delete remove all the fields from the database
*/
public function delete() {
foreach($this->Fields() as $field) {
$field->delete();
}
parent::delete();
}
public function customFormActions( $isReadonly = false ) {
return new FieldSet( new TextField( "SubmitButtonText", _t('UserDefinedForm.TEXTONSUBMIT', 'Text on submit button:'), $this->SubmitButtonText ) );
/**
* 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();
@ -224,9 +261,8 @@ class UserDefinedForm extends Page {
class UserDefinedForm_Controller extends Page_Controller {
function init() {
Requirements::javascript(THIRDPARTY_DIR . 'jsparty/prototype-safe.js');
Requirements::javascript(THIRDPARTY_DIR . 'jsparty/behaviour.js');
Requirements::javascript(THIRDPARTY_DIR . '/prototype.js');
Requirements::javascript(THIRDPARTY_DIR . '/behaviour.js');
parent::init();
}
@ -323,6 +359,10 @@ class UserDefinedForm_Controller extends Page_Controller {
}
}
function ReportFilterForm() {
return new SubmittedFormReportField_FilterForm( $this, 'ReportFilterForm' );
}
/**
* 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
@ -354,18 +394,29 @@ class UserDefinedForm_Controller extends Page_Controller {
// Build actions
$actions = new FieldSet(
new FormAction( "process", $this->SubmitButtonText )
new FormAction("process", $this->SubmitButtonText)
);
// set the name of the form
$form = new Form( $this, "Form", $fields, $actions, new RequiredFields( $required ) );
// Do we want to add a clear form. Should do this via js
if($this->ShowClearButton) {
$actions->push(new ResetFormAction("clearForm"));
}
$form = new Form( $this, "Form", $fields, $actions, new RequiredFields($required));
$form->loadDataFrom($this->failover);
return $form;
}
function ReportFilterForm() {
return new SubmittedFormReportField_FilterForm( $this, 'ReportFilterForm' );
/**
* Clear a form action. This is the fall back to if it doesn't work
* with the javascript
*
* @param Array data
* @param Form The form to clear
*/
public function clearForm($data, $form) {
Session::clear('FormInfo.Form');
return Director::redirectBack();
}
/**
@ -521,6 +572,11 @@ class UserDefinedForm_Controller extends Page_Controller {
return $templateData;
}
function deletesubmissions() {
// delete all the submissions
return true;
}
}
/**

View File

@ -83,9 +83,11 @@ class FieldEditor extends FormField {
$name = $this->name;
$fieldSet = $record->$name();
// @todo shouldn't we deal with customFormActions on that object?
$record->EmailTo = $_REQUEST[$name]['EmailTo'];
$record->EmailOnSubmit = isset( $_REQUEST[$name]['EmailOnSubmit'] ) ? "1" : "0";
$record->SubmitButtonText = $_REQUEST[$name]['SubmitButtonText'];
$record->ShowClearButton = isset($_REQUEST[$name]['ShowClearButton']) ? "1" : "0";
// store the field IDs and delete the missing fields
// alternatively, we could delete all the fields and re add them

View File

@ -9,14 +9,19 @@ class SubmittedForm extends DataObject {
"Parent" => "UserDefinedForm",
);
static $db = array(
"Recipient" => "Varchar(255)"
);
static $has_many = array(
"FieldValues" => "SubmittedFormField"
);
/**
* Return the Link to DeleteLink
*
* @return String
*/
public function DeleteLink() {
return $this->Parent()->Link().'deletesubmission/'.$this->ID;
}
function SubmitTime() {
return $this->Created;
}

View File

@ -14,5 +14,6 @@ class SubmittedFormField extends DataObject {
static $has_one = array(
"Parent" => "SubmittedForm"
);
}
?>

View File

@ -1,7 +1,8 @@
<?php
/**
* Displays a summary of instances of a form submitted to the website
* @package cms
*
* @package userforms
*/
class SubmittedFormReportField extends FormField {
@ -11,15 +12,35 @@ class SubmittedFormReportField extends FormField {
return $this->renderWith("SubmittedFormReportField");
}
/**
* Return the submissions from the site
*
* @return ComponentSet
*/
function Submissions() {
return $this->form->getRecord()->Submissions();
}
/**
* Link to the export function of the controller
*
* @return String
*/
function ExportLink() {
if($this->Submissions() && $this->Submissions()->Count() > 0) {
return $this->form->getRecord()->Link() . 'export/' . $this->form->getRecord()->ID;
}
}
/**
* Link to the delete the submission
*
* @return String
*/
function DeleteLink() {
if($this->Submissions() && $this->Submissions()->Count() > 0) {
return $this->form->getRecord()->Link() . 'deletesubmissions/' . $this->form->getRecord()->ID;
}
}
}
?>