You are here

Home » API reference » Contact Emails 8 » ContactEmailListBuilder.php

class ContactEmailListBuilder in Contact Emails 8

Defines the list builder for tax services.

Hierarchy

Expanded class hierarchy of ContactEmailListBuilder

File

src/ContactEmailListBuilder.php, line 13

Namespace

Drupal\contact_emails
View source 
class ContactEmailListBuilder extends EntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['id'] = $this
      ->t('ID');
    $header['contact_form'] = $this
      ->t('Contact form');
    $header['subject'] = $this
      ->t('Subject');
    $header['recipients'] = $this
      ->t('Recipients');
    $header['status'] = $this
      ->t('Status');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /* @var $entity \Drupal\contact_emails\Entity\ContactEmailInterface */

    /** @var \Drupal\contact\ContactFormInterface $contact_form */
    $contact_form = $entity
      ->get('contact_form')->entity;
    $row['id'] = $entity
      ->id();
    $row['contact_form'] = $contact_form ? $contact_form
      ->label() : '';
    $row['subject'] = $entity
      ->label();
    $row['recipients'] = $this
      ->getRecipients($entity);
    $row['status'] = $entity
      ->get('status')->value ? $this
      ->t('Enabled') : $this
      ->t('Disabled');
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();

    // If this is a list for a particular contact form, set a useful empty
    // message.
    if ($contact_form = \Drupal::routeMatch()
      ->getParameter('contact_form')) {
      $build['table']['#empty'] = $this
        ->t('The default contact emails are being used. <a href=":url_edit">Modify the default emails here</a> or <a href=":url_create">override them with new contact emails</a>.', [
        ':url_edit' => Url::fromRoute('entity.contact_form.edit_form', [
          'contact_form' => $contact_form,
        ])
          ->toString(),
        ':url_create' => Url::fromRoute('entity.contact_email.add_form', [
          'contact_form' => $contact_form,
        ])
          ->toString(),
      ]);
    }
    return $build;
  }

  /**
   * Gets the recipient text to display.
   *
   * @param \Drupal\contact_emails\Entity\ContactEmailInterface $entity
   *   The contact email entity.
   *
   * @return string
   *   The recipients text.
   */
  protected function getRecipients(ContactEmailInterface $entity) {
    switch ($entity
      ->get('recipient_type')->value) {
      case 'default':
        $value = $this
          ->t('[The site email address]');
        break;
      case 'submitter':
        $value = $this
          ->t('[The submitter of the form]');
        break;
      case 'field':
        $value = $this
          ->recipientFieldValue($entity, 'recipient_field', 'email');
        break;
      case 'reference':
        $value = $this
          ->recipientFieldValue($entity, 'recipient_reference', 'entity_reference');
        break;
      case 'manual':
      default:
        $recipients = [];
        foreach ($entity
          ->get('recipients')
          ->getValue() as $value) {
          $recipients[] = $value['value'];
        }
        $value = implode(', ', $recipients);
        break;
    }
    return $value;
  }

  /**
   * Get the description of recipient field value.
   *
   * @param \Drupal\contact_emails\Entity\ContactEmailInterface $entity
   *   The email.
   * @param string $fieldName
   *   The field name.
   * @param string $fieldType
   *   The field type.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The description of the field.
   */
  protected function recipientFieldValue(ContactEmailInterface $entity, $fieldName, $fieldType) {

    /** @var \Drupal\contact_emails\ContactEmails $contactEmails */
    $contactEmails = \Drupal::service('contact_emails.helper');
    $contactFormId = $entity
      ->get('contact_form')->target_id;
    $fields = $contactEmails
      ->getContactFormFields($contactFormId, $fieldType);
    $field_label = $entity
      ->hasField($fieldName) && !$entity
      ->get($fieldName)
      ->isEmpty() && isset($fields[$entity
      ->get($fieldName)->value]) ? $entity
      ->get($fieldName)->value : $this
      ->t('*Unknown or deleted field*');
    return $this
      ->t('[The value of the "@field" field]', [
      '@field' => $field_label,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getEntityIds() {
    $query = $this
      ->getStorage()
      ->getQuery();

    // Maybe filter by the selected contact form.
    if ($contact_form_id = \Drupal::routeMatch()
      ->getParameter('contact_form')) {
      $query
        ->condition('contact_form', $contact_form_id);
    }

    // Order by the id.
    $query
      ->sort($this->entityType
      ->getKey('id'));

    // Only add the pager if a limit is specified.
    if ($this->limit) {
      $query
        ->pager($this->limit);
    }
    return $query
      ->execute();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContactEmailListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
ContactEmailListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
ContactEmailListBuilder::getEntityIds public function Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder::getEntityIds
ContactEmailListBuilder::getRecipients protected function Gets the recipient text to display.
ContactEmailListBuilder::recipientFieldValue protected function Get the description of recipient field value.
ContactEmailListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities. 3
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance 20
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getDefaultOperations protected function Gets this list's default operations. 2
EntityListBuilder::getLabel Deprecated protected function Gets the label of an entity.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 2
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
EntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load 4
EntityListBuilder::__construct public function Constructs a new EntityListBuilder object. 16
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.