class ContactEmails in Contact Emails 8

Class ContactEmails.

Provides a number of helper functions to assist in retrieving contact emails and information about contact emails for a specific form.

@package Drupal\contact_emails

Hierarchy

• class \Drupal\contact_emails\ContactEmails

1 file declares its use of ContactEmails

ContactEmailForm.php in src/Form/ContactEmailForm.php

1 string reference to 'ContactEmails'

contact_emails.services.yml in ./contact_emails.services.yml

contact_emails.services.yml

1 service uses ContactEmails

contact_emails.helper in ./contact_emails.services.yml

Drupal\contact_emails\ContactEmails

File

src/ContactEmails.php, line 18

Namespace

Drupal\contact_emails

class ContactEmails {

  /**
   * Drupal\Core\Cache\CacheBackendInterface definition.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cache;

  /**
   * Drupal\Core\Entity\EntityFieldManagerInterface definition.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * Drupal\Core\Entity\EntityTypeBundleInfoInterface definition.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * Constructor.
   */
  public function __construct(CacheBackendInterface $cache, EntityFieldManagerInterface $entity_field_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info) {
    $this->cache = $cache;
    $this->entityFieldManager = $entity_field_manager;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
  }

  /**
   * Get a list of contact forms that have emails.
   *
   * @param bool $from_cache
   *   Whether to load from the cache (if available).
   *
   * @return array
   *   An array of contact form ids that have at least 1 email.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getContactFormsWithEmails($from_cache = TRUE) {
    $cid = 'contact_emails:contact_forms_with_emails';

    // Load a list of the forms with at least one contact_emails email.
    if ($from_cache && ($cache = $this->cache
      ->get($cid))) {
      $contact_forms = $cache->data;
    }
    else {

      /** @var \Drupal\contact_emails\ContactEmailStorageInterface $storage */
      $storage = \Drupal::entityTypeManager()
        ->getStorage('contact_email');
      $emails = $storage
        ->loadMultiple();
      $contact_forms = [];

      /** @var \Drupal\contact_emails\Entity\ContactEmailInterface $email */
      foreach ($emails as $email) {
        $formId = $email
          ->get('contact_form')->target_id;
        if (array_search($formId, $contact_forms) === FALSE) {
          $contact_forms[] = $formId;
        }
      }
      $this->cache
        ->set($cid, $contact_forms);
    }
    return $contact_forms;
  }

  /**
   * Rebuild any caches.
   *
   * This should be called whenever a contact email is created, updated, or
   * deleted.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function rebuildCache() {

    // Force reload of the list of contact forms with emails.
    $this
      ->getContactFormsWithEmails(FALSE);
  }

  /**
   * Get contact form fields by type.
   *
   * @param string $contact_form_id
   *   The ID of the contact form.
   * @param string $field_type
   *   The type of field to get.
   *
   * @return mixed
   *   The array of email field keys.
   */
  public function getContactFormFields($contact_form_id, $field_type) {
    $available_fields = [];

    // Get all field entities attached to the particular contact form.
    $fields = array_filter($this->entityFieldManager
      ->getFieldDefinitions('contact_message', $contact_form_id), function ($field_definition) {
      return $field_definition instanceof FieldConfigInterface;
    });
    if ($fields) {

      /** @var \Drupal\Core\Field\FieldDefinitionInterface $field */
      foreach ($fields as $field) {
        $type = $field
          ->getType();
        if ($type == $field_type) {
          switch ($type) {
            case 'email':
              $available_fields = $this
                ->getEmailField($available_fields, $field);
              break;
            case 'entity_reference':
              $available_fields = $this
                ->getEntityReferenceEmailFields($available_fields, $field);
              break;
          }
        }
      }
    }
    return $available_fields;
  }

  /**
   * Get contact form fields by type.
   *
   * @param array $available_fields
   *   The already added available fields.
   * @param object $field
   *   The field.
   *
   * @return array
   *   The new array of available fields.
   */
  protected function getEmailField(array $available_fields, $field) {
    $available_fields[$field
      ->getName()] = $field
      ->getLabel();
    return $available_fields;
  }

  /**
   * Get contact form fields by type.
   *
   * @param array $available_fields
   *   The already added available fields.
   * @param object $field
   *   The field.
   *
   * @return array
   *   The new array of available fields.
   */
  protected function getEntityReferenceEmailFields(array $available_fields, $field) {
    $settings = $field
      ->getSettings();

    // Get all bundles for given target type and filter by selected target
    // bundles.
    $bundle_info = $this->entityTypeBundleInfo
      ->getBundleInfo($settings['target_type']);
    if (!empty($settings['handler_settings']['target_bundles'])) {
      $bundle_info = array_intersect_key($bundle_info, $settings['handler_settings']['target_bundles']);
    }
    if (!empty($bundle_info)) {
      foreach ($bundle_info as $bundle_name => $bundle) {
        $bundle_fields = array_filter($this->entityFieldManager
          ->getFieldDefinitions($settings['target_type'], $bundle_name), function ($field_definition) {
          return $field_definition instanceof FieldConfigInterface;
        });
        if ($bundle_fields) {

          /** @var \Drupal\Core\Field\FieldDefinitionInterface $bundle_field */
          foreach ($bundle_fields as $bundle_field) {
            $type = $bundle_field
              ->getType();

            // Allow field type email.
            if ($type == 'email') {
              $available_fields[$field
                ->getName() . '.' . $settings['target_type'] . '.' . $bundle_name . '.' . $bundle_field
                ->getName()] = $bundle['label'] . ': ' . $bundle_field
                ->getLabel() . ' (' . $bundle_field
                ->getName() . ')';
            }
          }
        }
      }
    }
    return $available_fields;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContactEmails::$cache	protected	property	Drupal\Core\Cache\CacheBackendInterface definition.
ContactEmails::$entityFieldManager	protected	property	Drupal\Core\Entity\EntityFieldManagerInterface definition.
ContactEmails::$entityTypeBundleInfo	protected	property	Drupal\Core\Entity\EntityTypeBundleInfoInterface definition.
ContactEmails::getContactFormFields	public	function	Get contact form fields by type.
ContactEmails::getContactFormsWithEmails	protected	function	Get a list of contact forms that have emails.
ContactEmails::getEmailField	protected	function	Get contact form fields by type.
ContactEmails::getEntityReferenceEmailFields	protected	function	Get contact form fields by type.
ContactEmails::rebuildCache	public	function	Rebuild any caches.
ContactEmails::__construct	public	function	Constructor.