mirror of
https://github.com/silverstripe/silverstripe-userforms.git
synced 2024-10-22 17:05:42 +02:00
refactor how getCMSFields is built to handle no parent form
This commit is contained in:
Andrew Aitken-Fincham
parent
20570ef108
commit
bc5c6221f0
@ -2,7 +2,6 @@
|
||||
|
||||
namespace SilverStripe\UserForms\Model\Recipient;
|
||||
|
||||
use SilverStripe\Admin\LeftAndMain;
|
||||
use SilverStripe\Assets\FileFinder;
|
||||
use SilverStripe\CMS\Controllers\CMSMain;
|
||||
use SilverStripe\CMS\Controllers\CMSPageEditController;
|
||||
@ -27,9 +26,11 @@ use SilverStripe\Forms\TabSet;
|
||||
use SilverStripe\Forms\TextareaField;
|
||||
use SilverStripe\Forms\TextField;
|
||||
use SilverStripe\ORM\ArrayList;
|
||||
use SilverStripe\ORM\DataList;
|
||||
use SilverStripe\ORM\DataObject;
|
||||
use SilverStripe\ORM\DB;
|
||||
use SilverStripe\ORM\FieldType\DBField;
|
||||
use SilverStripe\ORM\ValidationResult;
|
||||
use SilverStripe\UserForms\Model\EditableFormField;
|
||||
use SilverStripe\UserForms\Model\EditableFormField\EditableEmailField;
|
||||
use SilverStripe\UserForms\Model\EditableFormField\EditableMultipleOptionField;
|
||||
@ -75,7 +76,7 @@ class EmailRecipient extends DataObject
|
||||
'CustomRules',
|
||||
];
|
||||
|
||||
private static $cascade_deetes = [
|
||||
private static $cascade_deletes = [
|
||||
'CustomRules',
|
||||
];
|
||||
|
||||
@ -123,7 +124,7 @@ class EmailRecipient extends DataObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Get instance of UserDefinedForm when editing in getCMSFields
|
||||
* Get instance of UserForm when editing in getCMSFields
|
||||
*
|
||||
* @return UserDefinedForm
|
||||
*/
|
||||
@ -132,10 +133,10 @@ class EmailRecipient extends DataObject
|
||||
// LeftAndMain::sessionNamespace is protected. @todo replace this with a non-deprecated equivalent.
|
||||
$sessionNamespace = $this->config()->get('session_namespace') ?: CMSMain::class;
|
||||
|
||||
$formID = $this->FormID
|
||||
? $this->FormID
|
||||
: Controller::curr()->getRequest()->getSession()->get($sessionNamespace . '.currentPage');
|
||||
return UserDefinedForm::get()->byID($formID);
|
||||
$formID = $this->FormID ?: Controller::curr()->getRequest()->getSession()->get($sessionNamespace . '.currentPage');
|
||||
$formClass = $this->FormClass ?: UserDefinedForm::class;
|
||||
|
||||
return $formClass::get()->byID($formID);
|
||||
}
|
||||
|
||||
public function getTitle()
|
||||
@ -156,6 +157,9 @@ class EmailRecipient extends DataObject
|
||||
*/
|
||||
protected function getRulesConfig()
|
||||
{
|
||||
if (!$this->getFormParent()) {
|
||||
return null;
|
||||
}
|
||||
$formFields = $this->getFormParent()->Fields();
|
||||
|
||||
$config = GridFieldConfig::create()
|
||||
@ -190,122 +194,17 @@ class EmailRecipient extends DataObject
|
||||
{
|
||||
Requirements::javascript('silverstripe/userforms:client/dist/js/userforms-cms.js');
|
||||
|
||||
// Determine optional field values
|
||||
$form = $this->getFormParent();
|
||||
|
||||
// predefined choices are also candidates
|
||||
$multiOptionFields = EditableMultipleOptionField::get()->filter('ParentID', $form->ID);
|
||||
|
||||
// if they have email fields then we could send from it
|
||||
$validEmailFromFields = EditableEmailField::get()->filter('ParentID', $form->ID);
|
||||
|
||||
// For the subject, only one-line entry boxes make sense
|
||||
$validSubjectFields = ArrayList::create(
|
||||
EditableTextField::get()
|
||||
->filter('ParentID', $form->ID)
|
||||
->exclude('Rows:GreaterThan', 1)
|
||||
->toArray()
|
||||
);
|
||||
$validSubjectFields->merge($multiOptionFields);
|
||||
|
||||
|
||||
// Check valid email-recipient fields
|
||||
if ($this->config()->get('allow_unbound_recipient_fields')) {
|
||||
// To address can only be email fields or multi option fields
|
||||
$validEmailToFields = ArrayList::create($validEmailFromFields->toArray());
|
||||
$validEmailToFields->merge($multiOptionFields);
|
||||
} else {
|
||||
// To address cannot be unbound, so restrict to pre-defined lists
|
||||
$validEmailToFields = $multiOptionFields;
|
||||
}
|
||||
|
||||
// Build fieldlist
|
||||
$fields = FieldList::create(Tabset::create('Root')->addExtraClass('EmailRecipientForm'));
|
||||
|
||||
// Configuration fields
|
||||
$fields->addFieldsToTab('Root.EmailDetails', [
|
||||
// Subject
|
||||
FieldGroup::create(
|
||||
TextField::create(
|
||||
'EmailSubject',
|
||||
_t('SilverStripe\\UserForms\\Model\\UserDefinedForm.TYPESUBJECT', 'Type subject')
|
||||
)
|
||||
->setAttribute('style', 'min-width: 400px;'),
|
||||
DropdownField::create(
|
||||
'SendEmailSubjectFieldID',
|
||||
_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.SELECTAFIELDTOSETSUBJECT',
|
||||
'.. or select a field to use as the subject'
|
||||
),
|
||||
$validSubjectFields->map('ID', 'Title')
|
||||
)->setEmptyString('')
|
||||
)
|
||||
->setTitle(_t('SilverStripe\\UserForms\\Model\\UserDefinedForm.EMAILSUBJECT', 'Email subject')),
|
||||
|
||||
// To
|
||||
FieldGroup::create(
|
||||
TextField::create(
|
||||
'EmailAddress',
|
||||
_t('SilverStripe\\UserForms\\Model\\UserDefinedForm.TYPETO', 'Type to address')
|
||||
)
|
||||
->setAttribute('style', 'min-width: 400px;'),
|
||||
DropdownField::create(
|
||||
'SendEmailToFieldID',
|
||||
_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.ORSELECTAFIELDTOUSEASTO',
|
||||
'.. or select a field to use as the to address'
|
||||
),
|
||||
$validEmailToFields->map('ID', 'Title')
|
||||
)->setEmptyString(' ')
|
||||
)
|
||||
->setTitle(_t('SilverStripe\\UserForms\\Model\\UserDefinedForm.SENDEMAILTO', 'Send email to'))
|
||||
->setDescription(_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.SENDEMAILTO_DESCRIPTION',
|
||||
'You may enter multiple email addresses as a comma separated list.'
|
||||
)),
|
||||
|
||||
|
||||
// From
|
||||
TextField::create(
|
||||
'EmailFrom',
|
||||
_t('SilverStripe\\UserForms\\Model\\UserDefinedForm.FROMADDRESS', 'Send email from')
|
||||
)
|
||||
->setDescription(_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.EmailFromContent',
|
||||
"The from address allows you to set who the email comes from. On most servers this ".
|
||||
"will need to be set to an email address on the same domain name as your site. ".
|
||||
"For example on yoursite.com the from address may need to be something@yoursite.com. ".
|
||||
"You can however, set any email address you wish as the reply to address."
|
||||
)),
|
||||
|
||||
|
||||
// Reply-To
|
||||
FieldGroup::create(
|
||||
TextField::create('EmailReplyTo', _t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.TYPEREPLY',
|
||||
'Type reply address'
|
||||
))
|
||||
->setAttribute('style', 'min-width: 400px;'),
|
||||
DropdownField::create(
|
||||
'SendEmailFromFieldID',
|
||||
_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.ORSELECTAFIELDTOUSEASFROM',
|
||||
'.. or select a field to use as reply to address'
|
||||
),
|
||||
$validEmailFromFields->map('ID', 'Title')
|
||||
)->setEmptyString(' ')
|
||||
)
|
||||
->setTitle(_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.REPLYADDRESS',
|
||||
'Email for reply to'
|
||||
))
|
||||
->setDescription(_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.REPLYADDRESS_DESCRIPTION',
|
||||
'The email address which the recipient is able to \'reply\' to.'
|
||||
))
|
||||
$this->getSubjectCMSFields(),
|
||||
$this->getEmailToCMSFields(),
|
||||
$this->getEmailFromCMSFields(),
|
||||
$this->getEmailReplyToCMSFields(),
|
||||
]);
|
||||
|
||||
$fields->fieldByName('Root.EmailDetails')->setTitle(_t(__CLASS__.'.EMAILDETAILSTAB', 'Email Details'));
|
||||
$fields->fieldByName('Root.EmailDetails')->setTitle(_t(__CLASS__ . '.EMAILDETAILSTAB', 'Email Details'));
|
||||
|
||||
// Only show the preview link if the recipient has been saved.
|
||||
if (!empty($this->EmailTemplate)) {
|
||||
@ -375,7 +274,7 @@ class EmailRecipient extends DataObject
|
||||
);
|
||||
}
|
||||
|
||||
$fields->fieldByName('Root.EmailContent')->setTitle(_t(__CLASS__.'.EMAILCONTENTTAB', 'Email Content'));
|
||||
$fields->fieldByName('Root.EmailContent')->setTitle(_t(__CLASS__ . '.EMAILCONTENTTAB', 'Email Content'));
|
||||
|
||||
// Custom rules for sending this field
|
||||
$grid = GridField::create(
|
||||
@ -393,14 +292,20 @@ class EmailRecipient extends DataObject
|
||||
'CustomRulesCondition',
|
||||
_t('SilverStripe\\UserForms\\Model\\UserDefinedForm.SENDIF', 'Send condition'),
|
||||
[
|
||||
'Or' => _t('SilverStripe\\UserForms\\Model\\UserDefinedForm.SENDIFOR', 'Any conditions are true'),
|
||||
'And' => _t('SilverStripe\\UserForms\\Model\\UserDefinedForm.SENDIFAND', 'All conditions are true')
|
||||
'Or' => _t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.SENDIFOR',
|
||||
'Any conditions are true'
|
||||
),
|
||||
'And' => _t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.SENDIFAND',
|
||||
'All conditions are true'
|
||||
)
|
||||
]
|
||||
),
|
||||
$grid
|
||||
]);
|
||||
|
||||
$fields->fieldByName('Root.CustomRules')->setTitle(_t(__CLASS__.'.CUSTOMRULESTAB', 'Custom Rules'));
|
||||
$fields->fieldByName('Root.CustomRules')->setTitle(_t(__CLASS__ . '.CUSTOMRULESTAB', 'Custom Rules'));
|
||||
|
||||
$this->extend('updateCMSFields', $fields);
|
||||
return $fields;
|
||||
@ -619,4 +524,183 @@ class EmailRecipient extends DataObject
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return FieldGroup|TextField
|
||||
*/
|
||||
protected function getSubjectCMSFields()
|
||||
{
|
||||
$subjectTextField = TextField::create(
|
||||
'EmailSubject',
|
||||
_t('SilverStripe\\UserForms\\Model\\UserDefinedForm.TYPESUBJECT', 'Type subject')
|
||||
)
|
||||
->setAttribute('style', 'min-width: 400px;');
|
||||
|
||||
if ($this->getFormParent() && $this->getValidSubjectFields()) {
|
||||
return FieldGroup::create(
|
||||
$subjectTextField,
|
||||
DropdownField::create(
|
||||
'SendEmailSubjectFieldID',
|
||||
_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.SELECTAFIELDTOSETSUBJECT',
|
||||
'.. or select a field to use as the subject'
|
||||
),
|
||||
$this->getValidSubjectFields()->map('ID', 'Title')
|
||||
)->setEmptyString('')
|
||||
)
|
||||
->setTitle(_t('SilverStripe\\UserForms\\Model\\UserDefinedForm.EMAILSUBJECT', 'Email subject'));
|
||||
} else {
|
||||
return $subjectTextField;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return FieldGroup|TextField
|
||||
*/
|
||||
protected function getEmailToCMSFields()
|
||||
{
|
||||
$emailToTextField = TextField::create(
|
||||
'EmailAddress',
|
||||
_t('SilverStripe\\UserForms\\Model\\UserDefinedForm.TYPETO', 'Type to address')
|
||||
)
|
||||
->setAttribute('style', 'min-width: 400px;');
|
||||
|
||||
if ($this->getFormParent() && $this->getValidEmailToFields()) {
|
||||
return FieldGroup::create(
|
||||
$emailToTextField,
|
||||
DropdownField::create(
|
||||
'SendEmailToFieldID',
|
||||
_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.ORSELECTAFIELDTOUSEASTO',
|
||||
'.. or select a field to use as the to address'
|
||||
),
|
||||
$this->getValidEmailToFields()->map('ID', 'Title')
|
||||
)->setEmptyString(' ')
|
||||
)
|
||||
->setTitle(_t('SilverStripe\\UserForms\\Model\\UserDefinedForm.SENDEMAILTO', 'Send email to'))
|
||||
->setDescription(_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.SENDEMAILTO_DESCRIPTION',
|
||||
'You may enter multiple email addresses as a comma separated list.'
|
||||
));
|
||||
} else {
|
||||
return $emailToTextField;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return TextField
|
||||
*/
|
||||
protected function getEmailFromCMSFields()
|
||||
{
|
||||
return TextField::create(
|
||||
'EmailFrom',
|
||||
_t('SilverStripe\\UserForms\\Model\\UserDefinedForm.FROMADDRESS', 'Send email from')
|
||||
)
|
||||
->setDescription(_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.EmailFromContent',
|
||||
"The from address allows you to set who the email comes from. On most servers this " .
|
||||
"will need to be set to an email address on the same domain name as your site. " .
|
||||
"For example on yoursite.com the from address may need to be something@yoursite.com. " .
|
||||
"You can however, set any email address you wish as the reply to address."
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return FieldGroup|TextField
|
||||
*/
|
||||
protected function getEmailReplyToCMSFields()
|
||||
{
|
||||
$replyToTextField = TextField::create('EmailReplyTo', _t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.TYPEREPLY',
|
||||
'Type reply address'
|
||||
))
|
||||
->setAttribute('style', 'min-width: 400px;');
|
||||
if ($this->getFormParent() && $this->getValidEmailFromFields()) {
|
||||
return FieldGroup::create(
|
||||
$replyToTextField,
|
||||
DropdownField::create(
|
||||
'SendEmailFromFieldID',
|
||||
_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.ORSELECTAFIELDTOUSEASFROM',
|
||||
'.. or select a field to use as reply to address'
|
||||
),
|
||||
$this->getValidEmailFromFields()->map('ID', 'Title')
|
||||
)->setEmptyString(' ')
|
||||
)
|
||||
->setTitle(_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.REPLYADDRESS',
|
||||
'Email for reply to'
|
||||
))
|
||||
->setDescription(_t(
|
||||
'SilverStripe\\UserForms\\Model\\UserDefinedForm.REPLYADDRESS_DESCRIPTION',
|
||||
'The email address which the recipient is able to \'reply\' to.'
|
||||
));
|
||||
} else {
|
||||
return $replyToTextField;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return DataList|null
|
||||
*/
|
||||
protected function getMultiOptionFields()
|
||||
{
|
||||
if (!$form = $this->getFormParent()) {
|
||||
return null;
|
||||
}
|
||||
return EditableMultipleOptionField::get()->filter('ParentID', $form->ID);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return ArrayList|null
|
||||
*/
|
||||
protected function getValidSubjectFields()
|
||||
{
|
||||
if (!$form = $this->getFormParent()) {
|
||||
return null;
|
||||
}
|
||||
// For the subject, only one-line entry boxes make sense
|
||||
$validSubjectFields = ArrayList::create(
|
||||
EditableTextField::get()
|
||||
->filter('ParentID', $form->ID)
|
||||
->exclude('Rows:GreaterThan', 1)
|
||||
->toArray()
|
||||
);
|
||||
$validSubjectFields->merge($this->getMultiOptionFields());
|
||||
return $validSubjectFields;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return DataList|null
|
||||
*/
|
||||
protected function getValidEmailFromFields()
|
||||
{
|
||||
if (!$form = $this->getFormParent()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// if they have email fields then we could send from it
|
||||
return EditableEmailField::get()->filter('ParentID', $form->ID);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return ArrayList|DataList|null
|
||||
*/
|
||||
protected function getValidEmailToFields()
|
||||
{
|
||||
if ($this->getFormParent()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Check valid email-recipient fields
|
||||
if ($this->config()->get('allow_unbound_recipient_fields')) {
|
||||
// To address can only be email fields or multi option fields
|
||||
$validEmailToFields = ArrayList::create($this->getValidEmailFromFields()->toArray());
|
||||
$validEmailToFields->merge($this->getMultiOptionFields());
|
||||
return $validEmailToFields;
|
||||
} else {
|
||||
// To address cannot be unbound, so restrict to pre-defined lists
|
||||
return $this->getMultiOptionFields();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user