You are here

Home » API reference » Views Contact Form 8 » ViewsContactFormEmailFormatter.php

class ViewsContactFormEmailFormatter in Views Contact Form 8

Plugin implementation of the 'ViewsContactFormEmailFormatter' formatter

Plugin annotation


@FieldFormatter(
  id = "views_contact_form_email_formatter",
  label = @Translation("Views Contact Form"),
  field_types = {
    "email"
  },
  settings = {
    "category" = "feedback",
    "category_recipients_include" = TRUE
  }
)

Hierarchy

Expanded class hierarchy of ViewsContactFormEmailFormatter

File

lib/Drupal/views_contact_form/Plugin/Field/FieldFormatter/ViewsContactFormEmailFormatter.php, line 29
Definition of Drupal\views_contact_form\Plugin\field\formatter\ViewsContactFormEmailFormatter.

Namespace

Drupal\views_contact_form\Plugin\Field\FieldFormatter
View source 
class ViewsContactFormEmailFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items) {
    module_load_include('pages.inc', 'contact');

    // Get the category entity from the configuration.
    $category = clone entity_load('contact_category', $this
      ->getSetting('category'));

    // Get value from the items and store it.
    $recipients = array();
    foreach ($items as $delta => $item) {
      $recipients[] = $item->value;
    }

    // If we want to send email also to the recipients from the category,
    // merge recipients from items and category.
    if ($this
      ->getSetting('category_recipients_include') == TRUE) {
      $recipients = array_merge($recipients, $category->recipients);
    }

    // Remove the doubles to avoid double mail.
    $recipients = array_unique($recipients);

    // Finally override the recipients on the category entity.
    $category
      ->set('recipients', $recipients);

    // Create the Message entity from the category.
    $message = entity_create('contact_message', array(
      'category' => $category
        ->id(),
    ));

    // Override the entity category in the Message.
    // So the recipients are also set.
    $message->category->entity = $category;

    // Get the form
    $form = \Drupal::entityManager()
      ->getForm($message);

    // Override the title
    $form['#title'] = String::checkPlain($category
      ->label());

    // Render the form and return the element.
    return array(
      0 => array(
        '#markup' => drupal_render($form),
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = array();
    $entity = entity_load('contact_category', $this
      ->getSetting('category'));
    $category_recipients_include = $this
      ->getSetting('category_recipients_include') == TRUE ? 'Yes' : 'No';
    $summary[] = t('Category: <a href="@url">@category</a>', array(
      '@url' => '/admin/structure/contact/manage/' . $entity->id,
      '@category' => $entity->label,
    ));
    $summary[] = t('Include category recipient(s): @category_recipients_include', array(
      '@category_recipients_include' => $category_recipients_include,
    ));
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, array &$form_state) {
    $categories = entity_load_multiple('contact_category');
    foreach ($categories as $id => $category) {
      $options[$id] = $category->label;
    }
    $form['category'] = array(
      '#title' => 'Choose the category',
      '#type' => 'select',
      '#options' => $options,
      '#default_value' => $this
        ->getSetting('category'),
    );
    $form['category_recipients_include'] = array(
      '#title' => 'Category recipient(s)',
      '#description' => 'Should we also send the mail to the default category recipient(s) ?',
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('category_recipients_include'),
    );
    $form['form_display'] = array(
      '#title' => 'Form display',
      '#markup' => 'You can customize the display of the form by editing the ' . 'category form display. Click on the corresponding link: ' . '<em>Manage form display</em> on ' . l('this page', 'admin/structure/contact', array(
        'attributes' => array(
          'target' => '_blank',
        ),
      )),
      '#type' => 'item',
    );
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.
ViewsContactFormEmailFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ViewsContactFormEmailFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ViewsContactFormEmailFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements