class AdminForm in Webform CiviCRM Integration 8.5
@file Webform CiviCRM module's admin form.
Hierarchy
- class \Drupal\webform_civicrm\AdminForm implements AdminFormInterface
Expanded class hierarchy of AdminForm
1 string reference to 'AdminForm'
1 service uses AdminForm
File
- src/
AdminForm.php, line 20 - Webform CiviCRM module's admin form.
Namespace
Drupal\webform_civicrmView source
class AdminForm implements AdminFormInterface {
private $form;
/**
* @var \Drupal\Core\Form\FormStateInterface
*/
private $form_state;
private $node;
private $fields;
private $sets;
private $settings;
private $data;
/**
* The shim allowing us to slowly port this code.
*
* @var \Drupal\webform\WebformInterface
*/
private $webform;
/**
* @var array
*/
public static $fieldset_entities = [
'contact',
'billing_1_number_of_billing',
'activity',
'case',
'grant',
];
/**
* Initialize and set form variables.
* @param array $form
* @param object $form_state
* @param object $webform
*
* @return object
*/
function initialize(array $form, FormStateInterface $form_state, WebformInterface $webform) {
\Drupal::getContainer()
->get('civicrm')
->initialize();
$utils = \Drupal::service('webform_civicrm.utils');
$this->form = $form;
$this->form_state = $form_state;
$this->fields = $utils
->wf_crm_get_fields();
$this->sets = $utils
->wf_crm_get_fields('sets');
$this->settings = $form_state
->getValues();
$this->webform = $webform;
return $this;
}
/**
* Build admin form for civicrm tab of a webform
* @return array
*/
public function buildForm() {
$this->form_state
->set('nid', $this->webform
->id());
$utils = \Drupal::service('webform_civicrm.utils');
// Display confirmation message before deleting fields
if (!empty($this->form_state
->get('msg'))) {
return $this
->buildConfirmationForm();
}
// Add css & js
$this
->addResources();
if (empty($this->form_state
->getValues())) {
$this
->initializeForm();
}
else {
$this
->rebuildForm();
}
// Merge in existing fields
$existing = array_keys($utils
->wf_crm_enabled_fields($this->webform, NULL, TRUE));
$this->settings += array_fill_keys($existing, 'create_civicrm_webform_element');
// Sort fields by set
foreach ($this->fields as $fid => $field) {
if (isset($field['set'])) {
$set = $field['set'];
}
else {
list($set) = explode('_', $fid, 2);
}
$this->sets[$set]['fields'][$fid] = $field;
}
// Build form fields
$this
->buildFormIntro();
foreach ($this->data['contact'] as $n => $c) {
$this
->buildContactTab($n, $c);
}
$this
->buildMessageTabs();
// Component tabs
$this
->buildActivityTab();
if (isset($this->sets['case'])) {
$this
->buildCaseTab();
}
if (isset($this->sets['participant'])) {
$this
->buildParticipantTab();
}
if (isset($this->sets['membership'])) {
$this
->buildMembershipTab();
}
if (isset($this->sets['contribution'])) {
$this
->buildContributionTab();
}
if (isset($this->sets['grant'])) {
$this
->buildGrantTab();
}
$this
->buildOptionsTab();
$this->form['actions']['submit'] = [
'#type' => 'submit',
'#value' => t('Save Settings'),
];
return $this->form;
}
/**
* Initialize form on first view
*/
private function initializeForm() {
$handler_collection = $this->webform
->getHandlers('webform_civicrm');
if ($handler_collection
->count()) {
/** @var \Drupal\webform\Plugin\WebformHandlerInterface $handler */
$handler = $handler_collection
->get('webform_civicrm');
}
else {
$handler_mananger = \Drupal::getContainer()
->get('plugin.manager.webform.handler');
$handler = $handler_mananger
->createInstance('webform_civicrm');
$handler
->setWebform($this->webform);
}
$handler_configuration = $handler
->getConfiguration();
$this->settings = $handler_configuration['settings'];
$this->data =& $this->settings['data'];
}
/**
* On rebuilding the form
*/
private function rebuildForm() {
// The following should mimic this line.
// $this->settings = wf_crm_aval($this->form_state->getStorage(), 'vals', $this->form_state->getValues());
$this->settings = $this->form_state
->get('vals') ?: $this->form_state
->getValues();
$this
->rebuildData();
// Hack for nicer UX: pre-check phone, email, etc when user increments them
if (!empty($_POST['_triggering_element_name'])) {
$defaults = [
'phone' => 'phone',
'email' => 'email',
'website' => 'url',
'im' => 'name',
'address' => [
'street_address',
'city',
'state_province_id',
'postal_code',
],
'billing' => [
'first_name',
'last_name',
'street_address',
'city',
'postal_code',
'state_province_id',
'country_id',
],
];
foreach ($defaults as $ent => $fields) {
if (strpos($_POST['_triggering_element_name'], "_number_of_{$ent}")) {
if ($ent == 'billing') {
foreach ((array) $fields as $field) {
$this->settings["civicrm_1_contribution_1_contribution_{$ent}_address_{$field}"] = 1;
}
continue;
}
list(, $c) = explode('_', $_POST['_triggering_element_name']);
for ($n = 1; $n <= $this->data['contact'][$c]["number_of_{$ent}"]; ++$n) {
foreach ((array) $fields as $field) {
$this->settings["civicrm_{$c}_contact_{$n}_{$ent}_{$field}"] = 1;
}
}
}
}
}
// This replaces: unset($this->form_state['storage']['vals']);
$this->form_state
->set('vals', NULL);
}
/**
* Display confirmation message and buttons before deleting webform components
* @return array
*/
private function buildConfirmationForm() {
$this->form['#prefix'] = $this->form_state
->get('msg');
$this->form['cancel'] = $this->form['disable'] = $this->form['delete'] = [
'#type' => 'submit',
];
$this->form['delete']['#value'] = t('Remove Fields and Save Settings');
$this->form['disable']['#value'] = t('Leave Fields and Save Settings');
// Disable `disable` until it is support.
$this->form['disable']['#disabled'] = TRUE;
$this->form['cancel']['#value'] = t('Cancel (go back)');
return $this->form;
}
/**
* Add necessary css & js
*/
private function addResources() {
$utils = \Drupal::service('webform_civicrm.utils');
$this->form['#attached']['library'][] = 'webform_civicrm/admin';
$this->form['#attached']['drupalSettings']['webform_civicrm'] = [
'rTypes' => $utils
->wf_crm_get_relationship_types(),
];
// Add CiviCRM core css & js, which includes jQuery, jQuery UI + other plugins
\CRM_Core_Resources::singleton()
->addCoreResources();
}
/**
* Build fields for form intro
*/
private function buildFormIntro() {
$has_handler = $this->webform
->getHandlers('webform_civicrm');
$this->form['nid'] = [
'#type' => 'checkbox',
'#title' => t('Enable CiviCRM Processing'),
'#default_value' => $has_handler
->count(),
];
$this
->help($this->form['nid'], 'intro');
$this->form['number_of_contacts'] = [
'#type' => 'select',
'#title' => t('Number of Contacts'),
'#default_value' => count($this->data['contact']),
'#options' => array_combine(range(1, 30), range(1, 30)),
];
$this->form['change_form_settings'] = [
'#type' => 'button',
'#value' => t('Change Form Settings'),
'#prefix' => '<div id="no-js-button-wrapper" class="messages warning">',
'#suffix' => '<div>' . t('You have Javascript disabled. You will need to click this button after changing any option to see the result.') . '</div></div>',
];
$this->form['webform_civicrm'] = [
'#type' => 'vertical_tabs',
];
}
/**
* Build fields for a contact
* @param int $n Contact number
* @param array $c Contact info
*/
private function buildContactTab($n, $c) {
$utils = \Drupal::service('webform_civicrm.utils');
list($contact_types, $sub_types) = $utils
->wf_crm_get_contact_types();
$this->form['contact_' . $n] = [
'#type' => 'details',
'#title' => $n . '. ' . $utils
->wf_crm_contact_label($n, $this->data),
'#description' => $n > 1 ? NULL : t('Primary contact. Usually assumed to be the person filling out the form.') . '<br />' . t('Enable the "Existing Contact" field to autofill with the current user (or another contact).'),
'#group' => 'webform_civicrm',
'#attributes' => [
'class' => [
'contact-icon-' . $c['contact'][1]['contact_type'],
],
],
];
$this->form['contact_' . $n][$n . '_contact_type'] = [
'#type' => 'select',
'#title' => t('Contact Type'),
'#default_value' => $c['contact'][1]['contact_type'],
'#options' => $contact_types,
'#prefix' => '<div class="contact-type-select">',
];
$this->form['contact_' . $n][$n . '_webform_label'] = [
'#type' => 'textfield',
'#title' => t('Label'),
'#default_value' => $utils
->wf_crm_contact_label($n, $this->data, 'plain'),
'#suffix' => '</div>',
];
$this
->help($this->form['contact_' . $n][$n . '_webform_label'], 'webform_label', t('Contact Label'));
$this
->addAjaxItem('contact_' . $n, $n . '_contact_type', 'contact_subtype_wrapper', 'contact-subtype-wrapper');
// Contact sub-type
$fid = 'civicrm_' . $n . '_contact_1_contact_contact_sub_type';
$subTypeIsUserSelect = FALSE;
if (!empty($sub_types[$c['contact'][1]['contact_type']])) {
$field = $this->fields['contact_contact_sub_type'];
$field['name'] = t('Type of @contact', [
'@contact' => $contact_types[$c['contact'][1]['contact_type']],
]);
$this->form['contact_' . $n]['contact_subtype_wrapper'][$fid] = $subTypeField = $this
->addItem($fid, $field);
$subTypeIsUserSelect = in_array('create_civicrm_webform_element', $subTypeField['#default_value']);
$this
->addAjaxItem('contact_' . $n . ':contact_subtype_wrapper', $fid, 'contact_custom_wrapper');
}
else {
$this->form['contact_' . $n]['contact_subtype_wrapper'][$fid] = [
'#type' => 'value',
'#value' => [],
];
}
foreach ($this->sets as $sid => $set) {
if ($set['entity_type'] != 'contact') {
continue;
}
if ($sid == 'relationship' && !($set['max_instances'] = $n - 1)) {
continue;
}
if (!empty($set['contact_type']) && $set['contact_type'] != $c['contact'][1]['contact_type']) {
continue;
}
if (!empty($set['sub_types'])) {
if (!$subTypeIsUserSelect && !array_intersect($c['contact'][1]['contact_sub_type'], array_map('strtolower', $set['sub_types']))) {
continue;
}
$pos =& $this->form['contact_' . $n]['contact_subtype_wrapper']['contact_custom_wrapper'];
$path = 'contact_' . $n . ':contact_subtype_wrapper:contact_custom_wrapper';
}
elseif (!empty($set['contact_type']) || $sid == 'contact') {
$pos =& $this->form['contact_' . $n]['contact_subtype_wrapper'];
$path = 'contact_' . $n . ':contact_subtype_wrapper';
}
else {
$pos =& $this->form['contact_' . $n];
$path = 'contact_' . $n;
}
if (!empty($set['max_instances'])) {
if (!isset($c['number_of_' . $sid])) {
$c['number_of_' . $sid] = 0;
}
$selector = [
'#type' => 'select',
'#default_value' => $c['number_of_' . $sid],
'#prefix' => '<div class="number-of">',
'#suffix' => '</div>',
];
if ($set['max_instances'] > 1) {
$selector['#options'] = range(0, $set['max_instances']);
$selector['#title'] = t('Number of %type Fields', [
'%type' => $set['label'],
]);
}
else {
$selector['#options'] = [
t('No'),
t('Yes'),
];
$selector['#title'] = t('Enable %type Fields', [
'%type' => $set['label'],
]);
}
if (!empty($set['help_text'])) {
$this
->help($selector, "fieldset_{$sid}");
}
$pos['contact_' . $n . '_number_of_' . $sid] = $selector;
$this
->addAjaxItem($path, 'contact_' . $n . '_number_of_' . $sid, $n . $sid . '_wrapper');
}
else {
$c['number_of_' . $sid] = 1;
}
for ($i = 1; $i <= $c['number_of_' . $sid]; ++$i) {
$fsid = 'civicrm_' . $n . $sid . $i . '_fieldset';
$fieldset = [
'#type' => 'fieldset',
'#title' => $set['label'],
'#attributes' => [
'id' => $fsid,
'class' => [
'web-civi-checkbox-set',
],
],
'js_select' => $this
->addToggle($fsid),
];
if ($sid == 'relationship') {
$fieldset['#title'] = t('Relationship to @contact', [
'@contact' => $utils
->wf_crm_contact_label($i, $this->data, 'wrap'),
]);
}
elseif (isset($set['max_instances']) && $set['max_instances'] > 1) {
$fieldset['#title'] .= ' ' . $i;
if (in_array($sid, $utils
->wf_crm_location_fields()) && $i == 1) {
$fieldset['#title'] .= ' ' . t('(primary)');
}
}
else {
$this
->addDynamicCustomSetting($fieldset, $sid, 'contact', $n);
}
if (isset($set['fields'])) {
foreach ($set['fields'] as $fid => $field) {
if ($fid == 'contact_contact_sub_type' || $fid == 'address_master_id' && count($this->data['contact']) == 1 || isset($field['contact_type']) && $field['contact_type'] != $c['contact'][1]['contact_type']) {
continue;
}
$fid = 'civicrm_' . $n . '_contact_' . $i . '_' . $fid;
$fieldset[$fid] = $this
->addItem($fid, $field);
}
}
// Add 'Create mode' select field to multiple custom group fieldset.
if (substr($sid, 0, 2) == 'cg' && wf_crm_aval($set, 'max_instances') > 1) {
$createModeKey = 'civicrm_' . $n . '_contact_' . $i . '_' . $sid . '_createmode';
$createModeValue = isset($this->settings['data']['config']['create_mode'][$createModeKey]) ? $this->settings['data']['config']['create_mode'][$createModeKey] : NULL;
$multivalueFieldsetCreateMode = [
'#type' => 'select',
'#default_value' => $createModeValue,
'#prefix' => '<div class="multivalue-fieldset-create-mode">',
'#suffix' => '</div>',
'#options' => [
WebformCivicrmBase::MULTIVALUE_FIELDSET_MODE_CREATE_OR_EDIT => t('Create/ Edit'),
WebformCivicrmBase::MULTIVALUE_FIELDSET_MODE_CREATE_ONLY => t('Create Only'),
],
'#title' => t('Create mode'),
'#weight' => -1,
];
$this
->help($multivalueFieldsetCreateMode, 'multivalue_fieldset_create_mode');
$fieldset[$createModeKey] = $multivalueFieldsetCreateMode;
}
if (isset($set['max_instances'])) {
$pos[$n . $sid . '_wrapper'][$n . $sid . $i . '_fieldset'] = $fieldset;
}
else {
$pos[$n . $sid . $i . '_fieldset'] = $fieldset;
}
}
if ($sid == 'contact') {
// Matching rule
$rule_field = $this->form['contact_' . $n]['contact_subtype_wrapper']["contact_{$n}_settings_matching_rule"] = [
'#type' => 'select',
'#options' => [
0 => t('- None -'),
'Unsupervised' => t('Default Unsupervised'),
'Supervised' => t('Default Supervised'),
] + $utils
->wf_crm_get_matching_rules($c['contact'][1]['contact_type']),
'#title' => t('Matching Rule'),
'#prefix' => '<div class="number-of">',
'#suffix' => '</div>',
'#default_value' => wf_crm_aval($this->data['contact'][$n], 'matching_rule', 'Unsupervised', TRUE),
];
$rule_field =& $this->form['contact_' . $n]['contact_subtype_wrapper']["contact_{$n}_settings_matching_rule"];
// Reset to default if selected rule doesn't exist or isn't valid for this contact type
if (!array_key_exists($rule_field['#default_value'], $rule_field['#options'])) {
$rule_field['#default_value'] = $this->form_state['input']["contact_{$n}_settings_matching_rule"] = 'Unsupervised';
}
$this
->help($rule_field, 'matching_rule');
}
}
}
/**
* Configure messages
*/
private function buildMessageTabs() {
$utils = \Drupal::service('webform_civicrm.utils');
$tokens = '<strong>' . t('Tokens for :contact', [
':contact' => $utils
->wf_crm_contact_label(1, $this->data, TRUE),
]) . ':</strong> [' . implode('], [', $utils
->wf_crm_get_fields('tokens')) . '].';
$this->form['prefix'] = [
'#type' => 'details',
'#title' => t('Introduction Text'),
'#description' => t('This text will appear at the top of the form. You may configure separate messages for known contacts (logged in users, or users following a hashed link from civimail) and unknown (anonymous) users.'),
'#group' => 'webform_civicrm',
'#attributes' => [
'class' => [
'civi-icon-text',
],
],
];
$this->form['prefix']['prefix_known'] = [
'#type' => 'textarea',
'#title' => t('Introduction text for known contacts'),
'#default_value' => wf_crm_aval($this->settings, 'prefix_known'),
'#description' => $tokens,
];
$this->form['prefix']['prefix_unknown'] = [
'#type' => 'textarea',
'#title' => t('Introduction text for unknown contacts'),
'#default_value' => wf_crm_aval($this->settings, 'prefix_unknown'),
'#description' => t('No tokens available for unknown contacts.'),
];
$this->form['st_message'] = [
'#type' => 'details',
'#title' => t('"Not You?" Message'),
'#description' => t('Prompt for users who are logged in as, or following a hashed link for, someone else.'),
'#group' => 'webform_civicrm',
'#attributes' => [
'class' => [
'civi-icon-message',
],
],
];
$this->form['st_message']['toggle_message'] = [
'#type' => 'checkbox',
'#title' => t('Display message to known contacts?'),
'#default_value' => !empty($this->settings['message']),
];
$this->form['st_message']['message'] = [
'#type' => 'textfield',
'#title' => t('Text (displayed as a status message)'),
'#default_value' => wf_crm_aval($this->settings, 'message', t("You are viewing this form as [display name]. Please {click here if that's not you}.")),
'#size' => 100,
'#maxlength' => 255,
'#attributes' => [
'style' => 'max-width: 100%;',
],
'#description' => t('Enclose your "not you" link text in curly brackets {like this}.') . '<p>' . $tokens . '</p>',
];
}
/**
* Activity settings
*/
private function buildActivityTab() {
$utils = \Drupal::service('webform_civicrm.utils');
$this->form['activityTab'] = [
'#type' => 'details',
'#title' => t('Activities'),
'#group' => 'webform_civicrm',
'#attributes' => [
'class' => [
'civi-icon-activity',
],
],
];
$num_acts = wf_crm_aval($this->data, "activity:number_of_activity", 0);
$this->form['activityTab']["activity_number_of_activity"] = [
'#type' => 'select',
'#title' => t('Number of Activities'),
'#default_value' => $num_acts,
'#options' => range(0, $this->sets['activity']['max_instances']),
'#prefix' => '<div class="number-of">',
'#suffix' => '</div>',
];
$this
->addAjaxItem("activityTab", "activity_number_of_activity", "activity");
for ($n = 1; $n <= $num_acts; ++$n) {
$num = "activity_activity_{$n}_fieldset";
$this->form['activityTab']['activity'][$num] = [
'#type' => 'fieldset',
'#attributes' => [
'class' => [
'activity-wrapper',
],
],
'#title' => t('Activity :num', [
':num' => $n,
]),
];
$this->form['activityTab']['activity'][$num]["activity_{$n}_settings_existing_activity_status"] = [
'#type' => 'select',
'#title' => t('Update Existing Activity'),
'#options' => [
'' => '- ' . t('None') . ' -',
] + $utils
->wf_crm_apivalues('activity', 'getoptions', [
'field' => 'status_id',
]),
'#default_value' => wf_crm_aval($this->data, "activity:{$n}:existing_activity_status", []),
'#multiple' => TRUE,
'#prefix' => '<div class="float-item">',
'#suffix' => '</div>',
];
$this
->help($this->form['activityTab']['activity'][$num]["activity_{$n}_settings_existing_activity_status"], 'existing_activity_status');
$this->form['activityTab']['activity'][$num]["activity_{$n}_settings_details"] = [
'#type' => 'checkboxes',
'#options' => [
'entire_result' => t('Include <em>entire</em> webform submission in activity details'),
'view_link' => t('Include link to <em>view</em> webform submission in activity details'),
'edit_link' => t('Include link to <em>edit</em> webform submission in activity details'),
'update_existing' => t('Update the details when an existing activity is updated'),
],
'#default_value' => wf_crm_aval($this->data, "activity:{$n}:details", [
'view_link',
], TRUE),
];
$this->form['activityTab']['activity'][$num]['wrap'] = [];
$wrap =& $this->form['activityTab']['activity'][$num]['wrap'];
if (isset($this->sets['case'])) {
$case_types = $utils
->wf_crm_apivalues('case', 'getoptions', [
'field' => 'case_type_id',
]);
if ($case_types) {
$wrap['case']["activity_{$n}_settings_case_type_id"] = [
'#type' => 'select',
'#title' => t('File On Case'),
'#options' => [
t('- None -'),
] + $case_types,
'#default_value' => $case_type = wf_crm_aval($this->data, "activity:{$n}:case_type_id"),
];
// Allow selection of webform cases
$num_case = wf_crm_aval($this->data, "case:number_of_case", 0);
if ($num_case) {
$webform_cases = [];
for ($i = 1; $i <= $num_case; ++$i) {
$webform_cases["#{$i}"] = t('Case :num', [
':num' => $i,
]);
}
$wrap['case']["activity_{$n}_settings_case_type_id"]['#options'] = [
t('- None -'),
'This Webform' => $webform_cases,
'Find by Case Type' => $case_types,
];
}
$this
->help($wrap['case']["activity_{$n}_settings_case_type_id"], 'file_on_case');
$this
->addAjaxItem("activityTab:activity:{$num}:wrap:case", "activity_{$n}_settings_case_type_id", '..:..:wrap');
if ($case_type && $case_type[0] !== '#') {
$wrap['case']['#type'] = 'fieldset';
$wrap['case']['#attributes'] = [
'class' => [
'web-civi-checkbox-set',
],
];
$wrap['case']['#title'] = t('File On Case');
$wrap['case']['#description'] = t('File on existing case matching the following criteria:');
$this
->help($wrap['case'], 'file_on_case');
$wrap['case']["activity_{$n}_settings_case_type_id"]['#title'] = t('Case Type');
$status_options = $utils
->wf_crm_apivalues('case', 'getoptions', [
'field' => 'status_id',
]);
$wrap['case']["activity_{$n}_settings_case_status_id"] = [
'#type' => 'select',
'#title' => t('Case Status'),
'#options' => $status_options,
'#multiple' => TRUE,
'#attributes' => [
'class' => [
'required',
],
],
'#default_value' => wf_crm_aval($this->data, "activity:{$n}:case_status_id", array_keys($status_options)),
];
$wrap['case']["activity_{$n}_settings_case_contact_id"] = [
'#type' => 'select',
'#title' => t('Case Client'),
'#attributes' => [
'data-type' => 'ContactReference',
],
'#options' => $this
->contactRefOptions(),
'#default_value' => wf_crm_aval($this->data, "activity:{$n}:case_contact_id"),
];
}
}
}
$wrap[$num . '_fields'] = [
'#type' => 'fieldset',
'#title' => t('Activity'),
'#attributes' => [
'id' => $num . '_fields',
'class' => [
'web-civi-checkbox-set',
],
],
'js_select' => $this
->addToggle($num . '_fields'),
];
foreach ($this->sets['activity']['fields'] as $fid => $field) {
if ($fid != 'activity_survey_id') {
$fid = "civicrm_{$n}_activity_1_{$fid}";
$wrap[$num . '_fields'][$fid] = $this
->addItem($fid, $field);
}
}
$type = $wrap[$num . '_fields']["civicrm_{$n}_activity_1_activity_activity_type_id"]['#default_value'];
$type = $type == 'create_civicrm_webform_element' ? 0 : $type;
$this
->addAjaxItem("activityTab:activity:{$num}:wrap:{$num}_fields", "civicrm_{$n}_activity_1_activity_activity_type_id", "..:custom");
// Add ajax survey type field
if (isset($this->fields['activity_survey_id'])) {
$this
->addAjaxItem("activityTab:activity:{$num}:wrap:{$num}_fields", "civicrm_{$n}_activity_1_activity_campaign_id", "..:custom");
if ($type && array_key_exists($type, $utils
->wf_crm_get_campaign_activity_types())) {
$this->sets['activity_survey'] = [
'entity_type' => 'activity',
'label' => $wrap[$num . '_fields']["civicrm_{$n}_activity_1_activity_activity_type_id"]['#options'][$type],
'fields' => [
'activity_survey_id' => $this->fields['activity_survey_id'],
],
];
}
}
// Add custom field sets appropriate to this activity type
foreach ($this->sets as $sid => $set) {
if ($set['entity_type'] == 'activity' && $sid != 'activity' && (!$type || empty($set['sub_types']) || in_array($type, $set['sub_types']))) {
$fs1 = "activity_activity_{$n}_fieldset_{$sid}";
$wrap['custom'][$fs1] = [
'#type' => 'fieldset',
'#title' => $set['label'],
'#attributes' => [
'id' => $fs1,
'class' => [
'web-civi-checkbox-set',
],
],
'js_select' => $this
->addToggle($fs1),
];
$this
->addDynamicCustomSetting($wrap['custom'][$fs1], $sid, 'activity', $n);
if (isset($set['fields'])) {
foreach ($set['fields'] as $fid => $field) {
$fid = "civicrm_{$n}_activity_1_{$fid}";
$wrap['custom'][$fs1][$fid] = $this
->addItem($fid, $field);
}
}
}
}
}
}
/**
* @param $fieldset
* @param $set
* @param $ent
* @param $n
*/
private function addDynamicCustomSetting(&$fieldset, $set, $ent, $n) {
if (strpos($set, 'cg') === 0) {
$fieldset["{$ent}_{$n}_settings_dynamic_custom_{$set}"] = [
'#type' => 'checkbox',
'#title' => t('Add dynamically'),
'#default_value' => wf_crm_aval($this->data, "{$ent}:{$n}:dynamic_custom_{$set}"),
'#weight' => -1,
'#prefix' => '<div class="dynamic-custom-checkbox">',
'#suffix' => '</div>',
];
$this
->help($fieldset["{$ent}_{$n}_settings_dynamic_custom_{$set}"], 'dynamic_custom');
}
}
/**
* Case settings
* FIXME: This is exactly the same code as buildGrantTab. More utilities and less boilerplate needed.
*/
private function buildCaseTab() {
$utils = \Drupal::service('webform_civicrm.utils');
$types = $utils
->wf_crm_apivalues('case', 'getoptions', [
'field' => 'case_type_id',
]);
if (!$types) {
return;
}
$this->form['caseTab'] = [
'#type' => 'details',
'#title' => t('Cases'),
'#group' => 'webform_civicrm',
'#attributes' => [
'class' => [
'civi-icon-case',
],
],
];
$this->form['caseTab']["case_number_of_case"] = [
'#type' => 'select',
'#title' => t('Number of Cases'),
'#default_value' => $num = wf_crm_aval($this->data, "case:number_of_case", 0),
'#options' => range(0, $this->sets['case']['max_instances']),
'#prefix' => '<div class="number-of">',
'#suffix' => '</div>',
];
$this
->addAjaxItem("caseTab", "case_number_of_case", "case");
for ($n = 1; $n <= $num; ++$n) {
$fs = "case_case_{$n}_fieldset";
$this->form['caseTab']['case'][$fs] = [
'#type' => 'fieldset',
'#title' => t('Case :num', [
':num' => $n,
]),
'wrap' => [
'#weight' => 9,
],
];
$this->form['caseTab']['case'][$fs]["case_{$n}_settings_existing_case_status"] = [
'#type' => 'select',
'#title' => t('Update Existing Case'),
'#options' => [
'' => '- ' . t('None') . ' -',
] + $utils
->wf_crm_apivalues('case', 'getoptions', [
'field' => 'status_id',
]),
'#default_value' => wf_crm_aval($this->data, "case:{$n}:existing_case_status", []),
'#multiple' => TRUE,
];
$this
->help($this->form['caseTab']['case'][$fs]["case_{$n}_settings_existing_case_status"], 'existing_case_status');
$this->form['caseTab']['case'][$fs]["case_{$n}_settings_duplicate_case"] = [
'#type' => 'checkbox',
'#title' => t('Create new case based on existing case'),
'#default_value' => wf_crm_aval($this->data, "case:{$n}:duplicate_case", 0),
];
$this
->help($this->form['caseTab']['case'][$fs]["case_{$n}_settings_duplicate_case"], 'duplicate_case_status');
$case_type = wf_crm_aval($this->data, "case:{$n}:case:1:case_type_id");
foreach ($this
->filterCaseSets($case_type) as $sid => $set) {
$fs1 = "case_case_{$n}_fieldset_{$sid}";
if ($sid == 'case') {
$pos =& $this->form['caseTab']['case'][$fs];
}
else {
$pos =& $this->form['caseTab']['case'][$fs]['wrap'];
}
$pos[$fs1] = [
'#type' => 'fieldset',
'#title' => $set['label'],
'#attributes' => [
'id' => $fs1,
'class' => [
'web-civi-checkbox-set',
],
],
'js_select' => $this
->addToggle($fs1),
];
$this
->addDynamicCustomSetting($pos[$fs1], $sid, 'case', $n);
if (isset($set['fields'])) {
foreach ($set['fields'] as $fid => $field) {
$fid = "civicrm_{$n}_case_1_{$fid}";
if (!$case_type || empty($field['case_types']) || in_array($case_type, $field['case_types'])) {
$pos[$fs1][$fid] = $this
->addItem($fid, $field);
}
}
}
}
$this
->addAjaxItem("caseTab:case:{$fs}:case_case_{$n}_fieldset_case", "civicrm_{$n}_case_1_case_case_type_id", "..:wrap");
}
}
/**
* Adjust case role fields to match creator/manager settings for a given case type
*
* @param int|null $case_type
* @return array
*/
private function filterCaseSets($case_type) {
$utils = \Drupal::service('webform_civicrm.utils');
$case_sets = [];
foreach ($this->sets as $sid => $set) {
if ($set['entity_type'] == 'case' && (!$case_type || empty($set['sub_types']) || in_array($case_type, $set['sub_types']))) {
if ($sid == 'caseRoles') {
// Lookup case-role names
$creator = $manager = NULL;
$case_types = $utils
->wf_crm_apivalues('case_type', 'get', [
'id' => $case_type,
]);
foreach ($case_types as $type) {
foreach ($type['definition']['caseRoles'] as $role) {
if (!empty($role['creator'])) {
$creator = $creator == $role['name'] || $creator === NULL ? $role['name'] : FALSE;
}
if (!empty($role['manager'])) {
$manager = $manager == $role['name'] || $manager === NULL ? $role['name'] : FALSE;
}
}
}
if ($creator) {
$rel_type = $utils
->wf_civicrm_api('relationshipType', 'getsingle', [
'name_b_a' => $creator,
]);
$label = $creator == $manager ? ts('Case # Creator/Manager') : ts('Case # Creator');
$set['fields']['case_creator_id']['name'] = $rel_type['label_b_a'] . ' (' . $label . ')';
unset($set['fields']['case_role_' . $rel_type['id']]);
}
if ($manager && $manager != $creator) {
$rel_type = $utils
->wf_civicrm_api('relationshipType', 'getsingle', [
'name_b_a' => $manager,
]);
$set['fields']['case_role_' . $rel_type['id']]['name'] .= ' (' . ts('Case # Manager') . ')';
}
}
$case_sets[$sid] = $set;
}
}
return $case_sets;
}
/**
* Event participant settings
*/
private function buildParticipantTab() {
$utils = \Drupal::service('webform_civicrm.utils');
$this->form['participant'] = [
'#type' => 'details',
'#title' => t('Event Registration'),
'#group' => 'webform_civicrm',
'#attributes' => [
'class' => [
'civi-icon-participant',
],
],
];
$reg_type = wf_crm_aval($this->data, 'participant_reg_type');
$this->form['participant']['participant_reg_type'] = [
'#type' => 'select',
'#title' => t('Registration Method'),
'#default_value' => $reg_type,
'#options' => [
t('- None -'),
'all' => t('Register all contacts for the same event(s)'),
'separate' => t('Register each contact separately'),
],
];
$this
->help($this->form['participant']['participant_reg_type'], 'participant_reg_type');
$this->form['participant']['event_type'] = [
'#type' => 'select',
'#title' => t('Show Events of Type(s)'),
'#options' => [
'any' => t('- Any Type -'),
] + $utils
->wf_crm_apivalues('event', 'getoptions', [
'field' => 'event_type_id',
]),
'#default_value' => wf_crm_aval($this->data, 'reg_options:event_type', 'any'),
'#prefix' => '<div id="event-reg-options-wrapper"><div class="web-civi-checkbox-set">',
'#parents' => [
'reg_options',
'event_type',
],
'#tree' => TRUE,
'#multiple' => TRUE,
];
$this->form['participant']['show_past_events'] = [
'#type' => 'select',
'#title' => t('Show Past Events'),
'#default_value' => wf_crm_aval($this->data, 'reg_options:show_past_events', 'now'),
'#parents' => [
'reg_options',
'show_past_events',
],
'#tree' => TRUE,
'#options' => [
'now' => t('- None -'),
1 => t('All'),
'-1 day' => t('Past Day'),
'-1 week' => t('Past Week'),
'-1 month' => t('Past Month'),
'-2 month' => t('Past 2 Months'),
'-3 month' => t('Past 3 Months'),
'-6 month' => t('Past 6 Months'),
'-1 year' => t('Past Year'),
'-2 year' => t('Past 2 Years'),
],
];
$this
->help($this->form['participant']['show_past_events'], 'reg_options_show_past_events');
$this->form['participant']['show_future_events'] = [
'#type' => 'select',
'#title' => t('Show Future Events'),
'#default_value' => wf_crm_aval($this->data, 'reg_options:show_future_events', 1),
'#parents' => [
'reg_options',
'show_future_events',
],
'#tree' => TRUE,
'#options' => [
'now' => t('- None -'),
1 => t('All'),
'+1 day' => t('Next Day'),
'+1 week' => t('Next Week'),
'+1 month' => t('Next Month'),
'+2 month' => t('Next 2 Months'),
'+3 month' => t('Next 3 Months'),
'+6 month' => t('Next 6 Months'),
'+1 year' => t('Next Year'),
'+2 year' => t('Next 2 Years'),
],
];
$this
->help($this->form['participant']['show_future_events'], 'reg_options_show_future_events');
$this->form['participant']['show_public_events'] = [
'#type' => 'select',
'#title' => t('Show Public Events'),
'#default_value' => wf_crm_aval($this->data, 'reg_options:show_public_events', 'title'),
// This is breaking HTML in D8.
// '#suffix' => '</div>',
'#parents' => [
'reg_options',
'show_public_events',
],
'#tree' => TRUE,
'#options' => [
'all' => t('Public and Private'),
'1' => t('Public'),
'0' => t('Private'),
],
];
$this
->help($this->form['participant']['show_public_events'], 'reg_options_show_public_events');
$this->form['participant']['title_display'] = [
'#type' => 'select',
'#title' => t('Title Display'),
'#default_value' => wf_crm_aval($this->data, 'reg_options:title_display', 'title'),
'#suffix' => '</div>',
'#parents' => [
'reg_options',
'title_display',
],
'#tree' => TRUE,
'#options' => [
'title' => t('Title Only'),
'title type' => t('Title + Event Type'),
'title start dateformatYear' => t('Title + Year'),
'title start dateformatPartial' => t('Title + Month + Year'),
'title start dateformatFull' => t('Title + Start-Date'),
'title start dateformatTime' => t('Title + Start-Time'),
'title start dateformatDatetime' => t('Title + Start-Date-Time'),
'title start end dateformatFull' => t('Title + Start-Date + End'),
'title start end dateformatTime' => t('Title + Start-Time + End'),
'title start end dateformatDatetime' => t('Title + Start-Date-Time + End'),
],
];
$this
->help($this->form['participant']['title_display'], 'reg_options_title_display');
$this->form['participant']['reg_options'] = [
'#prefix' => '<div class="clearfix"> </div>',
'#suffix' => '</div>',
'#type' => 'fieldset',
'#title' => t('Registration Options'),
'#collapsible' => TRUE,
'#collapsed' => isset($this->data['participant']),
'#tree' => TRUE,
];
$field = [
'#type' => 'select',
'#title' => t('Show Remaining Space in Events'),
'#default_value' => wf_crm_aval($this->data, 'reg_options:show_remaining', 0),
'#options' => [
t('Never'),
'always' => t('Always'),
'0_full' => t('When full - 0 spaces left'),
],
];
$this
->help($field, 'reg_options_show_remaining');
foreach ([
5,
10,
20,
50,
100,
200,
500,
1000,
] as $num) {
$field['#options'][$num] = t('When under :num spaces left', [
':num' => $num,
]);
}
$this->form['participant']['reg_options']['show_remaining'] = $field;
$this->form['participant']['reg_options']['validate'] = [
'#type' => 'checkbox',
'#title' => t('Prevent Registration for Past/Full Events'),
'#default_value' => (bool) wf_crm_aval($this->data, 'reg_options:validate'),
];
$this
->help($this->form['participant']['reg_options']['validate'], 'reg_options_validate');
$this->form['participant']['reg_options']['block_form'] = [
'#type' => 'checkbox',
'#title' => t('Block Form Access when Event(s) are Full/Ended'),
'#default_value' => (bool) wf_crm_aval($this->data, 'reg_options:block_form'),
];
$this->form['participant']['reg_options']['disable_unregister'] = [
'#type' => 'checkbox',
'#title' => t('Disable unregistering participants from unselected events.'),
'#default_value' => (bool) wf_crm_aval($this->data, 'reg_options:disable_unregister'),
];
$this->form['participant']['reg_options']['allow_url_load'] = [
'#type' => 'checkbox',
'#title' => t('Allow events to be autoloaded from URL'),
'#default_value' => (bool) wf_crm_aval($this->data, 'reg_options:allow_url_load'),
];
$this
->help($this->form['participant']['reg_options']['block_form'], 'reg_options_block_form');
$this
->help($this->form['participant']['reg_options']['disable_unregister'], 'reg_options_disable_unregister');
$this
->help($this->form['participant']['reg_options']['allow_url_load'], 'reg_options_allow_url_load');
$this
->addAjaxItem('participant', 'participant_reg_type', 'participants');
$this
->addAjaxItem('participant', 'event_type', 'participants');
$this
->addAjaxItem('participant', 'show_past_events', 'participants');
$this
->addAjaxItem('participant', 'show_future_events', 'participants');
$this
->addAjaxItem('participant', 'show_public_events', 'participants');
$this
->addAjaxItem('participant', 'title_display', 'participants');
for ($n = 1; $reg_type && ($n <= count($this->data['contact']) && $reg_type != 'all' || $n == 1); ++$n) {
$this->form['participant']['participants'][$n] = [
'#type' => 'fieldset',
'#title' => $reg_type == 'all' ? t('Registration') : $utils
->wf_crm_contact_label($n, $this->data, 'wrap'),
];
$num = wf_crm_aval($this->data, "participant:{$n}:number_of_participant");
if (!$num || $n > 1 && $reg_type == 'all') {
$num = 0;
}
$this->form['participant']['participants'][$n]['participant_' . $n . '_number_of_participant'] = [
'#type' => 'select',
'#title' => $reg_type == 'all' ? t('Number of Event Sets') : t('Number of Event Sets for @contact', [
'@contact' => $utils
->wf_crm_contact_label($n, $this->data, 'wrap'),
]),
'#default_value' => $num,
'#options' => range(0, $this->sets['participant']['max_instances']),
'#prefix' => '<div class="number-of">',
'#suffix' => '</div>',
];
$this
->addAjaxItem("participant:participants:{$n}", 'participant_' . $n . '_number_of_participant', 'div');
$particpant_extensions = [
1 => 'role_id',
2 => 'event_id',
3 => 'event_type',
];
for ($e = 1; $e <= $num; ++$e) {
$fs = "participant_{$n}_event_{$e}_fieldset";
$this->form['participant']['participants'][$n]['div'][$fs] = [
'#type' => 'fieldset',
'#title' => t('Event :num', [
':num' => $e,
]),
'#attributes' => [
'id' => $fs,
],
];
foreach ($this->sets as $sid => $set) {
if ($set['entity_type'] == 'participant') {
$sid = 'civicrm_' . $n . '_participant_' . $e . '_' . $sid . '_fieldset';
$class = 'web-civi-checkbox-set';
if (!empty($set['sub_types'])) {
$role_id = wf_crm_aval($this->data, "participant:{$n}:particpant:{$e}:role_id", '');
$event_id = wf_crm_aval($this->data, "participant:{$n}:particpant:{$e}:event_id", '');
$event_type = wf_crm_aval($this->data, 'reg_options:event_type', '');
if ($event_id && $event_id !== 'create_civicrm_webform_element') {
list($event_id, $event_type) = explode('-', $event_id);
}
$ext = $particpant_extensions[$set['extension_of']];
if (!in_array(${$ext}, $set['sub_types'])) {
$class .= ' hidden';
}
$class .= ' extends-condition ' . str_replace('_', '', $ext) . '-' . implode('-', $set['sub_types']);
}
$this->form['participant']['participants'][$n]['div'][$fs][$sid] = [
'#type' => 'fieldset',
'#title' => $set['label'],
'#attributes' => [
'id' => $sid,
'class' => [
$class,
],
],
'js_select' => $this
->addToggle($sid),
];
foreach ($set['fields'] as $fid => $field) {
$id = 'civicrm_' . $n . '_participant_' . $e . '_' . $fid;
$item = $this
->addItem($id, $field);
if ($fid == 'participant_event_id') {
$item['#prefix'] = '<div class="auto-width">';
$item['#suffix'] = '</div>';
}
if ($fid == 'participant_event_id' || $fid == 'participant_role_id') {
$item['#attributes']['onchange'] = "wfCiviAdmin.participantConditional('#{$fs}');";
$item['#attributes']['class'][] = $fid;
${$fid} = wf_crm_aval($item, '#default_value');
}
$this->form['participant']['participants'][$n]['div'][$fs][$sid][$id] = $item;
}
}
}
}
}
}
/**
* Membership settings
*/
private function buildMembershipTab() {
$utils = \Drupal::service('webform_civicrm.utils');
$this->form['membership'] = [
'#type' => 'details',
'#title' => t('Memberships'),
'#group' => 'webform_civicrm',
'#attributes' => [
'class' => [
'civi-icon-membership',
],
],
];
for ($c = 1, $cMax = count($this->data['contact']); $c <= $cMax; ++$c) {
$num = wf_crm_aval($this->data, "membership:{$c}:number_of_membership", 0);
$this->form['membership'][$c]["membership_{$c}_number_of_membership"] = [
'#type' => 'select',
'#title' => t('Number of Memberships for @contact', [
'@contact' => $utils
->wf_crm_contact_label($c, $this->data, 'wrap'),
]),
'#default_value' => $num,
'#options' => range(0, 9),
'#prefix' => '<div class="number-of">',
'#suffix' => '</div>',
];
$this
->addAjaxItem("membership:{$c}", "membership_{$c}_number_of_membership", "membership");
for ($n = 1; $n <= $num; ++$n) {
$fs = "membership_{$c}_membership_{$n}_fieldset";
$this->form['membership'][$c]['membership'][$fs] = [
'#type' => 'fieldset',
'#title' => t('Membership :num for :contact', [
':num' => $n,
':contact' => $utils
->wf_crm_contact_label($c, $this->data, 'wrap'),
]),
'#attributes' => [
'id' => $fs,
'class' => [
'web-civi-checkbox-set',
],
],
'js_select' => $this
->addToggle($fs),
];
foreach ($this->sets as $sid => $set) {
if ($set['entity_type'] == 'membership') {
foreach ($set['fields'] as $fid => $field) {
$fid = "civicrm_{$c}_membership_{$n}_{$fid}";
$this->form['membership'][$c]['membership'][$fs][$fid] = $this
->addItem($fid, $field);
}
}
}
}
}
}
/**
* Contribution settings
*/
private function buildContributionTab() {
$utils = \Drupal::service('webform_civicrm.utils');
$this->form['contribution'] = [
'#type' => 'details',
'#title' => t('Contribution'),
'#group' => 'webform_civicrm',
'#description' => t('In order to process live transactions for events, memberships, or contributions, select a contribution page and its billing fields will be included on the webform.'),
'#attributes' => [
'class' => [
'civi-icon-contribution',
],
],
];
$fid = 'civicrm_1_contribution_1_contribution_enable_contribution';
$enable_contribution = wf_crm_aval($this->data, 'contribution:1:contribution:1:enable_contribution');
unset($this->sets['contribution']['fields']['contribution_enable_contribution']);
$this->form['contribution'][$fid] = [
'#type' => 'select',
'#title' => t('Enable Contribution?'),
'#default_value' => $enable_contribution,
'#options' => [
t('No'),
t('Yes'),
],
'#description' => t('Enable this section to submit a payment for the contact.'),
];
$this
->addAjaxItem('contribution', $fid, 'sets');
$contribution = wf_crm_aval($this->data, 'contribution:1:contribution:1:enable_contribution');
if (!$contribution) {
return;
}
// Make sure webform is set-up to prevent credit card abuse.
$this
->checkSubmissionLimit();
$financialType = wf_crm_aval($this->data, 'contribution:1:contribution:1:financial_type_id');
// Add contribution fields
foreach ($this->sets as $sid => $set) {
if ($set['entity_type'] == 'contribution' && (empty($set['sub_types']) || in_array($financialType, $set['sub_types']))) {
//Build custom fields as per financial type selected.
if (strpos($sid, 'cg') === 0) {
$this->form['contribution']['sets']['custom'][$sid] = [
'#type' => 'fieldset',
'#title' => $set['label'],
'#attributes' => [
'id' => $sid,
'class' => [
'web-civi-checkbox-set',
],
],
'js_select' => $this
->addToggle($sid),
];
$this
->addDynamicCustomSetting($this->form['contribution']['sets']['custom'][$sid], $sid, 'contribution', 1);
}
else {
$this->form['contribution']['sets'][$sid] = [
'#type' => 'fieldset',
'#title' => $set['label'],
'#attributes' => [
'id' => $sid,
'class' => [
'web-civi-checkbox-set',
],
],
'js_select' => $this
->addToggle($sid),
];
}
if (isset($set['fields'])) {
foreach ($set['fields'] as $fid => $field) {
$fid = "civicrm_1_contribution_1_{$fid}";
if (strpos($sid, 'cg') === 0) {
$this->form['contribution']['sets']['custom'][$sid][$fid] = $this
->addItem($fid, $field);
}
else {
$this->form['contribution']['sets'][$sid][$fid] = $this
->addItem($fid, $field);
}
}
}
}
}
//Add financial type config.
$ft_options = (array) $utils
->wf_crm_apivalues('Contribution', 'getoptions', [
'field' => "financial_type_id",
]);
$this->form['contribution']['sets']['contribution']['civicrm_1_contribution_1_contribution_financial_type_id'] = [
'#type' => 'select',
'#title' => t('Financial Type'),
'#default_value' => $financialType,
'#options' => $ft_options,
'#required' => TRUE,
];
$this
->addAjaxItem("contribution:sets:contribution", "civicrm_1_contribution_1_contribution_financial_type_id", "..:custom");
//Add Currency.
$this->form['contribution']['sets']['contribution']['contribution_1_settings_currency'] = [
'#type' => 'select',
'#title' => t('Currency'),
'#default_value' => wf_crm_aval($this->data, "contribution:1:currency"),
'#options' => \CRM_Core_OptionGroup::values('currencies_enabled'),
'#required' => TRUE,
];
// Billing Address
$n = wf_crm_aval($this->data, "billing:number_number_of_billing");
$this->form['contribution']['sets']["billing_1_number_of_billing"] = [
'#type' => 'select',
'#title' => t('Enable Billing Address?'),
'#default_value' => $n,
'#options' => [
t('No'),
t('Yes'),
],
'#prefix' => '<div class="number-of">',
'#suffix' => '</div>',
'#description' => t('Enable this section if you want billing address to be sent to the payment processor.'),
];
$this
->addAjaxItem("contribution:sets", "billing_1_number_of_billing", "billing");
//Move custom key after billing section.
$customFields = $this->form['contribution']['sets']['custom'];
unset($this->form['contribution']['sets']['custom']);
$this->form['contribution']['sets']['custom'] = $customFields;
if ($n) {
// Add contribution fields
foreach ($this->sets as $sid => $set) {
if ($sid == 'billing_1_number_of_billing') {
$fs = "contribution_sets_billing_{$n}_fieldset";
$this->form['contribution']['sets']['billing'][$fs] = [
'#type' => 'fieldset',
'#title' => t('Billing Address'),
'#attributes' => [
'id' => $fs,
'class' => [
'web-civi-checkbox-set',
],
],
'js_select' => $this
->addToggle($fs),
];
if (isset($set['fields'])) {
foreach ($set['fields'] as $fid => $field) {
$fid = "civicrm_1_contribution_1_{$fid}";
$this->form['contribution']['sets']['billing'][$fs][$fid] = $this
->addItem($fid, $field);
}
}
}
}
}
// LineItem
$num = wf_crm_aval($this->data, "lineitem:number_number_of_lineitem", 0);
$this->form['contribution']['sets']["lineitem_1_number_of_lineitem"] = [
'#type' => 'select',
'#title' => t('Additional Line items'),
'#default_value' => $num,
'#options' => range(0, 9),
'#prefix' => '<div class="number-of">',
'#suffix' => '</div>',
];
$this
->addAjaxItem("contribution:sets", "lineitem_1_number_of_lineitem", "lineitem");
for ($n = 1; $n <= $num; ++$n) {
$fs = "contribution_sets_lineitem_{$n}_fieldset";
$this->form['contribution']['sets']['lineitem'][$fs] = [
'#type' => 'fieldset',
'#title' => t('Line item %num', [
'%num' => $n,
]),
'#attributes' => [
'id' => $fs,
'class' => [
'web-civi-checkbox-set',
],
],
'js_select' => $this
->addToggle($fs),
];
foreach ($this->sets['line_items']['fields'] as $fid => $field) {
$fid = "civicrm_1_lineitem_{$n}_{$fid}";
$this->form['contribution']['sets']['lineitem'][$fs][$fid] = $this
->addItem($fid, $field);
}
}
// Receipt
$n = wf_crm_aval($this->data, "receipt:number_number_of_receipt", 0);
$this->form['contribution']['sets']["receipt_1_number_of_receipt"] = [
'#type' => 'select',
'#title' => t('Enable Receipt?'),
'#default_value' => $n,
'#options' => [
t('No'),
t('Yes'),
],
'#prefix' => '<div class="number-of">',
'#suffix' => '</div>',
'#description' => t('Enable this section if you want an electronic receipt to be sent automatically to the contributor\'s email address.'),
];
$this
->addAjaxItem("contribution:sets", "receipt_1_number_of_receipt", "receipt");
if ($n) {
$fs = "contribution_sets_receipt_{$n}_fieldset";
$this->form['contribution']['sets']['receipt'][$fs] = [
'#type' => 'fieldset',
'#title' => t('Receipt'),
'#attributes' => [
'id' => $fs,
'class' => [
'web-civi-checkbox-set',
],
],
'js_select' => $this
->addToggle($fs),
];
$emailFields = [
'receipt_1_number_of_receipt_receipt_from_name' => [
'#type' => 'textfield',
'#default_value' => wf_crm_aval($this->data, "receipt:number_number_of_receipt_receipt_from_name", ''),
'#title' => t('Receipt From Name'),
'#description' => t('Enter the FROM name to be used in receipt emails.'),
],
'receipt_1_number_of_receipt_receipt_from_email' => [
'#type' => 'textfield',
'#default_value' => wf_crm_aval($this->data, "receipt:number_number_of_receipt_receipt_from_email", ''),
'#title' => t('Receipt From Email'),
'#required' => TRUE,
'#description' => t('Enter the FROM email address to be used in receipt emails.'),
],
'receipt_1_number_of_receipt_cc_receipt' => [
'#type' => 'textfield',
'#default_value' => wf_crm_aval($this->data, "receipt:number_number_of_receipt_cc_receipt", ''),
'#title' => t('CC Receipt To'),
'#description' => t('If you want member(s) of your organization to receive a carbon copy of each emailed receipt, enter one or more email addresses here. Multiple email addresses should be separated by a comma (e.g. jane@example.org, paula@example.org).'),
],
'receipt_1_number_of_receipt_bcc_receipt' => [
'#type' => 'textfield',
'#default_value' => wf_crm_aval($this->data, "receipt:number_number_of_receipt_bcc_receipt", ''),
'#title' => t('BCC Receipt To'),
'#description' => t('If you want member(s) of your organization to receive a BLIND carbon copy of each emailed receipt, enter one or more email addresses here. Multiple email addresses should be separated by a comma (e.g. jane@example.org, paula@example.org).'),
],
'receipt_1_number_of_receipt_pay_later_receipt' => [
'#type' => 'textarea',
'#default_value' => wf_crm_aval($this->data, "receipt:number_number_of_receipt_pay_later_receipt", ''),
'#title' => t('Pay Later Text'),
'#prefix' => '<div class="auto-width">',
'#suffix' => '</div>',
'#description' => t("Text added to the confirmation email, when the user selects the 'pay later' option (e.g. 'Mail your check to ... within 3 business days.')."),
],
'receipt_1_number_of_receipt_receipt_text' => [
'#type' => 'textarea',
'#default_value' => wf_crm_aval($this->data, "receipt:number_number_of_receipt_receipt_text", ''),
'#title' => t('Receipt Text'),
'#prefix' => '<div class="auto-width">',
'#suffix' => '</div>',
'#description' => t('Enter a message you want included at the beginning of emailed receipts. NOTE: The text entered here will be used for both TEXT and HTML versions of receipt emails so we do not recommend including HTML tags / formatting here.'),
],
];
foreach ($emailFields as $k => $fld) {
$this->form['contribution']['sets']['receipt'][$fs][$k] = $fld;
}
}
}
/**
* Grant settings
* FIXME: This is nearly the same code as buildCaseTab. More utilities and less boilerplate needed.
*/
private function buildGrantTab() {
$utils = \Drupal::service('webform_civicrm.utils');
$types = $utils
->wf_crm_apivalues('grant', 'getoptions', [
'field' => 'grant_type_id',
]);
if (!$types) {
return;
}
$this->form['grantTab'] = [
'#type' => 'details',
'#title' => t('Grants'),
'#group' => 'webform_civicrm',
'#attributes' => [
'class' => [
'civi-icon-grant',
],
],
];
$this->form['grantTab']["grant_number_of_grant"] = [
'#type' => 'select',
'#title' => t('Number of Grants'),
'#default_value' => $num = wf_crm_aval($this->data, "grant:number_of_grant", 0),
'#options' => range(0, $this->sets['grant']['max_instances']),
'#prefix' => '<div class="number-of">',
'#suffix' => '</div>',
];
$this
->addAjaxItem("grantTab", "grant_number_of_grant", "grant");
for ($n = 1; $n <= $num; ++$n) {
$fs = "grant_grant_{$n}_fieldset";
$this->form['grantTab']['grant'][$fs] = [
'#type' => 'fieldset',
'#title' => t('Grant :num', [
':num' => $n,
]),
'wrap' => [
'#weight' => 9,
],
];
$this->form['grantTab']['grant'][$fs]["grant_{$n}_settings_existing_grant_status"] = [
'#type' => 'select',
'#title' => t('Update Existing Grant'),
'#options' => [
'' => '- ' . t('None') . ' -',
] + $utils
->wf_crm_apivalues('grant', 'getoptions', [
'field' => 'status_id',
]),
'#default_value' => wf_crm_aval($this->data, "grant:{$n}:existing_grant_status", []),
'#multiple' => TRUE,
];
$this
->help($this->form['grantTab']['grant'][$fs]["grant_{$n}_settings_existing_grant_status"], 'existing_grant_status');
$grant_type = wf_crm_aval($this->data, "grant:{$n}:grant:1:grant_type_id");
foreach ($this->sets as $sid => $set) {
if ($set['entity_type'] == 'grant' && (!$grant_type || empty($set['sub_types']) || in_array($grant_type, $set['sub_types']))) {
$fs1 = "grant_grant_{$n}_fieldset_{$sid}";
if ($sid == 'grant') {
$pos =& $this->form['grantTab']['grant'][$fs];
}
else {
$pos =& $this->form['grantTab']['grant'][$fs]['wrap'];
}
$pos[$fs1] = [
'#type' => 'fieldset',
'#title' => $set['label'],
'#attributes' => [
'id' => $fs1,
'class' => [
'web-civi-checkbox-set',
],
],
'js_select' => $this
->addToggle($fs1),
];
$this
->addDynamicCustomSetting($pos[$fs1], $sid, 'grant', $n);
if (isset($set['fields'])) {
foreach ($set['fields'] as $fid => $field) {
$fid = "civicrm_{$n}_grant_1_{$fid}";
$pos[$fs1][$fid] = $this
->addItem($fid, $field);
}
}
}
}
$this
->addAjaxItem("grantTab:grant:{$fs}:grant_grant_{$n}_fieldset_grant", "civicrm_{$n}_grant_1_grant_grant_type_id", "..:wrap");
}
}
/**
* Configure additional options
*/
private function buildOptionsTab() {
$utils = \Drupal::service('webform_civicrm.utils');
$this->form['additional_options'] = [
'#type' => 'details',
'#group' => 'webform_civicrm',
'#title' => t('Additional Settings'),
'#attributes' => [
'class' => [
'civi-icon-prefs',
],
],
];
$this->form['additional_options']['checksum_text'] = [
'#type' => 'item',
'#markup' => '<p>' . t('To have this form auto-filled for anonymous users, enable the "Existing Contact" field for :contact and send the following link from CiviMail:', [
':contact' => $utils
->wf_crm_contact_label(1, $this->data, 'escape'),
]) . '<br /><pre>' . Url::fromRoute('entity.webform.canonical', [
'webform' => $this->webform
->id(),
], [
'query' => [
'cid1' => '',
],
'absolute' => TRUE,
])
->toString() . '{contact.contact_id}&{contact.checksum}</pre></p>',
];
$this->form['additional_options']['create_fieldsets'] = [
'#type' => 'checkbox',
'#title' => t('Create Fieldsets'),
'#default_value' => (bool) $this->settings['create_fieldsets'],
'#description' => t('Create a fieldset around each contact, activity, etc. Provides visual organization of your form.'),
];
$this->form['additional_options']['confirm_subscription'] = [
'#type' => 'checkbox',
'#title' => t('Confirm Subscriptions'),
'#default_value' => (bool) $this->settings['confirm_subscription'],
'#description' => t('Recommended. Send a confirmation email before adding contacts to publicly subscribable mailing list groups.') . '<br />' . t('Your public mailing lists:') . ' <em>',
];
$ml = $utils
->wf_crm_apivalues('group', 'get', [
'is_hidden' => 0,
'visibility' => 'Public Pages',
'group_type' => 2,
], 'title');
if ($ml) {
if (count($ml) > 4) {
$ml = array_slice($ml, 0, 3);
$ml[] = t('etc.');
}
$this->form['additional_options']['confirm_subscription']['#description'] .= implode(', ', $ml) . '</em>';
}
else {
$this->form['additional_options']['confirm_subscription']['#description'] .= t('none') . '</em>';
}
$this->form['additional_options']['block_unknown_users'] = [
'#type' => 'checkbox',
'#title' => t('Block Unknown Users'),
'#default_value' => !empty($this->settings['block_unknown_users']),
'#description' => t('Only allow users to see this form if they are logged in or following a personalized link from CiviMail.'),
];
$this->form['additional_options']['create_new_relationship'] = [
'#type' => 'checkbox',
'#title' => t('Create New Relationship'),
'#default_value' => !empty($this->settings['create_new_relationship']),
'#description' => t('If enabled, only Active relationships will load on the form, and will be updated on Submit. If there are no Active relationships then a new one will be created.'),
];
$this->form['additional_options']['disable_contact_paging'] = [
'#type' => 'checkbox',
'#title' => t('Disable Contact Paging'),
'#default_value' => !empty($this->settings['disable_contact_paging']),
'#description' => t('If enabled, contact page break will not be added on saving the form.'),
];
$this->form['additional_options']['new_contact_source'] = [
'#type' => 'textfield',
'#title' => t('Source Label'),
'#maxlength' => 255,
'#size' => 30,
'#default_value' => empty($this->settings['new_contact_source']) ? $this->webform
->label() : $this->settings['new_contact_source'],
'#description' => t('Optional "source" label for any new contact/participant/membership created by this webform.'),
];
}
/**
* Ajax-loaded mini-forms for the contributions tab.
*/
private function checkSubmissionLimit() {
// Bypass this until it is fully rescoped.
return;
$webform = $this->webform;
/** @var \Drupal\webform\WebformAccessRulesManagerInterface $access_rules_manager */
$access_rules_manager = \Drupal::service('webform.access_rules_manager');
$anonymous_access = $access_rules_manager
->checkWebformAccess('create', new AnonymousUserSession(), $webform);
// If anonymous users don't have access to the form, no need for a warning.
if (!$anonymous_access
->isAllowed()) {
return;
}
// @todo reevaluate these options in D8.
return;
// Handle ajax submission from "submit_limit" mini-form below
if (!empty($_POST['submit_limit']) && !empty($_POST['submit_interval'])) {
$submit_limit = (int) $_POST['submit_limit'];
$submit_interval = (int) $_POST['submit_interval'];
if ($submit_limit > 0 && $submit_interval != 0) {
$webform['submit_limit'] = $submit_limit;
$webform['submit_interval'] = $submit_interval;
\Drupal::database()
->update('webform')
->condition('nid', $this->node->nid)
->fields([
'submit_limit' => $submit_limit,
'submit_interval' => $submit_interval,
])
->execute();
}
\Drupal::messenger()
->addStatus(t('Per-user submission limit has been updated. You may revisit these options any time on the <em>Form Settings</em> tab of this webform.'));
}
// Handle ajax submission from "webform_tracking_mode" mini-form below
if (!empty($_POST['webform_tracking_mode']) && $_POST['webform_tracking_mode'] == 'strict') {
\Drupal::state()
->set('webform_tracking_mode', 'strict');
\Drupal::messenger()
->addStatus(t('Webform anonymous user tracking has been updated to use the strict method. You may revisit this option any time on the global <a :link>Webform Settings</a> page.', [
':link' => 'href="/admin/config/content/webform" target="_blank"',
]));
}
// Mini-form to configure submit limit without leaving the page
if ($webform['submit_limit'] == -1) {
$this->form['contribution']['sets']['submit_limit'] = [
'#markup' => '<div class="messages warning">' . t('To prevent Credit Card abuse, it is recommended to set the per-user submission limit for this form.') . ' <button id="configure-submit-limit" type="button">' . t('Configure') . '</button>' . '<div id="submit-limit-wrapper" style="display:none">' . t('Limit each user to') . ' <input class="form-text" type="number" min="1" max="99" size="2" name="submit_limit"> ' . t('submission(s)') . ' <select class="form-select" name="submit_interval">' . '<option value="-1">' . t('ever') . '</option>' . '<option value="3600" selected="selected">' . t('every hour') . '</option>' . '<option value="86400">' . t('every day') . '</option>' . '<option value="604800">' . t('every week') . '</option>' . '</select> ' . ' <button id="configure-submit-limit-save" type="button">' . t('Save') . '</button>' . ' <button id="configure-submit-limit-cancel" type="button">' . t('Cancel') . '</button>' . '</div>' . '</div>',
];
}
elseif (\Drupal::state()
->get('webform_tracking_mode', 'cookie') == 'cookie') {
$this->form['contribution']['sets']['webform_tracking_mode'] = [
'#markup' => '<div class="messages warning">' . t('Per-user submission limit is enabled for this form, however the webform anonymous user tracking method is configured to use cookies only, which is not secure enough to prevent Credit Card abuse.') . ' <button id="webform-tracking-mode" type="button">' . t('Change Now') . '</button>' . ' <input type="hidden" value="" name="webform_tracking_mode"> ' . '</div>',
];
}
}
/**
* Set defaults when visiting the civicrm tab for the first time
*/
private function defaultSettings() {
return [
'data' => [
'contact' => [
1 => [
'contact' => [
1 => [
'contact_type' => 'individual',
'contact_sub_type' => [],
],
],
],
],
'reg_options' => [
'validate' => 1,
],
],
'confirm_subscription' => 1,
'create_fieldsets' => 1,
'new_contact_source' => '',
'civicrm_1_contact_1_contact_first_name' => 'create_civicrm_webform_element',
'civicrm_1_contact_1_contact_last_name' => 'create_civicrm_webform_element',
'civicrm_1_contact_1_contact_existing' => 'create_civicrm_webform_element',
];
}
/**
* Build a field item for the admin form
*
* @param string $fid
* civicrm field id
* @param array $field
* Webform field info
*
* @return array
* FAPI form item array for the admin form
*/
private function addItem($fid, $field) {
$utils = \Drupal::service('webform_civicrm.utils');
list(, $c, $ent, $n, $table, $name) = explode('_', $fid, 6);
$item = [
// We don't need numbers on the admin form since they are already grouped in fieldsets
'#title' => str_replace('#', '', $field['name']),
'#attributes' => wf_crm_aval($field, 'attributes'),
];
// Create dropdown list
if (!empty($field['expose_list'])) {
$field['form_key'] = $fid;
// Retrieve option list
$options = [];
// Placeholder empty option - used by javascript when displaying multiselect as single
if (!empty($field['extra']['multiple']) && empty($field['extra']['required'])) {
$options += [
'' => '- ' . t('None') . ' -',
];
}
// This prevents the multi-select js from adding an illegal empty option
if (!empty($field['extra']['required'])) {
$item['#attributes']['class'][] = 'required';
}
if ($field['type'] != 'hidden') {
$options += [
'create_civicrm_webform_element' => t('- User Select -'),
];
}
$options += $utils
->wf_crm_field_options($field, 'config_form', $this->data);
$item += [
'#type' => 'select',
'#options' => $options,
'#multiple' => !empty($field['extra']['multiple']),
'#civicrm_live_options' => !empty($field['civicrm_live_options']),
'#default_value' => !empty($field['empty_option']) ? 0 : NULL,
];
if (isset($field['empty_option'])) {
$item['#empty_option'] = '- ' . $field['empty_option'] . ' -';
$item['#empty_value'] = 0;
}
if (isset($field['data_type'])) {
$item['#attributes']['data-type'] = $field['data_type'];
}
// Five ways to get default value...
// 1: From current form state
if (isset($this->settings[$fid]) && $field['type'] != 'hidden') {
$item['#default_value'] = $this->settings[$fid];
}
elseif (isset($this->data[$ent][$c][$table][$n][$name])) {
$item['#default_value'] = $this->data[$ent][$c][$table][$n][$name];
}
elseif (isset($field['value_callback'])) {
$method = 'get_default_' . $table . '_' . $name;
$item['#default_value'] = self::$method($fid, $options);
}
elseif (isset($field['value'])) {
$item['#default_value'] = $field['value'];
}
elseif (empty($field['extra']['multiple']) && !isset($field['empty_option'])) {
$options = array_keys($options);
$item['#default_value'] = $options[1];
}
if (!empty($field['extra']['multiple'])) {
$item['#default_value'] = (array) $item['#default_value'];
if (isset($this->settings[$fid]) && !is_array($this->settings[$fid]) && isset($this->data[$ent][$c][$table][$n][$name])) {
$item['#default_value'] += (array) $this->data[$ent][$c][$table][$n][$name];
}
}
}
else {
$item += [
'#type' => 'checkbox',
'#return_value' => 'create_civicrm_webform_element',
'#default_value' => !empty($this->settings[$fid]),
];
}
// Add help
$topic = $table . '_' . $name;
$adminHelp = \Drupal::service('webform_civicrm.admin_help');
if (method_exists($adminHelp, $topic)) {
$this
->help($item, $topic);
}
elseif (!empty($field['has_help'])) {
$this
->help($item, $name);
}
elseif (wf_crm_aval($field, 'data_type') == 'ContactReference') {
$this
->help($item, 'contact_reference');
}
elseif (!empty($field['expose_list']) && !empty($field['extra']['multiple'])) {
$this
->help($item, 'multiselect_options');
}
return $item;
}
/**
* Boilerplate-reducing helper function for FAPI ajax.
* Set an existing form element to control an ajax container.
* The container will be created if it doesn't already exist.
*
* @param string $path
* A : separated string of nested array keys leading to the control element's parent
* @param string $control_element
* Array key of the existing element to add ajax behavior to
* @param string $container
* Path to the key of the container to be created (relative to $path) use '..' to go up a level
* @param string $class
* Css class to add to target container
*/
private function addAjaxItem($path, $control_element, $container, $class = 'civicrm-ajax-wrapper') {
// Get a reference to the control container
// For anyone who wants to call this evil - I challenge you to find a better way to accomplish this
eval('$control_container = &$this->form[\'' . str_replace(':', "']['", $path) . "'];");
// Now find the container element (may be outside the $path if .. is used)
foreach (explode(':', $container) as $level) {
if ($level == '..') {
$path = substr($path, 0, strrpos($path, ':'));
}
else {
$path .= ':' . $level;
}
}
eval('$target_container = &$this->form[\'' . str_replace(':', "']['", substr($path, 0, strrpos($path, ':'))) . "'];");
$id = 'civicrm-ajax-' . str_replace([
':',
'_',
], '-', $path);
$control_container[$control_element]['#ajax'] = [
'callback' => '\\Drupal\\webform_civicrm\\Form\\WebformCiviCRMSettingsForm::pathstrAjaxRefresh',
'pathstr' => $path,
'wrapper' => $id,
'effect' => 'fade',
];
if (!isset($target_container[$level])) {
$target_container[$level] = [];
}
$target_container[$level]['#prefix'] = '<div class="' . $class . '" id="' . $id . '">';
$target_container[$level]['#suffix'] = '</div>';
}
/**
* Build select all/none js links for a fieldset
*
* @return array
* The build information.
*/
private function addToggle($name) {
return [
'#markup' => '<div class="web-civi-js-select">
<a class="all" href="#">' . t('Select All') . '</a> |
<a class="none" href="#">' . t('Select None') . '</a> |
<a class="reset" href="#">' . t('Restore') . '</a>
</div>',
];
}
/**
* Build $this->data array for webform settings; called while rebuilding or post-processing the admin form.
*
* Made public so we can invoke from D8 form, for now.
*/
public function rebuildData() {
$utils = \Drupal::service('webform_civicrm.utils');
$this->settings['data'] = [
'contact' => [],
];
$this->data =& $this->settings['data'];
list($contact_types, $sub_types) = $utils
->wf_crm_get_contact_types();
for ($c = 1; $c <= $this->settings['number_of_contacts']; ++$c) {
// Contact settings
$contact_type_key = $c . '_contact_type';
if (isset($this->settings[$contact_type_key])) {
$contact_type = $this->settings[$contact_type_key];
$this->data['contact'][$c] = [
'contact' => [
1 => [
'contact_type' => $contact_type,
'contact_sub_type' => [],
'webform_label' => $this->settings[$c . '_webform_label'],
],
],
];
$sub_type = $this->settings["civicrm_{$c}_contact_1_contact_contact_sub_type"] ?? NULL;
if ($sub_type) {
$allowed = $sub_types[$contact_type] ?? [];
foreach ($sub_type as $sub) {
if (isset($allowed[$sub])) {
$this->data['contact'][$c]['contact'][1]['contact_sub_type'][$sub] = $sub;
}
}
}
}
else {
$this->data['contact'][$c] = [
'contact' => [
1 => [
'contact_type' => 'individual',
'contact_sub_type' => [],
],
],
'matching_rule' => 'Unsupervised',
];
// Set defaults for new contact
$this->settings += [
'civicrm_' . $c . '_contact_1_contact_first_name' => 'create_civicrm_webform_element',
'civicrm_' . $c . '_contact_1_contact_last_name' => 'create_civicrm_webform_element',
];
// ToDo: investigate how to re-instate this feature
// $link = [':link' => 'href="https://docs.civicrm.org/sysadmin/en/latest/integration/drupal/webform/#cloning-a-contact" target="_blank"'];
// \Drupal::messenger()->addStatus(t('Tip: Consider using the clone feature to add multiple similar contacts. (<a :link>more info</a>)', $link));
}
}
// Store meta settings, i.e. number of email for contact 1
foreach ($this->settings as $key => $val) {
if (strpos($key, '_number_of_') !== FALSE) {
list($ent, $c, $key) = explode('_', $key, 3);
if (isset($this->data[$ent][$c]) || $ent === 'participant' || $ent === 'membership') {
$this->data[$ent][$c][$key] = $val;
}
elseif (in_array($ent, [
'grant',
'activity',
'case',
'lineitem',
'receipt',
'billing',
])) {
$this->data[$ent]["number_{$key}"] = $val;
}
}
elseif (strpos($key, '_settings_') !== FALSE) {
list($ent, $c, , $key) = explode('_', $key, 4);
$val = is_array($val) ? array_filter($val) : $val;
// Don't store settings for nonexistant contacts. Todo: check other entities
if (isset($this->data[$ent][$c]) || $ent !== 'contact') {
$this->data[$ent][$c][$key] = $val;
}
}
}
// Enable billing address by default when contribution is enabled.
if ($this->settings['civicrm_1_contribution_1_contribution_enable_contribution'] && empty($this->data['billing'])) {
$this->data['billing'] = [
'number_number_of_billing' => 1,
];
$billingFields = [
'first_name',
'last_name',
'street_address',
'city',
'postal_code',
'state_province_id',
'country_id',
];
foreach ($billingFields as $field) {
$this->settings["civicrm_1_contribution_1_contribution_billing_address_{$field}"] = 1;
}
}
// Defaults when adding an activity
for ($i = 1; $i <= $this->settings['activity_number_of_activity']; ++$i) {
if (!isset($this->settings["activity_{$i}_settings_existing_activity_status"])) {
$this->data['activity'][$i]['activity'][1]['target_contact_id'] = range(1, $this->settings['number_of_contacts']);
}
}
// Defaults when adding a case
for ($i = 1, $iMax = wf_crm_aval($this->settings, 'case_number_of_case'); $i <= $iMax; ++$i) {
if (!isset($this->settings["civicrm_{$i}_case_1_case_case_type_id"])) {
$case_types = array_keys($utils
->wf_crm_apivalues('Case', 'getoptions', [
'field' => 'case_type_id',
]));
$this->data['case'][$i]['case'][1]['case_type_id'] = $case_types[0];
}
}
// Store event settings
if (isset($this->settings['participant_reg_type'])) {
$this->data['participant_reg_type'] = $this->settings['participant_reg_type'];
$this->data['reg_options'] = $this->settings['reg_options'];
}
// Add settings exposed to the back-end to data
foreach ($this->settings as $key => $val) {
if (strpos($key, 'civicrm') === 0) {
list(, $c, $ent, $n, $table, $name) = explode('_', $key, 6);
if (is_array($val)) {
// Git rid of the "User Select" and "None" options
unset($val['create_civicrm_webform_element'], $val['']);
}
elseif ($val === 'create_civicrm_webform_element') {
$val = '';
}
// Saves all non-empty values with a hack for fields which needs to be saved even when 0
// FIXME: Really ought to change the select placeholder value to be '' instead of 0
if (isset($this->fields[$table . '_' . $name]['expose_list']) && (!empty($val) || in_array($name, [
'num_terms',
'is_active',
'is_test',
'payment_processor_id',
]))) {
// Don't add data for non-existent contacts
if (!in_array($ent, [
'contact',
'participant',
'membership',
]) || isset($this->data['contact'][$c])) {
if ($name == 'payment_processor_id' && !empty($val) && is_numeric($val)) {
$val = $this
->getPaymentProcessorValue($val);
}
$this->data[$ent][$c][$table][$n][$name] = $val;
}
}
}
}
}
/**
* Submission handler, saves CiviCRM options for a Webform node
*
* Review this section and translate it to D8
* @todo this is what sets the elements on the webform.
*
* This needs to be reworked to support the checking of D8 elements and their removal.
*/
public function postProcess() {
$utils = \Drupal::service('webform_civicrm.utils');
$button = $this->form_state
->getTriggeringElement()['#id'];
$this->settings = $this->form_state
->getValues();
$handler_collection = $this->webform
->getHandlers('webform_civicrm');
/** @var \Drupal\webform\Plugin\WebformHandlerInterface $handler */
$handler = $handler_collection
->get('webform_civicrm');
$handler_configuration = $handler
->getConfiguration();
$enabled = $existing = $utils
->wf_crm_enabled_fields($this->webform, NULL, TRUE);
$delete_me = $this
->getFieldsToDelete($enabled);
// Display a confirmation before deleting fields
if ($delete_me && $button == 'edit-submit') {
$msg = '<p>' . t('These existing fields are no longer needed for CiviCRM processing based on your new form settings.') . '</p><ul>';
foreach ($delete_me as $key => $id) {
list(, $c, $ent, $n, $table, $name) = explode('_', $key, 6);
$info = '';
$element = $this->webform
->getElement($id);
$label = $this
->getSettings()["{$c}_webform_label"] ?? '';
$info = '<em>' . $label;
if ($info && isset($this->sets[$table]['max_instances'])) {
$info .= ' ' . $this->sets[$table]['label'] . ' ' . $n;
}
$info .= $info ? ':</em> ' : '';
$msg .= '<li>' . $info . $element['#title'] . '</li>';
}
$msg .= '</ul><p>' . t('Would you like them to be automatically removed from the webform? This is recommended unless you need to keep webform-results information from these fields. (They can still be deleted manually later if you choose not to remove them now.)') . '</p><p><em>' . t('Note: Deleting webform components cannot be undone, and will result in the loss of webform-results info for those elements. Data in the CiviCRM database will not be affected.') . '</em></p>';
$this->form_state
->set('msg', $msg);
$this->form_state
->set('vals', $this->settings);
$this->form_state
->setRebuild(TRUE);
$this->confirmPage = TRUE;
return;
}
\Drupal::ModuleHandler()
->loadInclude('webform', 'inc', 'includes/webform.components');
// Delete/disable fields
$deleted = 0;
if ($button === 'edit-delete' || $button === 'edit-disable' && $this->settings['nid']) {
foreach ($delete_me as $id) {
$field = $this->webform
->getElementDecoded($id);
unset($enabled[$field['#form_key']]);
++$deleted;
if ($button === 'edit-delete') {
$this->webform
->deleteElement($field['#form_key']);
}
else {
$field['#form_key'] = 'disabled' . substr($field['#form_key'], 7);
$this->webform
->setElementProperties($field['#form_key'], $field);
}
}
if ($deleted == 1) {
$p = [
'%name' => $field['#title'],
];
\Drupal::messenger()
->addStatus($button === 'edit-delete' ? t('Deleted field: %name', $p) : t('Disabled field: %name', $p));
}
else {
$p = [
':num' => $deleted,
];
\Drupal::messenger()
->addStatus($button === 'edit-delete' ? t('Deleted :num fields.', $p) : t('Disabled :num fields.', $p));
}
if ($button === 'edit-disable') {
\Drupal::messenger()
->addStatus(t('Disabled fields will still be processed as normal Webform fields, but they will not be autofilled from or saved to the CiviCRM database.'));
}
else {
// Remove empty fieldsets for deleted contacts
foreach ($enabled as $key => $id) {
if (substr($key, -8) == 'fieldset') {
list(, $c, $ent, $i) = explode('_', $key);
if ($ent == 'contact' && $i == 1 && (!$this->settings['nid'] || $c > $this->settings['number_of_contacts'])) {
$children = $this->webform
->getElement($id)['#webform_children'] ?? [];
if (empty($children)) {
$this->webform
->deleteElement($id);
}
}
}
}
}
}
// CiviCRM enabled
$this
->rebuildData();
if (!$this->settings['toggle_message']) {
$this->settings['message'] = '';
}
// Index disabled components
$disabled = [];
// @todo there is no disabled?
/*
foreach (wf_crm_aval($this->node->webform, 'components', array()) as $field) {
if (substr($field['form_key'], 0, 9) === 'disabled_') {
$field['form_key'] = 'civicrm' . substr($field['form_key'], 8);
$disabled[$field['form_key']] = $field;
}
}*/
$i = 0;
$created = [];
foreach ($this->settings as $key => $val) {
if (strpos($key, 'civicrm') === 0) {
++$i;
$field = $utils
->wf_crm_get_field($key);
if (!isset($enabled[$key])) {
$val = (array) $val;
if (in_array('create_civicrm_webform_element', $val, TRUE) || !empty($val[0]) && $field['type'] == 'hidden') {
// Restore disabled component
if (isset($disabled[$key])) {
webform_component_update($disabled[$key]);
$enabled[$key] = $disabled[$key]['cid'];
\Drupal::messenger()
->addStatus(t('Re-enabled field: %name', [
'%name' => $disabled[$key]['name'],
]));
}
else {
$field += [
// 'nid' => $nid,
'form_key' => $key,
];
// Cannot use isNewFieldset effectively.
$previous_data = $handler_configuration['settings'];
list(, $c, $ent) = $utils
->wf_crm_explode_key($key);
$type = in_array($ent, self::$fieldset_entities) ? $ent : 'contact';
$create = !isset($previous_data['data'][$type][$c]);
/*
list(, $c, $ent) = wf_crm_explode_key($field_key);
$type = in_array($ent, self::$fieldset_entities) ? $ent : 'contact';
return !isset($this->node->webform_civicrm['data'][$type][$c]);
*/
// @todo Properly handle fieldset creation.
// self::insertComponent($field, $enabled, $this->settings, !isset($previous_data['data'][$type][$c]));
self::insertComponent($field, $enabled, $this->settings, TRUE);
$created[] = $field['name'];
if (isset($field['civicrm_condition'])) {
$this
->addConditionalRule($field, $enabled);
}
}
}
}
elseif ($field['type'] === 'hidden' && !empty($field['expose_list'])) {
$elements = $this->webform
->getElementsDecodedAndFlattened();
$component = $elements[$enabled[$key]];
$component = WebformArrayHelper::removePrefix($component);
$component['value'] = $val;
$enabled[$key] = $component;
}
elseif (substr($key, -11) === '_createmode') {
// Update webform's settings with 'Create mode' value for custom group.
$this->settings['data']['config']['create_mode'][$key] = $val;
}
else {
// Try to "update" options for existing fields via ::insertComponent
// Always insert fieldsets, as there are checks to see if the
// fieldset already exists.
if (!isset($field)) {
$field = [];
}
$field += [
'form_key' => $key,
];
self::insertComponent($field, $enabled, $this->settings);
}
}
elseif (strpos($key, 'settings_dynamic_custom') && $val == 1) {
$emptySets = $utils
->wf_crm_get_empty_sets();
list($ent, $n, , , , $cgId) = explode('_', $key, 6);
$fieldsetKey = "civicrm_{$n}_{$ent}_1_{$cgId}_fieldset";
if (array_key_exists($cgId, $emptySets) && !isset($existing[$fieldsetKey])) {
$fieldset = [
// 'nid' => $nid,
'pid' => 0,
'form_key' => $fieldsetKey,
'name' => $emptySets[$cgId]['label'],
'type' => 'fieldset',
'weight' => $i,
];
webform_component_insert($fieldset);
}
}
}
if (isset($enabled['contribution_pagebreak']) && empty($this->settings['disable_contact_paging'])) {
$this
->setParentOnElements($enabled);
}
\Drupal::messenger()
->addStatus(\Drupal::translation()
->formatPlural(count($created), 'Added one field to the form', 'Added @count fields to the form'));
// Create record
$handler_configuration['settings'] = $this->settings;
$handler
->setConfiguration($handler_configuration);
$this
->addEnabledElements($enabled);
$this
->sortPaging();
// Update existing contact fields
foreach ($existing as $fid => $id) {
if (substr($fid, -8) === 'existing') {
$stop = null;
}
}
}
/**
* Add enabled elements to the webform.
*
* @param array $enabled
*/
public function addEnabledElements($enabled) {
$webform_element_manager = \Drupal::getContainer()
->get('plugin.manager.webform.element');
foreach ($enabled as $enabled_key => $enabled_element) {
if (!is_array($enabled_element)) {
// If this is a string, it is not a new element. However, this
// probably needs to be revisited.
continue;
}
// Webform uses YAML dump, which dies on FormattableMarkup.
$enabled_element = array_map([
$this,
'stringifyFormattableMarkup',
], $enabled_element);
$element_plugin = $webform_element_manager
->getElementInstance([
'#type' => $enabled_element['type'],
]);
$stub_form = [];
$stub_form_state = new FormState();
$stub_form_state
->set('default_properties', $element_plugin
->getDefaultProperties());
if (!isset($enabled_element['title']) && isset($enabled_element['name'])) {
$enabled_element['title'] = $enabled_element['name'];
}
unset($enabled_element['name']);
$stub_form_state
->setValues($enabled_element);
$properties = $element_plugin
->getConfigurationFormProperties($stub_form, $stub_form_state);
$parent_key = '';
if (isset($enabled_element['parent'])) {
$parent_key = $enabled_element['parent'];
}
$this->webform
->setElementProperties($enabled_key, $properties, $parent_key);
}
}
/**
* Fix paging on the webform.
*/
protected function sortPaging() {
$elements = $this->webform
->getElementsInitialized();
if (!isset($elements['contact_pagebreak'])) {
return;
}
//Move contact page to top.
if (key($elements) != 'contact_pagebreak') {
$elements = array_merge([
'contact_pagebreak' => $elements['contact_pagebreak'],
], $elements);
}
foreach ($elements as $key => &$element) {
if (strpos($key, 'civicrm') !== 0 || isset($element['#parent']) || !empty($element['#webform_parent_key']) || empty($element['#type']) || $element['#type'] == 'webform_wizard_page') {
continue;
}
$page = strpos($key, '_contribution_') !== FALSE ? 'contribution_pagebreak' : 'contact_pagebreak';
$elements[$page][$key] = $element;
unset($elements[$key]);
}
$this->webform
->setElements($elements);
$this->webform
->save();
}
/**
* Set parents for all elements in the webform.
*/
protected function setParentOnElements(&$enabled) {
if (!isset($enabled['contact_pagebreak'])) {
$enabled = array_merge([
'contact_pagebreak' => [
'type' => 'webform_wizard_page',
'form_key' => 'contact_pagebreak',
'title' => (string) t('Contact Information'),
],
], $enabled);
}
foreach ($enabled as $key => &$element) {
if (!is_array($element) || isset($element['parent']) || strpos($key, 'pagebreak') !== FALSE) {
continue;
}
$element['parent'] = strpos($key, '_contribution_') !== FALSE ? 'contribution_pagebreak' : 'contact_pagebreak';
}
}
protected function stringifyFormattableMarkup($data) {
if (is_array($data)) {
return array_map([
$this,
'stringifyFormattableMarkup',
], $data);
}
if ($data instanceof FormattableMarkup) {
return (string) $data;
}
return $data;
}
/**
* Create a conditional rule if the source and target fields both exist.
* TODO: This is fairly minimal. It doesn't check if the rule already exists,
* and doesn't work if both fields haven't been created yet.
*
* @param array $field
* @param array $enabled
*/
private function addConditionalRule($field, $enabled) {
$utils = \Drupal::service('webform_civicrm.utils');
list(, $c, $ent, $n, $table, $name) = explode('_', $field['form_key'], 6);
$rgid = $weight = -1;
foreach ($this->node->webform['conditionals'] as $rgid => $existing) {
$weight = $existing['weight'];
}
$rgid++;
$rule_group = $field['civicrm_condition'] + [
'nid' => $this->node->nid,
'rgid' => $rgid,
'weight' => $weight,
'actions' => [
[
'target' => $enabled[$field['form_key']],
'target_type' => 'component',
'action' => $field['civicrm_condition']['action'],
],
],
];
$rule_group['rules'] = [];
foreach ($field['civicrm_condition']['rules'] as $source => $condition) {
$source_key = "civicrm_{$c}_{$ent}_{$n}_{$source}";
$source_id = wf_crm_aval($enabled, $source_key);
if ($source_id) {
$options = $utils
->wf_crm_field_options([
'form_key' => $source_key,
], '', $this->settings['data']);
foreach ((array) $condition['values'] as $value) {
if (isset($options[$value])) {
$rule_group['rules'][] = [
'source_type' => 'component',
'source' => $source_id,
'operator' => wf_crm_aval($condition, 'operator', 'equal'),
'value' => $value,
];
}
}
}
}
if ($rule_group['rules']) {
$this->node->webform['conditionals'][] = $rule_group;
\Drupal::ModuleHandler()
->loadInclude('webform', 'inc', 'includes/webform.conditionals');
webform_conditional_insert($rule_group);
}
}
/**
* Set help text on the field description.
* @param array $field
* @param string $topic
*/
private function help(&$field, $topic) {
$adminHelp = \Drupal::service('webform_civicrm.admin_help');
$adminHelp
->addHelpDescription($field, $topic);
}
/**
* Search for fields that should be deleted
* @param array $fields
* @return array
*/
private function getFieldsToDelete($fields) {
$utils = \Drupal::service('webform_civicrm.utils');
// Find fields to delete
foreach ($fields as $key => $val) {
$val = (array) wf_crm_aval($this->settings, $key);
if (in_array('create_civicrm_webform_element', $val, TRUE) && $this->settings['nid'] || strpos($key, 'fieldset') !== FALSE) {
unset($fields[$key]);
}
elseif (substr($key, -11) === '_createmode') {
unset($fields[$key]);
}
else {
$field = $utils
->wf_crm_get_field($key);
if ($field['type'] == 'hidden' && (!empty($val[0]) || $field['name'] == 'Payment Processor Mode')) {
unset($fields[$key]);
}
}
}
return $fields;
}
/**
* Add a CiviCRM field to a webform
*
* @param $field : array
* Webform field info
* @param $enabled : array
* Array of enabled fields (reference)
* @param $settings
* webform_civicrm configuration for this form
* @param bool $create_fieldsets
*/
public static function insertComponent(&$field, &$enabled, $settings, $create_fieldsets = FALSE) {
$options = NULL;
$utils = \Drupal::service('webform_civicrm.utils');
list(, $c, $ent, $n, $table, $name) = explode('_', $field['form_key'], 6);
$contact_type = wf_crm_aval($settings['data']['contact'], "{$c}:contact:1:contact_type");
// Replace the # token with set number (or append to the end if no token)
if ($n > 1) {
if (strpos($field['name'], '#') === FALSE) {
$field['name'] .= " {$n}";
}
else {
$field['name'] = str_replace('#', $n, $field['name']);
}
}
elseif ($table == 'relationship') {
$field['name'] = t('Relationship to :contact', [
':contact' => $utils
->wf_crm_contact_label($n, $settings['data']),
]) . ' ' . $field['name'];
}
else {
$field['name'] = str_replace(' #', '', $field['name']);
}
if ($name == 'contact_sub_type') {
list($contact_types) = $utils
->wf_crm_get_contact_types();
$field['name'] = t('Type of @contact', [
'@contact' => $contact_types[$contact_type],
]);
}
// Defaults for existing contact field
if ($name === 'existing') {
$vals = $enabled + $settings;
// Set the allow_create flag based on presence of name or email fields
$field['allow_create'] = $a = $utils
->wf_crm_name_field_exists($vals, $c, $contact_type);
$field['none_prompt'] = $a ? t('+ Create new +') : t('- None Found -');
if ($c == 1 && $contact_type === 'individual') {
// Default to hidden field for 1st contact
$field += [
'widget' => 'hidden',
'default' => 'user',
];
}
}
// A width of 20 is more sensible than Drupal's default of 60
if (($field['type'] == 'textfield' || $field['type'] == 'email') && empty($field['extra']['width'])) {
$field['extra']['width'] = 20;
}
// Support html_textarea module
if ($field['type'] == 'html_textarea') {
$field['value']['format'] = filter_default_format();
$field['value']['value'] = '';
}
// Retrieve option list
if ($field['type'] === 'select') {
//To-do: Make this as a default type in src/Fields.php.
$field['type'] = 'civicrm_options';
if ($options = $utils
->wf_crm_field_options($field, 'component_insert', $settings['data'])) {
$field['options'] = $options;
$field['extra']['items'] = $utils
->wf_crm_array2str($options);
$field['extra']['aslist'] = $field['extra']['aslist'] ?? FALSE;
}
}
if ($field['type'] === 'civicrm_contact') {
$field['contact_type'] = $contact_type;
}
if ($field['type'] == 'file') {
$field['type'] = 'managed_file';
}
if (isset($field['value_callback'])) {
$method = 'get_default_' . $table . '_' . $name;
$field['value'] = self::$method($field['form_key'], $options);
}
// For hidden+select fields such as contribution_page
if ($field['type'] == 'hidden' && !empty($field['expose_list']) && !empty($settings[$field['form_key']])) {
$field['value'] = $settings[$field['form_key']];
}
if (!empty($field['set']) && $field['set'] == 'billing_1_number_of_billing') {
$ent = 'billing_1_number_of_billing';
}
// Create fieldsets for multivalued entities
if (empty($enabled[$field['form_key']]) && ($ent !== 'contribution' && ($ent !== 'participant' || wf_crm_aval($settings['data'], 'participant_reg_type') === 'separate'))) {
$fieldset_key = self::addFieldset($c, $field, $enabled, $settings, $ent, $create_fieldsets);
$field['parent'] = $fieldset_key;
}
// Create page break for contribution
if ($name === 'enable_contribution') {
$enabled['contribution_pagebreak'] = [
'type' => 'webform_wizard_page',
'form_key' => 'contribution_pagebreak',
'title' => (string) t('Payment'),
];
unset($enabled[$field['form_key']]);
return;
}
// Merge defaults and create webform component
$field += [
'extra' => [],
];
if (empty($enabled[$field['form_key']])) {
$enabled[$field['form_key']] = $field;
}
}
/**
* Create a fieldset around an entity if it doesn't already exist
*
* @param int $c
* @param array $field
* @param array $enabled
* @param array $settings
* @param string $ent
* @param bool $allow_create
*/
public static function addFieldset($c, &$field, &$enabled, $settings, $ent = 'contact', $allow_create = FALSE) {
$utils = \Drupal::service('webform_civicrm.utils');
$type = in_array($ent, self::$fieldset_entities, TRUE) ? $ent : 'contact';
// Custom fields are placed in fieldsets by group (for contact fields only)
if ($type === 'contact' && strpos($field['form_key'], '_custom_') !== FALSE) {
$sid = explode('_custom', $field['form_key']);
$sid = $sid[0] . '_fieldset';
$customGroupKey = explode('_', $field['form_key'])[4];
$allow_create = $isCustom = TRUE;
}
else {
$sid = "civicrm_{$c}_{$type}_1_fieldset_fieldset";
}
if ($allow_create && !empty($settings['create_fieldsets']) && !isset($enabled[$sid])) {
$new_set = [
// There is no nid.
// 'nid' => $field['nid'],
'form_key' => $sid,
'type' => 'fieldset',
];
$sets = $utils
->wf_crm_get_fields('sets');
if ($type == 'billing_1_number_of_billing') {
$new_set['parent'] = 'contribution_pagebreak';
}
if (isset($isCustom, $customGroupKey)) {
$new_set['title'] = $sets[$customGroupKey]['label'];
// @todo We cannot define a default weight.
// $new_set['weight'] = 200 + (array_search($type, self::$fieldset_entities, TRUE) * 10 + $c);
}
elseif ($type === 'contact') {
$new_set['title'] = $utils
->wf_crm_contact_label($c, $settings['data']);
}
else {
$new_set['title'] = $sets[$type]['label'] . ($c > 1 ? " {$c}" : '');
// @todo We cannot define a default weight.
// $new_set['weight'] = 200 + (array_search($type, self::$fieldset_entities, TRUE) * 10 + $c);
}
$webform_element_manager = \Drupal::getContainer()
->get('plugin.manager.webform.element');
$element_plugin = $webform_element_manager
->getElementInstance([
'#type' => $new_set['type'],
]);
$new_set = array_merge($element_plugin
->getDefaultProperties(), $new_set);
$enabled[$sid] = $new_set;
}
return $sid;
}
/**
* Return payment processor id as per is_test flag set on the webform.
*
* @param int $ppId.
* Payment Processor ID.
*
* @return int
* id of the payment processor as per is_test flag.
*/
protected function getPaymentProcessorValue($ppId) {
$utils = \Drupal::service('webform_civicrm.utils');
$pName = $utils
->wf_civicrm_api('PaymentProcessor', 'getvalue', [
'return' => "name",
'id' => $ppId,
]);
$params = [
'is_test' => $this->settings['civicrm_1_contribution_1_contribution_is_test'] ?? 0,
'is_active' => 1,
'name' => $pName,
];
return key($utils
->wf_crm_apivalues('PaymentProcessor', 'get', $params));
}
/**
* Default value callback
*/
public static function get_default_contact_cs($fid, $options) {
return \Drupal::service('webform_civicrm.utils')
->wf_crm_get_civi_setting('checksum_timeout', 7);
}
/**
* Default value callback
*/
public static function get_default_contribution_payment_processor_id($fid, $options) {
$default = \Drupal::service('webform_civicrm.utils')
->wf_civicrm_api('payment_processor', 'get', [
'is_default' => 1,
'is_test' => 0,
]);
if (!empty($default['id']) && isset($options[$default['id']])) {
return $default['id'];
}
unset($options[0]);
return $options ? key($options) : 0;
}
private function contactRefOptions($exclude = NULL) {
$ret = [];
foreach ($this->data['contact'] as $num => $contact) {
if ($num != $exclude) {
$ret[$num] = \Drupal::service('webform_civicrm.utils')
->wf_crm_contact_label($num, $this->data, 'plain');
}
}
return $ret;
}
/**
* Returns the data.
*
* @note This was added just to expose the property data during port.
*
* @return array
*/
public function getData() {
return $this->data;
}
/**
* Returns the settings.
*
* @note This was added just to expose the property data during port.
*
* @return array
*/
public function getSettings() {
return $this->settings;
}
/**
* A shim to set the settings manually.
*
* Replicates code in \AdminForm::postProcess where the settings
* property is set before rebuilding data.
*
* @param array $settings
*/
public function setSettings(array $settings) {
$this->settings = $settings;
}
/**
* When a custom field is saved/deleted in CiviCRM, sync webforms with dynamic fieldsets.
*
* @param string $op
* @param int $fid
* @param int $gid
*/
public static function handleDynamicCustomField($op, $fid, $gid) {
$utils = \Drupal::service('webform_civicrm.utils');
$sets = $utils
->wf_crm_get_fields('sets');
$field_name = $element = "cg{$gid}_custom_{$fid}";
if ($op === 'create' || $op === 'enable') {
$element = "cg{$gid}_custom_";
}
// Retrieve all webforms with this custom group.
$webforms = \Drupal::entityQuery('webform')
->condition('handlers.webform_civicrm.status', 1)
->condition('elements', $element, 'CONTAINS')
->execute();
/** @var \Drupal\webform\WebformInterface[] $webforms */
foreach ($webforms as $webformID) {
$webform = Webform::load($webformID);
$settings = $webform
->getHandler('webform_civicrm')
->getConfiguration()['settings'] ?? [];
// Check if the webform has a dynamic custom group.
$hasDynamicCG = FALSE;
foreach ($settings as $key => $value) {
if (strpos($key, "settings_dynamic_custom_cg{$gid}") !== FALSE && !empty($value)) {
$hasDynamicCG = TRUE;
break;
}
}
if (!$hasDynamicCG) {
continue;
}
$data = $settings['data'];
$field_info = $utils
->wf_crm_get_field($field_name);
// $field_info contains old data, so re-fetch
$fieldConfigs = $utils
->wf_civicrm_api('CustomField', 'getsingle', [
'id' => $fid,
]);
$enabled = $utils
->wf_crm_enabled_fields($webform, NULL, TRUE);
$updated = [];
// Handle update & delete of existing components
$elements = $webform
->getElementsDecodedAndFlattened();
foreach ($elements as $component_key => $component) {
if (substr($component['#form_key'], 0 - strlen($field_name)) === $field_name) {
if ($pieces = $utils
->wf_crm_explode_key($component['#form_key'])) {
list(, $c, $ent, $n, $table, $name) = $pieces;
if (!empty($data[$ent][$c]["dynamic_custom_cg{$gid}"])) {
if ($op === 'delete' || $op === 'disable') {
unset($elements[$component_key]);
$webform
->deleteElement($component_key);
}
elseif (isset($field_info)) {
$component['#title'] = $fieldConfigs['label'];
$component['#required'] = $fieldConfigs['is_required'];
$component['#default_value'] = $fieldConfigs['default_value'] ?: '';
$component['#extra']['description'] = $fieldConfigs['help_pre'] ?: '';
$component['#extra']['description_above'] = $field_info['extra']['description_above'];
$webform
->setElementProperties($component_key, $component);
}
$updated[$ent][$c] = 1;
}
}
}
}
// Handle create new components
if ($op === 'create' || $op === 'enable') {
$webform_element_manager = \Drupal::getContainer()
->get('plugin.manager.webform.element');
$ent = $sets["cg{$gid}"]['entity_type'];
foreach ($data[$ent] as $c => $item) {
if (!empty($item["dynamic_custom_cg{$gid}"]) && empty($updated[$ent][$c])) {
$new = $field_info;
$new['nid'] = $webform
->id();
$new['form_key'] = "civicrm_{$c}_{$ent}_1_{$field_name}";
if ($op === 'enable') {
$new['title'] = $fieldConfigs['label'];
$new['required'] = $fieldConfigs['is_required'];
$new['value'] = implode(',', $utils
->wf_crm_explode_multivalue_str($fieldConfigs['default_value']));
$new['data_type'] = $fieldConfigs['data_type'];
$custom_types = $utils
->wf_crm_custom_types_map_array();
$new['type'] = $custom_types[$fieldConfigs['html_type']]['type'];
}
self::insertComponent($new, $enabled, $settings);
$element_plugin = $webform_element_manager
->getElementInstance([
'#type' => $new['type'],
]);
$stub_form = [];
$stub_form_state = new FormState();
$stub_form_state
->set('default_properties', $element_plugin
->getDefaultProperties());
if (!isset($new['title']) && isset($new['name'])) {
$new['title'] = $new['name'];
}
unset($new['name']);
$stub_form_state
->setValues($new);
$properties = $element_plugin
->getConfigurationFormProperties($stub_form, $stub_form_state);
// @todo support parent key, for fieldsets and such.
$webform
->setElementProperties($new['form_key'], $properties);
}
}
}
$webform
->save();
}
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
AdminForm:: |
private | property | ||
|
AdminForm:: |
private | property | ||
|
AdminForm:: |
public static | property | ||
|
AdminForm:: |
private | property | ||
|
AdminForm:: |
private | property | ||
|
AdminForm:: |
private | property | ||
|
AdminForm:: |
private | property | ||
|
AdminForm:: |
private | property | ||
|
AdminForm:: |
private | property | The shim allowing us to slowly port this code. | |
|
AdminForm:: |
private | function | Boilerplate-reducing helper function for FAPI ajax. Set an existing form element to control an ajax container. The container will be created if it doesn't already exist. | |
|
AdminForm:: |
private | function | Create a conditional rule if the source and target fields both exist. TODO: This is fairly minimal. It doesn't check if the rule already exists, and doesn't work if both fields haven't been created yet. | |
|
AdminForm:: |
private | function | ||
|
AdminForm:: |
public | function | Add enabled elements to the webform. | |
|
AdminForm:: |
public static | function | Create a fieldset around an entity if it doesn't already exist | |
|
AdminForm:: |
private | function | Build a field item for the admin form | |
|
AdminForm:: |
private | function | Add necessary css & js | |
|
AdminForm:: |
private | function | Build select all/none js links for a fieldset | |
|
AdminForm:: |
private | function | Activity settings | |
|
AdminForm:: |
private | function | Case settings FIXME: This is exactly the same code as buildGrantTab. More utilities and less boilerplate needed. | |
|
AdminForm:: |
private | function | Display confirmation message and buttons before deleting webform components | |
|
AdminForm:: |
private | function | Build fields for a contact | |
|
AdminForm:: |
private | function | Contribution settings | |
|
AdminForm:: |
public | function | Build admin form for civicrm tab of a webform | |
|
AdminForm:: |
private | function | Build fields for form intro | |
|
AdminForm:: |
private | function | Grant settings FIXME: This is nearly the same code as buildCaseTab. More utilities and less boilerplate needed. | |
|
AdminForm:: |
private | function | Membership settings | |
|
AdminForm:: |
private | function | Configure messages | |
|
AdminForm:: |
private | function | Configure additional options | |
|
AdminForm:: |
private | function | Event participant settings | |
|
AdminForm:: |
private | function | Ajax-loaded mini-forms for the contributions tab. | |
|
AdminForm:: |
private | function | ||
|
AdminForm:: |
private | function | Set defaults when visiting the civicrm tab for the first time | |
|
AdminForm:: |
private | function | Adjust case role fields to match creator/manager settings for a given case type | |
|
AdminForm:: |
public | function | Returns the data. | |
|
AdminForm:: |
private | function | Search for fields that should be deleted | |
|
AdminForm:: |
protected | function | Return payment processor id as per is_test flag set on the webform. | |
|
AdminForm:: |
public | function | Returns the settings. | |
|
AdminForm:: |
public static | function | Default value callback | |
|
AdminForm:: |
public static | function | Default value callback | |
|
AdminForm:: |
public static | function |
When a custom field is saved/deleted in CiviCRM, sync webforms with dynamic fieldsets. Overrides AdminFormInterface:: |
|
|
AdminForm:: |
private | function | Set help text on the field description. | |
|
AdminForm:: |
function |
Initialize and set form variables. Overrides AdminFormInterface:: |
||
|
AdminForm:: |
private | function | Initialize form on first view | |
|
AdminForm:: |
public static | function | Add a CiviCRM field to a webform | |
|
AdminForm:: |
public | function | Submission handler, saves CiviCRM options for a Webform node | |
|
AdminForm:: |
public | function | Build $this->data array for webform settings; called while rebuilding or post-processing the admin form. | |
|
AdminForm:: |
private | function | On rebuilding the form | |
|
AdminForm:: |
protected | function | Set parents for all elements in the webform. | |
|
AdminForm:: |
public | function | A shim to set the settings manually. | |
|
AdminForm:: |
protected | function | Fix paging on the webform. | |
|
AdminForm:: |
protected | function |