You are here

Home » API reference » Webform CiviCRM Integration 8.5 » CivicrmContact.php

class CivicrmContact in Webform CiviCRM Integration 8.5

Same name in this branch
  1. 8.5 src/Element/CivicrmContact.php \Drupal\webform_civicrm\Element\CivicrmContact
  2. 8.5 src/Plugin/WebformElement/CivicrmContact.php \Drupal\webform_civicrm\Plugin\WebformElement\CivicrmContact

Provides a 'textfield' element.

Plugin annotation


@WebformElement(
  id = "civicrm_contact",
  api =
  "https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Render!Element!Textfield.php/class/Textfield",
  label = @Translation("CiviCRM Contact"), description =
  @Translation("Choose existing contact."), category =
  @Translation("CiviCRM"),
)

Hierarchy

Expanded class hierarchy of CivicrmContact

1 file declares its use of CivicrmContact
WebformCivicrmPreProcess.php in src/WebformCivicrmPreProcess.php
Front-end form pre-processor.

File

src/Plugin/WebformElement/CivicrmContact.php, line 26

Namespace

Drupal\webform_civicrm\Plugin\WebformElement
View source 
class CivicrmContact extends WebformElementBase {

  /**
   * {@inheritdoc}
   */
  public function getDefaultProperties() {
    return [
      'name' => '',
      'form_key' => '',
      'pid' => 0,
      'weight' => 0,
      'value' => '',
      'required' => 0,
      'search_prompt' => '',
      'none_prompt' => '',
      'results_display' => [
        'display_name',
      ],
      'allow_create' => 0,
      'widget' => '',
      'contact_type' => '',
      'show_hidden_contact' => 0,
      'unique' => 0,
      'title_display' => 'before',
      'randomize' => 0,
      'description' => '',
      'no_autofill' => [],
      'hide_fields' => [],
      'hide_method' => 'hide',
      'no_hide_blank' => FALSE,
      'submit_disabled' => FALSE,
      'attributes' => [],
      'private' => FALSE,
      'default' => '',
      'default_contact_id' => '',
      'default_relationship_to' => '',
      'default_relationship' => '',
      'allow_url_autofill' => TRUE,
      'dupes_allowed' => FALSE,
      'filter_relationship_types' => [],
      'filter_relationship_contact' => [],
      'contact_sub_type' => '',
      'group' => [],
      'tag' => [],
      'check_permissions' => 1,
      // Set for custom fields.
      'expose_list' => FALSE,
      'empty_option' => '',
    ] + parent::getDefaultProperties();
  }

  /**
   * {@inheritdoc}
   *
   * @todo port logic from _webform_render_civicrm_contact()
   * @see _webform_render_civicrm_contact()
   */
  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
    \Drupal::service('civicrm')
      ->initialize();
    $element['#form_key'] = $element['#form_key'] ?? $element['#webform_key'];

    // Webform removes values which equal their defaults but does not populate
    // they keys.
    $ensure_keys_have_values = [
      'hide_method',
      'no_hide_blank',
      'default',
      'default_contact_id',
      'default_relationship',
      'allow_url_autofill',
    ];
    foreach ($ensure_keys_have_values as $key) {
      if (empty($element['#' . $key])) {
        $element['#' . $key] = $this
          ->getDefaultProperty($key);
      }
    }
    $element['#attached']['library'][] = 'webform_civicrm/civicrm_contact';
    $element['#attached']['drupalSettings']['webform_civicrm'][$element['#form_key']] = [
      'hiddenFields' => [],
    ];
    $element['#type'] = $element['#widget'] === 'autocomplete' ? 'textfield' : $element['#widget'];
    $element['#attributes']['data-hide-fields'] = implode(', ', $this
      ->getElementProperty($element, 'hide_fields'));
    $element['#attributes']['data-hide-method'] = $this
      ->getElementProperty($element, 'hide_method');
    $element['#attributes']['data-no-hide-blank'] = (int) $this
      ->getElementProperty($element, 'no_hide_blank');
    $cid = $this
      ->getElementProperty($element, 'default_value');
    list(, $c, ) = explode('_', $element['#form_key'], 3);
    $element['#attributes']['data-civicrm-contact'] = $c;
    $element['#attributes']['data-form-id'] = $webform_submission ? $webform_submission
      ->getWebform()
      ->id() : NULL;
    if ($element['#type'] === 'hidden') {

      // User may not change this value for hidden fields
      $element['#value'] = $cid;
      if (empty($element['#show_hidden_contact'])) {
        return;
      }
      $element['#attributes']['show-hidden-contact'] = 1;
    }
    elseif ($element['#type'] === 'select') {
      $element['#options'] = [];
      $element['#attributes']['data-is-select'] = 1;
    }
    $element['#attributes']['data-search-prompt'] = $this
      ->getElementProperty($element, 'search_prompt') ?? '- Choose existing -';
    $element['#attributes']['data-none-prompt'] = $this
      ->getElementProperty($element, 'none_prompt') ?? '+ Create new +';
    if (!empty($cid)) {
      $webform = $webform_submission
        ->getWebform();
      $contactComponent = \Drupal::service('webform_civicrm.contact_component');

      // Don't lookup same contact again
      if (wf_crm_aval($element, '#attributes:data-civicrm-id') != $cid) {
        $filters = $contactComponent
          ->wf_crm_search_filters($webform, $element);
        $name = $contactComponent
          ->wf_crm_contact_access($element, $filters, $cid);
        if ($name !== FALSE) {
          $element['#attributes']['data-civicrm-name'] = $name;
          $element['#attributes']['data-civicrm-id'] = $cid;
        }
        else {
          unset($cid);
        }
      }
    }
    if (empty($cid) && $element['#type'] === 'hidden' && isset($element['#none_prompt'])) {
      $element['#attributes']['data-civicrm-name'] = Xss::filter($element['#none_prompt']);
    }
    parent::prepare($element, $webform_submission);
  }

  /**
   * {@inheritdoc}
   *
   * @see _webform_edit_civicrm_contact()
   * @see webform_civicrm_webform_component_presave only form_id 1 can have static user.
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    $form['element']['value']['#access'] = FALSE;
    $form['element']['multiple']['#access'] = FALSE;
    $webform = $form_state
      ->getFormObject()
      ->getWebform();
    $utils = \Drupal::service('webform_civicrm.utils');
    \Drupal::getContainer()
      ->get('civicrm')
      ->initialize();
    \CRM_Core_Resources::singleton()
      ->addCoreResources();
    $form['#attached']['library'][] = 'webform_civicrm/civicrm_contact';
    $data = $webform
      ->getHandler('webform_civicrm')
      ->getConfiguration()['settings']['data'];
    $element_properties = $form_state
      ->get('element_properties');
    list($contact_types, $sub_types) = $utils
      ->wf_crm_get_contact_types();
    list(, $c, ) = explode('_', $element_properties['form_key'], 3);
    $contact_type = $element_properties['contact_type'];
    $allow_create = $element_properties['allow_create'];
    $form['form']['display_container']['#weight'] = 10;
    $form['form']['field_container']['#weight'] = 10;
    $form['validation']['#weight'] = 10;
    $form['form']['widget'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Form Widget'),
      '#default_value' => $element_properties['widget'],
      '#options' => [
        'autocomplete' => $this
          ->t('Autocomplete'),
        'select' => $this
          ->t('Select List'),
        'hidden' => $this
          ->t('Static'),
        'textfield' => $this
          ->t('Enter Contact ID'),
      ],
    ];
    $allow_create ? $this
      ->t('<strong>Contact Creation: Enabled</strong> - this contact has name/email fields on the webform.') : $this
      ->t('<strong>Contact Creation: Disabled</strong> - no name/email fields for this contact on the webform.');

    // $adminHelp->addHelpDescription($form['display'], 'contact_creation');
    // $form['civicrm']['#description'] = '<div class="messages ' . ($allow_create ? 'status' : 'warning') . '">' . $status . ' ' . $form['display']['#description'] . '</div>';
    $form['form']['search_prompt'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Search Prompt'),
      '#default_value' => $element_properties['search_prompt'],
      '#description' => $this
        ->t('Text the user will see before selecting a contact.'),
      '#size' => 60,
      '#maxlength' => 1024,
      '#states' => [
        'invisible' => [
          'select[name="properties[widget]"]' => [
            'value' => 'hidden',
          ],
        ],
      ],
    ];
    $form['form']['none_prompt'] = [
      '#type' => 'textfield',
      '#title' => $allow_create ? $this
        ->t('Create Prompt') : $this
        ->t('Not Found Prompt'),
      '#default_value' => $element_properties['none_prompt'],
      '#description' => $allow_create ? $this
        ->t('This text should prompt the user to create a new contact.') : $this
        ->t('This text should tell the user that no search results were found.'),
      '#size' => 60,
      '#maxlength' => 1024,
    ];
    $form['form']['show_hidden_contact'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Display Contact Name'),
      '#description' => $this
        ->t('If enabled, this static element will show the contact that has been pre-selected (or else the Create/Not Found Prompt if set). Otherwise the element will not be visible.'),
      '#options' => [
        $this
          ->t('No'),
        $this
          ->t('Yes'),
      ],
      '#default_value' => $element_properties['show_hidden_contact'],
    ];
    $form['form']['results_display'] = [
      '#type' => 'select',
      '#multiple' => TRUE,
      '#title' => $this
        ->t('Contact Display Field(s)'),
      '#required' => TRUE,
      '#default_value' => $element_properties['results_display'],
      '#options' => $this
        ->wf_crm_results_display_options($contact_type),
    ];
    $form['field_handling'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Contact Field Handling'),
    ];
    $form['field_handling']['no_autofill'] = [
      '#type' => 'select',
      '#multiple' => TRUE,
      '#title' => $this
        ->t('Skip Autofilling of'),
      '#description' => $this
        ->t('Which fields should <em>not</em> be autofilled for this contact?'),
      '#default_value' => $element_properties['no_autofill'],
      '#options' => [
        '' => '- ' . $this
          ->t('None') . ' -',
      ] + $this
        ->wf_crm_contact_fields($webform, $c),
    ];
    $form['field_handling']['hide_fields'] = [
      '#type' => 'select',
      '#multiple' => TRUE,
      '#title' => $this
        ->t('Fields to Lock'),
      '#description' => $this
        ->t('Prevent editing by disabling or hiding fields when a contact already exists.'),
      '#default_value' => $element_properties['hide_fields'],
      '#options' => [
        '' => '- ' . $this
          ->t('None') . ' -',
      ] + $this
        ->wf_crm_contact_fields($webform, $c),
    ];
    $form['field_handling']['hide_method'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Locked fields should be'),
      '#default_value' => $element_properties['hide_method'],
      '#options' => [
        'hide' => $this
          ->t('Hidden'),
        'disable' => $this
          ->t('Disabled'),
      ],
      '#states' => [
        'visible' => [
          'select[name="properties[hide_fields][]"]' => [
            '!value' => '',
          ],
        ],
      ],
    ];
    $form['field_handling']['no_hide_blank'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Don't lock fields that are empty"),
      '#default_value' => $element_properties['no_hide_blank'],
      '#states' => [
        'visible' => [
          'select[name="properties[hide_fields][]"]' => [
            '!value' => '',
          ],
        ],
      ],
    ];
    $form['field_handling']['submit_disabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Submit disabled field value(s)'),
      '#description' => $this
        ->t('Store disabled field value(s) in webform submissions.'),
      '#default_value' => $element_properties['submit_disabled'],
      '#states' => [
        'visible' => [
          'select[name="properties[hide_fields][]"]' => [
            '!value' => '',
          ],
        ],
      ],
    ];
    $form['contact_defaults'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Default value'),
      '#description' => $this
        ->t('Should the form be pre-populated with an existing contact?<ul><li>Any filters set below will restrict this default.</li><li>If more than one contact meets the criteria, the first match will be picked. If multiple existing contact fields exist on the webform, each will select a different contact.</li></ul>'),
    ];
    $form['contact_defaults']['default'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Set default contact from'),
      '#options' => [
        'contact_id' => $this
          ->t('Specified Contact'),
      ],
      '#empty_option' => $this
        ->t('- None -'),
      '#default_value' => $element_properties['default'],
    ];
    if ($c == 1 && $contact_type == 'individual') {
      $form['contact_defaults']['default']['#options']['user'] = $this
        ->t('Current User');
    }
    elseif ($c > 1) {
      $form['contact_defaults']['default']['#options']['relationship'] = $this
        ->t('Relationship to...');
      $form['contact_defaults']['default_relationship_to'] = [
        '#type' => 'select',
        '#default_value' => $element_properties['default_relationship_to'],
      ];
      $form['contact_defaults']['default_relationship'] = [
        '#type' => 'select',
        '#multiple' => TRUE,
        '#title' => $this
          ->t('Specify Relationship(s)'),
        '#options' => [
          '' => '- ' . $this
            ->t('No relationship types defined for @a to @b', [
            '@a' => $contact_types[$contact_type],
            '@b' => $contact_types[$data['contact'][1]['contact'][1]['contact_type']],
          ]) . ' -',
        ],
        '#default_value' => $element_properties['default_relationship'],
      ];
    }
    $form['contact_defaults']['default']['#options']['auto'] = $this
      ->t('Auto - From Filters');
    $form['contact_defaults']['default_contact_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Contact'),
      '#id' => 'default-contact-id',
      '#states' => [
        'visible' => [
          'select[name="properties[default]"]' => [
            'value' => 'contact_id',
          ],
        ],
      ],
    ];
    $cid = $element_properties['default_contact_id'];
    $contactComponent = \Drupal::service('webform_civicrm.contact_component');
    if ($cid && ($name = $contactComponent
      ->wf_crm_contact_access($element_properties, [
      'check_permissions' => 1,
    ], $cid))) {
      $form['contact_defaults']['default_contact_id']['#default_value'] = $cid;
      $form['contact_defaults']['default_contact_id']['#attributes'] = [
        'data-civicrm-name' => $name,
        'data-civicrm-id' => $cid,
      ];
    }
    $form['contact_defaults']['allow_url_autofill'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use contact id from URL'),
      '#default_value' => $element_properties['allow_url_autofill'],
      '#description' => $this
        ->t('If the url contains e.g. %arg, it will be used to pre-populate this contact (takes precidence over other default values).', [
        '%arg' => "cid{$c}=123",
      ]),
    ];
    if ($c > 1) {
      $form['contact_defaults']['dupes_allowed'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Allow Duplicate Autofill'),
        '#default_value' => $element_properties['dupes_allowed'],
        '#description' => $this
          ->t('Check this box to allow a contact to be selected even if they already autofilled a prior field on the form. (For example, if contact 1 was autofilled with Bob Smith, should this field also be allowed to select Bob Smith or should it pick a different contact?)'),
      ];
    }
    $form['contact_defaults']['randomize'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Randomize'),
      '#default_value' => $element_properties['randomize'],
      '#description' => $this
        ->t('Pick a contact at random if more than one meets criteria.'),
      '#states' => [
        'visible' => [
          'select[name="properties[default]"]' => [
            'value' => 'auto',
          ],
        ],
      ],
    ];
    $form['filters'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Filters'),
      '#description' => $this
        ->t('Only contacts meeting filter criteria will be available as select options or default value.<br />Note: Filters only apply to how a contact is chosen on the form, they do not affect how a contact is saved.'),
    ];
    if (!empty($sub_types[$contact_type])) {
      $form['filters']['contact_sub_type'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Type of @contact', [
          '@contact' => $contact_types[$contact_type],
        ]),
        '#empty_option' => $this
          ->t('- Any -'),
        '#options' => $sub_types[$contact_type],
        '#default_value' => $element_properties['contact_sub_type'],
      ];
    }
    $form['filters']['group'] = [
      '#type' => 'select',
      '#multiple' => TRUE,
      '#title' => $this
        ->t('Groups'),
      '#options' => [
        '' => '- ' . $this
          ->t('None') . ' -',
      ] + $utils
        ->wf_crm_apivalues('group_contact', 'getoptions', [
        'field' => 'group_id',
      ]),
      '#default_value' => $element_properties['group'],
      '#description' => $this
        ->t('Listed contacts must be members of at least one of the selected groups (leave blank to not filter by group).'),
    ];
    $tags = [];
    $form['filters']['tag'] = [
      '#type' => 'select',
      '#multiple' => TRUE,
      '#title' => $this
        ->t('Tags'),
      '#options' => [
        '' => '- ' . $this
          ->t('None') . ' -',
      ] + CRM_Core_BAO_Tag::getTags('civicrm_contact', $tags, NULL, '- '),
      '#default_value' => $element_properties['tag'],
      '#description' => $this
        ->t('Listed contacts must be have at least one of the selected tags (leave blank to not filter by tag).'),
    ];
    if ($c > 1) {
      $form['filters']['relationship']['filter_relationship_contact'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Relationships to'),
        '#options' => [
          '' => '- ' . $this
            ->t('None') . ' -',
        ],
        '#default_value' => $element_properties['filter_relationship_contact'],
      ];
      $form['filters']['relationship']['filter_relationship_types'] = [
        '#type' => 'select',
        '#multiple' => TRUE,
        '#title' => $this
          ->t('Specify Relationship(s)'),
        '#options' => [
          '' => '- ' . $this
            ->t('Any relation') . ' -',
        ],
        '#default_value' => $element_properties['filter_relationship_types'],
      ];

      // Fill relationship data for defaults and filters
      $all_relationship_types = array_fill(1, $c - 1, []);
      for ($i = 1; $i < $c; ++$i) {
        $form['contact_defaults']['default_relationship_to']['#options'][$i] = $form['filters']['relationship']['filter_relationship_contact']['#options'][$i] = $utils
          ->wf_crm_contact_label($i, $data, 'plain');
        $rtypes = $utils
          ->wf_crm_get_contact_relationship_types($contact_type, $data['contact'][$i]['contact'][1]['contact_type'], $data['contact'][$c]['contact'][1]['contact_sub_type'], $data['contact'][$i]['contact'][1]['contact_sub_type']);
        foreach ($rtypes as $k => $v) {
          $all_relationship_types[$i][] = [
            'key' => $k,
            'value' => $v . ' ' . $utils
              ->wf_crm_contact_label($i, $data, 'plain'),
          ];
          $form['contact_defaults']['default_relationship']['#options'][$k] = $form['filters']['relationship']['filter_relationship_types']['#options'][$k] = $v . ' ' . $utils
            ->wf_crm_contact_label($i, $data, 'plain');
        }
        if (!$rtypes) {
          $all_relationship_types[$i][] = [
            'key' => '',
            'value' => '- ' . t('No relationship types defined for @a to @b', [
              '@a' => $contact_types[$contact_type],
              '@b' => $contact_types[$data['contact'][$i]['contact'][1]['contact_type']],
            ]) . ' -',
          ];
        }
      }
      $form['contact_defaults']['default_relationship']['#attributes']['data-reltypes'] = $form['filters']['relationship']['filter_relationship_types']['#attributes']['data-reltypes'] = json_encode($all_relationship_types);
    }
    $form['filters']['check_permissions'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enforce Permissions'),
      '#default_value' => $element_properties['check_permissions'],
      '#description' => $this
        ->t('Only show contacts the acting user has permission to see in CiviCRM.') . '<br />' . $this
        ->t('WARNING: Keeping this option enabled is highly recommended unless you are effectively controlling access by another method.'),
    ];

    // Need to be hidden values so that they persist from configuration on the
    // main Webform CiviCRM settings form.
    $form['allow_create'] = [
      '#type' => 'hidden',
      '#value' => $element_properties['allow_create'],
    ];
    $form['contact_type'] = [
      '#type' => 'value',
      '#value' => $element_properties['contact_type'],
    ];
    return $form;
  }

  /**
   * Find exposed field groups for a contact
   *
   * @param $webform
   * @param $con
   *   Contact #
   *
   * @return array
   */
  function wf_crm_contact_fields($webform, $con) {
    $ret = [];
    $utils = \Drupal::service('webform_civicrm.utils');
    $sets = $utils
      ->wf_crm_get_fields('sets');
    $sets['name'] = [
      'label' => t('Name'),
    ];
    $elements = $webform
      ->getElementsDecodedAndFlattened();
    foreach ($elements as $f) {
      if ($pieces = $utils
        ->wf_crm_explode_key($f['#form_key'])) {
        list(, $c, $ent, , $table, $field) = $pieces;
        if ($ent == 'contact' && $c == $con && isset($sets[$table])) {

          // Separate name from other contact fields
          if ($table == 'contact' && strpos($field, 'name')) {
            $table = 'name';
          }
          if ($field != 'existing') {
            $ret[$table] = $sets[$table]['label'];
          }
        }
      }
    }
    return $ret;
  }

  /**
   * Returns a list of fields that can be shown in an "Existing Contact" field display
   * In the future we could use api.getfields for this, but that also returns a lot of stuff we don't want
   *
   * @return array
   */
  function wf_crm_results_display_options($contact_type) {
    $options = [
      'display_name' => t("Display Name"),
      'sort_name' => t("Sort Name"),
    ];
    if ($contact_type == 'individual') {
      $options += [
        'first_name' => t("First Name"),
        'middle_name' => t("Middle Name"),
        'last_name' => t("Last Name"),
        'current_employer' => t("Current Employer"),
        'job_title' => t("Job Title"),
      ];
    }
    else {
      $options[$contact_type . '_name'] = $contact_type == 'organization' ? t("Organization Name") : t("Household Name");
    }
    $options += [
      'nick_name' => t("Nick Name"),
      'id' => t("Contact ID"),
      'external_identifier' => t("External ID"),
      'source' => t("Source"),
      'email' => t("Email"),
      'city' => t("City"),
      'county' => t("District/County"),
      'state_province' => t("State/Province"),
      'country' => t("Country"),
      'postal_code' => t("Postal Code"),
      'phone' => t("Phone"),
    ];
    return $options;
  }

  /**
   * Lookup contact name from ID, verify permissions, and attach as html data.
   *
   * Used when rendering or altering a CiviCRM contact field.
   *
   * Also sets options for select lists.
   *
   * @param \Drupal\webform\WebformInterface $node
   *   Node object
   * @param array $component
   *   Webform component
   * @param array $element
   *   FAPI form element (reference)
   * @param array $ids
   *   Known entity ids
   */
  public static function wf_crm_fill_contact_value(WebformInterface $node, array &$element, array $ids = NULL) {
    $cid = wf_crm_aval($element, '#default_value', '');
    $contactComponent = \Drupal::service('webform_civicrm.contact_component');
    if ($element['#type'] == 'hidden') {
      $element['#value'] = $cid;
      if (empty($element['#show_hidden_contact'])) {
        return;
      }
    }
    if ($cid) {

      // Don't lookup same contact again
      if (wf_crm_aval($element, '#attributes:data-civicrm-id') != $cid) {
        $filters = $contactComponent
          ->wf_crm_search_filters($node, $element);
        $name = $contactComponent
          ->wf_crm_contact_access($element, $filters, $cid);
        if ($name !== FALSE) {
          $element['#attributes']['data-civicrm-name'] = $name;
          $element['#attributes']['data-civicrm-id'] = $cid;
        }
        else {
          unset($cid);
        }
      }
    }
    if ($element['#type'] == 'hidden') {
      $element['#theme'] = 'webform_civicrm_contact';
      $element['#attributes']['title'] = $element['#title'];
      $element['#attributes']['cid'] = $cid;
      if (empty($cid) && $element['#none_prompt']) {
        $element['#attributes']['data-civicrm-name'] = Html::escape($element['#none_prompt']);
      }
    }

    // Set options list for select elements. We do this here so we have access to entity ids.
    if (is_array($ids) && $element['#type'] == 'select') {
      $filters = $contactComponent
        ->wf_crm_search_filters($node, $element);
      $element['#options'] = $contactComponent
        ->wf_crm_contact_search($node, $element, $filters, wf_crm_aval($ids, 'contact', []));

      // Display empty option unless there are no results
      if (empty($element['#allow_create']) || count($element['#options']) > 1) {
        $element['#empty_option'] = Xss::filter($element[$element['#options'] ? '#search_prompt' : '#none_prompt']);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function formatHtmlItem(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
    $value = parent::formatHtmlItem($element, $webform_submission, $options);
    $format = $this
      ->getItemFormat($element);
    $cid = $value['#plain_text'] ?? NULL;
    if ($format === 'raw' || empty($cid) || !is_numeric($cid)) {
      return $value;
    }
    $utils = \Drupal::service('webform_civicrm.utils');
    $contact = $utils
      ->wf_crm_apivalues('contact', 'get', [
      'id' => $cid,
    ], 'display_name');
    if (!empty($contact[$cid])) {
      if (empty($options['email']) && \Drupal::currentUser()
        ->hasPermission('access CiviCRM')) {
        unset($value['#plain_text']);
        $cidURL = Url::fromUri('internal:/civicrm/contact/view', [
          'query' => [
            'reset' => 1,
            'cid' => $cid,
          ],
        ])
          ->toString();
        $value['#markup'] = t('<a href=":link">@name</a>', [
          ':link' => $cidURL,
          '@name' => $contact[$cid],
        ]);
      }
      else {
        $value['#plain_text'] = $contact[$cid];
      }
    }
    return $value;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CivicrmContact::form public function Overrides WebformElementBase::form
CivicrmContact::formatHtmlItem protected function Format an element's value as HTML. Overrides WebformElementBase::formatHtmlItem
CivicrmContact::getDefaultProperties public function Get default properties. Overrides WebformElementBase::getDefaultProperties
CivicrmContact::prepare public function @todo port logic from _webform_render_civicrm_contact() Overrides WebformElementBase::prepare
CivicrmContact::wf_crm_contact_fields function Find exposed field groups for a contact
CivicrmContact::wf_crm_fill_contact_value public static function Lookup contact name from ID, verify permissions, and attach as html data.
CivicrmContact::wf_crm_results_display_options function Returns a list of fields that can be shown in an "Existing Contact" field display In the future we could use api.getfields for this, but that also returns a lot of stuff we don't want
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.
WebformCompositeFormElementTrait::preRenderWebformCompositeFormElement public static function Adds form element theming to an element if its title or description is set. 1
WebformElementBase::$configFactory protected property The configuration factory.
WebformElementBase::$currentUser protected property The current user.
WebformElementBase::$defaultProperties protected property An associative array of an element's default properties names and values.
WebformElementBase::$elementInfo protected property A element info manager.
WebformElementBase::$elementManager protected property The webform element manager.
WebformElementBase::$entityTypeManager protected property The entity type manager.
WebformElementBase::$librariesManager protected property The webform libraries manager.
WebformElementBase::$logger protected property A logger instance.
WebformElementBase::$submissionStorage protected property The webform submission storage.
WebformElementBase::$tokenManager protected property The token manager.
WebformElementBase::$translatableProperties protected property An indexed array of an element's translated properties.
WebformElementBase::alterForm public function Alter an element's associated form. Overrides WebformElementInterface::alterForm 1
WebformElementBase::build protected function Build an element as text or HTML. 4
WebformElementBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 3
WebformElementBase::buildConfigurationFormTabs protected function Build configuration form tabs. 1
WebformElementBase::buildExportHeader public function Build an element's export header. Overrides WebformElementInterface::buildExportHeader 4
WebformElementBase::buildExportOptionsForm public function Get an element's export options webform. Overrides WebformElementInterface::buildExportOptionsForm 4
WebformElementBase::buildExportRecord public function Build an element's export row. Overrides WebformElementInterface::buildExportRecord 7
WebformElementBase::buildHtml public function Build an element as HTML element. Overrides WebformElementInterface::buildHtml 2
WebformElementBase::buildText public function Build an element as text element. Overrides WebformElementInterface::buildText 1
WebformElementBase::checkAccessRule protected function Checks an access rule against a user account's roles and id.
WebformElementBase::checkAccessRules public function Check element access (rules). Overrides WebformElementInterface::checkAccessRules
WebformElementBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
WebformElementBase::defineDefaultBaseProperties protected function Define default base properties used by all elements. 4
WebformElementBase::defineDefaultMultipleProperties protected function Define default multiple properties used by most elements. 1
WebformElementBase::defineDefaultProperties protected function Define an element's default properties. 34
WebformElementBase::defineTranslatableProperties protected function Define an element's translatable properties. 15
WebformElementBase::displayDisabledWarning public function Display element disabled warning. Overrides WebformElementInterface::displayDisabledWarning 1
WebformElementBase::finalize public function Finalize an element to be rendered within a webform. Overrides WebformElementInterface::finalize 1
WebformElementBase::format protected function Format an element's value as HTML or plain text. 2
WebformElementBase::formatCustomItem protected function Format an element's item using custom HTML or plain text. 2
WebformElementBase::formatCustomItems protected function Format an element's items using custom HTML or plain text.
WebformElementBase::formatHtml public function Format an element's value as HTML. Overrides WebformElementInterface::formatHtml 2
WebformElementBase::formatHtmlItems protected function Format an element's items as HTML. 2
WebformElementBase::formatTableColumn public function Format an element's table column value. Overrides WebformElementInterface::formatTableColumn 4
WebformElementBase::formatText public function Format an element's value as plain text. Overrides WebformElementInterface::formatText 2
WebformElementBase::formatTextItem protected function Format an element's value as text. 19
WebformElementBase::formatTextItems protected function Format an element's items as text. 2
WebformElementBase::getAdminLabel public function Get an element's admin label (#admin_title, #title or #webform_key). Overrides WebformElementInterface::getAdminLabel
WebformElementBase::getConfigurationFormProperties public function Get an associative array of element properties from configuration webform. Overrides WebformElementInterface::getConfigurationFormProperties 3
WebformElementBase::getConfigurationFormProperty protected function Get configuration property value. 1
WebformElementBase::getDefaultBaseProperties Deprecated protected function Get default base properties used by all elements.
WebformElementBase::getDefaultKey public function Gets the element's default key. Overrides WebformElementInterface::getDefaultKey 1
WebformElementBase::getDefaultMultipleProperties Deprecated protected function Get default multiple properties used by most elements.
WebformElementBase::getDefaultProperty public function Get an element's default property value. Overrides WebformElementInterface::getDefaultProperty
WebformElementBase::getElementInfoDefaultProperty protected function Get a render element's default property.
WebformElementBase::getElementProperty public function Get an element's property value. Overrides WebformElementInterface::getElementProperty
WebformElementBase::getElementSelectorInputsOptions protected function Get an element's (sub)inputs selectors as options. 9
WebformElementBase::getElementSelectorInputValue public function Get an element's (sub)input selector value. Overrides WebformElementInterface::getElementSelectorInputValue 5
WebformElementBase::getElementSelectorOptions public function Get an element's selectors as options. Overrides WebformElementInterface::getElementSelectorOptions 11
WebformElementBase::getElementSelectorSourceValues public function Get an element's selectors source values. Overrides WebformElementInterface::getElementSelectorSourceValues 3
WebformElementBase::getElementStateOptions public function Get an element's supported states as options. Overrides WebformElementInterface::getElementStateOptions 1
WebformElementBase::getExportDefaultOptions public function Get an element's default export options. Overrides WebformElementInterface::getExportDefaultOptions 5
WebformElementBase::getFormElementClassDefinition public function Get the Webform element's form element class definition. Overrides WebformElementInterface::getFormElementClassDefinition
WebformElementBase::getFormInlineContainer protected function Get form--inline container which is used for side-by-side element layout.
WebformElementBase::getInfo public function Retrieves the default properties for the defined element type. Overrides WebformElementInterface::getInfo
WebformElementBase::getItemDefaultFormat public function Get an element's default single value format name. Overrides WebformElementInterface::getItemDefaultFormat 23
WebformElementBase::getItemFormat public function Get element's single value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface::getItemFormat 1
WebformElementBase::getItemFormats public function Get an element's available single value formats. Overrides WebformElementInterface::getItemFormats 24
WebformElementBase::getItemsDefaultFormat public function Get an element's default multiple value format name. Overrides WebformElementInterface::getItemsDefaultFormat 2
WebformElementBase::getItemsFormat public function Get element's multiple value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface::getItemsFormat
WebformElementBase::getItemsFormats public function Get an element's available multiple value formats. Overrides WebformElementInterface::getItemsFormats 2
WebformElementBase::getKey public function Get an element's key/name. Overrides WebformElementInterface::getKey
WebformElementBase::getLabel public function Get an element's label (#title or #webform_key). Overrides WebformElementInterface::getLabel
WebformElementBase::getOffCanvasWidth public function Get configuration form's off-canvas width. Overrides WebformElementInterface::getOffCanvasWidth 1
WebformElementBase::getPluginApiLink public function Get link to element's API documentation. Overrides WebformElementInterface::getPluginApiLink
WebformElementBase::getPluginApiUrl public function Get the URL for the element's API documentation. Overrides WebformElementInterface::getPluginApiUrl
WebformElementBase::getPluginCategory public function Gets the category of the plugin instance. Overrides WebformElementInterface::getPluginCategory
WebformElementBase::getPluginDescription public function Gets the description of the plugin instance. Overrides WebformElementInterface::getPluginDescription
WebformElementBase::getPluginLabel public function Gets the label of the plugin instance. Overrides WebformElementInterface::getPluginLabel 3
WebformElementBase::getRawValue public function Get an element's submission raw value. Overrides WebformElementInterface::getRawValue
WebformElementBase::getRelatedTypes public function Get related element types. Overrides WebformElementInterface::getRelatedTypes 6
WebformElementBase::getTableColumn public function Get element's table column(s) settings. Overrides WebformElementInterface::getTableColumn 4
WebformElementBase::getTestValues public function Get test values for an element. Overrides WebformElementInterface::getTestValues 23
WebformElementBase::getTranslatableProperties public function Get translatable properties. Overrides WebformElementInterface::getTranslatableProperties
WebformElementBase::getTypeName public function Gets the type name (aka id) of the plugin instance with the 'webform_' prefix. Overrides WebformElementInterface::getTypeName
WebformElementBase::getValue public function Get an element's submission value. Overrides WebformElementInterface::getValue 1
WebformElementBase::hasCompositeFormElementWrapper protected function Determine if the element has a composite field wrapper.
WebformElementBase::hasManagedFiles public function Determine if the element is or includes a managed_file upload element. Overrides WebformElementInterface::hasManagedFiles 2
WebformElementBase::hasMultipleValues public function Checks if the element value has multiple values. Overrides WebformElementInterface::hasMultipleValues 6
WebformElementBase::hasMultipleWrapper public function Checks if the element uses the 'webform_multiple' element. Overrides WebformElementInterface::hasMultipleWrapper 3
WebformElementBase::hasProperty public function Determine if the element supports a specified property. Overrides WebformElementInterface::hasProperty
WebformElementBase::hasValue public function Determine if an element's has a submission value. Overrides WebformElementInterface::hasValue 2
WebformElementBase::hasWrapper public function Checks if the element has a wrapper. Overrides WebformElementInterface::hasWrapper
WebformElementBase::hiddenElementAfterBuild public static function Webform element #after_build callback.
WebformElementBase::initialize public function Initialize an element to be displayed, rendered, or exported. Overrides WebformElementInterface::initialize 8
WebformElementBase::isComposite public function Checks if the element is a composite element. Overrides WebformElementInterface::isComposite
WebformElementBase::isContainer public function Checks if the element is a container that can contain elements. Overrides WebformElementInterface::isContainer 9
WebformElementBase::isDisabled public function Checks if the element is disabled. Overrides WebformElementInterface::isDisabled
WebformElementBase::isEmptyExcluded public function Checks if an empty element is excluded. Overrides WebformElementInterface::isEmptyExcluded 1
WebformElementBase::isEnabled public function Checks if the element is enabled. Overrides WebformElementInterface::isEnabled 1
WebformElementBase::isExcluded public function Checks if the element is excluded via webform.settings. Overrides WebformElementInterface::isExcluded
WebformElementBase::isHidden public function Checks if the element is hidden. Overrides WebformElementInterface::isHidden 2
WebformElementBase::isInput public function Checks if the element carries a value. Overrides WebformElementInterface::isInput 11
WebformElementBase::isMultiline public function Checks if the element value could contain multiple lines. Overrides WebformElementInterface::isMultiline 2
WebformElementBase::isRoot public function Checks if the element is a root element. Overrides WebformElementInterface::isRoot 3
WebformElementBase::postCreate public function Acts on a webform submission element after it is created. Overrides WebformElementInterface::postCreate 1
WebformElementBase::postDelete public function Delete any additional value associated with an element. Overrides WebformElementInterface::postDelete 5
WebformElementBase::postLoad public function Acts on loaded webform submission. Overrides WebformElementInterface::postLoad 1
WebformElementBase::postSave public function Acts on a saved webform submission element before the insert or update hook is invoked. Overrides WebformElementInterface::postSave 5
WebformElementBase::preCreate public function Changes the values of an entity before it is created. Overrides WebformElementInterface::preCreate 1
WebformElementBase::preDelete public function 1
WebformElementBase::prefixExportHeader protected function Prefix an element's export header.
WebformElementBase::prepareCompositeFormElement protected function Replace Core's composite #pre_render with Webform's composite #pre_render.
WebformElementBase::prepareElementPreRenderCallbacks protected function Prepare an element's pre render callbacks. 3
WebformElementBase::prepareElementValidateCallbacks protected function Prepare an element's validation callbacks. 8
WebformElementBase::prepareMultipleWrapper protected function Set multiple element wrapper. 1
WebformElementBase::prepareWrapper protected function Set an elements #states and flexbox wrapper. 1
WebformElementBase::preRenderFixFlexboxWrapper public static function Fix flexbox wrapper.
WebformElementBase::preRenderFixStatesWrapper public static function Fix state wrapper.
WebformElementBase::preSave public function Acts on a webform submission element before the presave hook is invoked. Overrides WebformElementInterface::preSave 4
WebformElementBase::preview public function Generate a renderable preview of the element. Overrides WebformElementInterface::preview 37
WebformElementBase::replaceTokens public function Replace tokens for all element properties. Overrides WebformElementInterface::replaceTokens
WebformElementBase::setConfigurationFormDefaultValue protected function Set an element's configuration webform element default value. 2
WebformElementBase::setConfigurationFormDefaultValueRecursive protected function Set configuration webform default values recursively.
WebformElementBase::setDefaultValue public function Set an element's default value using saved data. Overrides WebformElementInterface::setDefaultValue 7
WebformElementBase::setElementDefaultCallback protected function Set element's default callback.
WebformElementBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
WebformElementBase::supportsMultipleValues public function Checks if the element supports multiple values. Overrides WebformElementInterface::supportsMultipleValues 8
WebformElementBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 1
WebformElementBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 6
WebformElementBase::validateMinlength public static function Form API callback. Validate element #minlength value.
WebformElementBase::validateMultiple public static function Form API callback. Validate element #multiple > 1 value.
WebformElementBase::validateUnique public static function Form API callback. Validate element #unique value.
WebformElementBase::validateUniqueMultiple public static function Form API callback. Validate element #unique multiple values.
WebformElementBase::__construct public function Constructs a WebformElementBase object. Overrides PluginBase::__construct 2
WebformEntityInjectionTrait::$webform protected property The webform.
WebformEntityInjectionTrait::$webformSubmission protected property The webform submission.
WebformEntityInjectionTrait::getWebform public function Get the webform that this handler is attached to.
WebformEntityInjectionTrait::getWebformSubmission public function Set webform and webform submission entity.
WebformEntityInjectionTrait::resetEntities public function Reset webform and webform submission entity.
WebformEntityInjectionTrait::setEntities public function
WebformEntityInjectionTrait::setWebform public function Set the webform that this is handler is attached to.
WebformEntityInjectionTrait::setWebformSubmission public function Get the webform submission that this handler is handling.