You are here

Home » API reference » Form Block 2.0.x » ContactFormBlock.php

class ContactFormBlock in Form Block 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/Block/ContactFormBlock.php \Drupal\formblock\Plugin\Block\ContactFormBlock

Provides a block for contact form.

@Block( id = "formblock_contact", admin_label = @Translation("Site-wide contact form"), provider = "contact", category = @Translation("Forms") )

Note that we set module to contact so that blocks will be disabled correctly when the module is disabled.

Hierarchy

Expanded class hierarchy of ContactFormBlock

File

src/Plugin/Block/ContactFormBlock.php, line 30

Namespace

Drupal\formblock\Plugin\Block
View source 
class ContactFormBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface.
   */
  protected $entityTypeManager;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface.
   */
  protected $currentUser;

  /**
   * The entity form builder.
   *
   * @var \Drupal\Core\Entity\EntityFormBuilderInterface.
   */
  protected $entityFormBuilder;

  /**
   * The config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface.
   */
  protected $configFactory;

  /**
   * The flood service.
   *
   * @var \Drupal\Core\Flood\FloodInterface.
   */
  protected $flood;

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatter.
   */
  protected $dateFormatter;

  /**
   * Constructs a new ContactFormBlock plugin.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity manager.
   * @param \Drupal\Core\Session\AccountInterface $currentUser
   *   The current user.
   * @param \Drupal\Core\Entity\EntityFormBuilderInterface $entityFormBuilder
   *   The entity form builder interface.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The config factory.
   * @param \Drupal\Core\Flood\FloodInterface $flood
   *   The flood service.
   * @param \Drupal\Core\DateTime\DateFormatter $dateFormatter
   *   The date formatter service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entityTypeManager, AccountInterface $currentUser, EntityFormBuilderInterface $entityFormBuilder, ConfigFactoryInterface $configFactory, FloodInterface $flood, DateFormatter $dateFormatter) {
    $this->entityTypeManager = $entityTypeManager;
    $this->currentUser = $currentUser;
    $this->entityFormBuilder = $entityFormBuilder;
    $this->configFactory = $configFactory;
    $this->flood = $flood;
    $this->dateFormatter = $dateFormatter;

    // We have to do this after our injections since the parent constructor
    // calls defaultConfiguration() which depends on the configFactory service.
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * Creates an instance of the plugin.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The container to pull out services used in the plugin.
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   *
   * @return static
   *   Returns an instance of this plugin.
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('current_user'), $container
      ->get('entity.form_builder'), $container
      ->get('config.factory'), $container
      ->get('flood'), $container
      ->get('date.formatter'));
  }

  /**
   * Overrides \Drupal\block\BlockBase::settings().
   */
  public function defaultConfiguration() {
    return [
      'contact_form' => $this->configFactory
        ->get('contact.settings')
        ->get('default_form'),
    ];
  }

  /**
   * Overrides \Drupal\block\BlockBase::blockForm().
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $categories = $this->entityTypeManager
      ->getStorage('contact_form')
      ->loadMultiple();
    $options = [];
    foreach ($categories as $category) {
      $options[$category
        ->id()] = $category
        ->label();
    }
    $form['formblock_contact_form'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Category'),
      '#default_value' => $this->configuration['contact_form'],
      '#description' => $this
        ->t('Select the category to show.'),
      '#options' => $options,
      '#required' => TRUE,
    ];
    return $form;
  }

  /**
   * Overrides \Drupal\block\BlockBase::blockSubmit().
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['contact_form'] = $form_state
      ->getValue('formblock_contact_form');
  }

  /**
   * Implements \Drupal\block\BlockBase::build().
   */
  public function build() {
    $build = [];

    // Check if flood control has been activated for sending emails.
    if (!$this->currentUser
      ->hasPermission('administer contact forms') && ($message = $this
      ->floodControl())) {
      $build['message'] = [
        '#markup' => $message,
      ];
      return $build;
    }
    $message = $this->entityTypeManager
      ->getStorage('contact_message')
      ->create([
      'contact_form' => $this
        ->getContactForm()
        ->id(),
    ]);
    $build['form'] = $this->entityFormBuilder
      ->getForm($message);
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function blockAccess(AccountInterface $account) {
    return AccessResult::allowedIf($this
      ->getContactForm()
      ->access('view', $account) && $account
      ->hasPermission('access site-wide contact form'))
      ->cachePerPermissions()
      ->addCacheTags($this
      ->getContactForm()
      ->getCacheTags())
      ->addCacheTags($this->configFactory
      ->get('contact.settings')
      ->getCacheTags());
  }

  /**
   * Returns the current status of flood control.
   *
   * @return bool|string
   *   False if flood control should not be enabled or an error message if
   *   flood control is enabled.
   */
  protected function floodControl() {
    $limit = $this->configFactory
      ->get('contact.settings')
      ->get('flood.limit');
    $interval = $this->configFactory
      ->get('contact.settings')
      ->get('flood.interval');
    if (!$this->flood
      ->isAllowed('contact', $limit, $interval)) {
      return $this
        ->t('You cannot send more than %limit messages in @interval. Try again later.', [
        '%limit' => $limit,
        '@interval' => $this->dateFormatter
          ->formatInterval($interval),
      ]);
    }
    return FALSE;
  }

  /**
   * Return the contact form entity (type of contact form).
   *
   * @return \Drupal\contact\Entity\ContactForm
   *   The contact form type.
   */
  private function getContactForm() {
    return $this->entityTypeManager
      ->getStorage('contact_form')
      ->load($this->configuration['contact_form']);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. Aliased as: traitBuildConfigurationForm
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
ContactFormBlock::$configFactory protected property The config factory service.
ContactFormBlock::$currentUser protected property The current user.
ContactFormBlock::$dateFormatter protected property The date formatter service.
ContactFormBlock::$entityFormBuilder protected property The entity form builder.
ContactFormBlock::$entityTypeManager protected property The entity manager.
ContactFormBlock::$flood protected property The flood service.
ContactFormBlock::blockAccess public function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
ContactFormBlock::blockForm public function Overrides \Drupal\block\BlockBase::blockForm(). Overrides BlockPluginTrait::blockForm
ContactFormBlock::blockSubmit public function Overrides \Drupal\block\BlockBase::blockSubmit(). Overrides BlockPluginTrait::blockSubmit
ContactFormBlock::build public function Implements \Drupal\block\BlockBase::build(). Overrides BlockPluginInterface::build
ContactFormBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ContactFormBlock::defaultConfiguration public function Overrides \Drupal\block\BlockBase::settings(). Overrides BlockPluginTrait::defaultConfiguration
ContactFormBlock::floodControl protected function Returns the current status of flood control.
ContactFormBlock::getContactForm private function Return the contact form entity (type of contact form).
ContactFormBlock::__construct public function Constructs a new ContactFormBlock plugin. Overrides BlockPluginTrait::__construct
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract protected function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.