%s
', _t( 'SilverStripe\\UserForms\\Model\\UserDefinedForm.PREVIEW_EMAIL_UNAVAILABLE', 'You can preview this email once you have saved the Recipient.' @@ -375,7 +281,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( @@ -386,21 +292,29 @@ class EmailRecipient extends DataObject ); $grid->setDescription(_t( 'SilverStripe\\UserForms\\Model\\UserDefinedForm.RulesDescription', - 'Emails will only be sent to the recipient if the custom rules are met. If no rules are defined, this receipient will receive notifications for every submission.' + 'Emails will only be sent to the recipient if the custom rules are met. If no rules are defined, ' + . 'this recipient will receive notifications for every submission.' )); + $fields->addFieldsToTab('Root.CustomRules', [ DropdownField::create( '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 +533,197 @@ 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(); + } + } + + protected function getUnsavedFormLiteralField() + { + return LiteralField::create( + 'UnsavedFormMessage', + sprintf( + '%s
', + _t( + 'SilverStripe\\UserForms\\Model\\UserDefinedForm.EMAIL_RECIPIENT_UNSAVED_FORM', + 'You will be able to select from valid form fields after saving this record.' + ) + ) + ); + } } diff --git a/lang/en.yml b/lang/en.yml index c4f528e..a91fbad 100644 --- a/lang/en.yml +++ b/lang/en.yml @@ -221,6 +221,7 @@ en: EMAILBODYHTML: Body EMAILFROM: From EMAILRECIPIENTS: 'Email Recipients' + EMAIL_RECIPIENT_UNSAVED_FORM: 'You will be able to select from valid form fields after saving this record.' EMAILSUBJECT: 'Email subject' EMAILTEMPLATE: 'Email template' ENABLELIVEVALIDATION: 'Enable live validation' diff --git a/tests/Model/UserDefinedFormTest.php b/tests/Model/UserDefinedFormTest.php index a3cccff..7ba426a 100644 --- a/tests/Model/UserDefinedFormTest.php +++ b/tests/Model/UserDefinedFormTest.php @@ -130,7 +130,7 @@ class UserDefinedFormTest extends FunctionalTest $fields = $popup->getCMSFields(); $this->assertThat($fields->dataFieldByName('SendEmailToFieldID'), $this->isInstanceOf(DropdownField::class)); - // if the front end has checkboxs or dropdown they can select from that can also be used to send things + // if the front end has checkboxes or dropdown they can select from that can also be used to send things $dropdown = $this->objFromFixture(EditableDropdown::class, 'department-dropdown'); $form->Fields()->add($dropdown);