class ContactPopupBlock in Contact Form Popup 8

Provides a 'ContactPopupBlock' block.

Plugin annotation


@Block(
 id = "contact_popup_block",
 admin_label = @Translation("Contact popup block"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\contact_poup\Plugin\Block\ContactPopupBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of ContactPopupBlock

File

src/Plugin/Block/ContactPopupBlock.php, line 24

Namespace

Drupal\contact_poup\Plugin\Block

View source

class ContactPopupBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * Drupal\Core\Entity\EntityTypeManager definition.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Drupal\Core\Routing\RouteMatchInterface definition.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Construct.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param string $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity_type.manager service.
   *   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current_route_match service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, RouteMatchInterface $route_match) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  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_route_match'));
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    $contact_form = $this
      ->getContactForm();

    // Deny access when the configured contact form has been deleted.
    if (empty($contact_form)) {
      return AccessResult::forbidden();
    }
    if ($contact_form
      ->id() === 'personal') {

      /** @var \Drupal\user\Entity\User $user */
      $user = $this->routeMatch
        ->getParameter('user');

      // Deny access to the contact form link if we are not on a user related page
      // or we have no access to that page.
      if (empty($user)) {
        return AccessResult::forbidden();
      }

      // Do not display the link if the user is on his profile page.
      if ($user
        ->id() == $account
        ->id()) {
        return AccessResult::forbidden();
      }
      return AccessResult::allowedIfHasPermission($account, 'access user contact forms');
    }

    // Access to other contact forms is equal to the permission of the
    // entity.contact_form.canonical route. Once https://www.drupal.org/node/2724503
    // has landed, see if we can support per form access permission.
    return $contact_form
      ->access('view', $account, TRUE);
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $form['contact_form'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Contact form'),
      '#description' => $this
        ->t('Select the contact form to use.'),
      '#options' => $this
        ->listContactForms(),
      '#default_value' => isset($config['contact_form']) ? $config['contact_form'] : '',
    );
    $form['link_title'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('The link title'),
      '#description' => $this
        ->t('The title to use for the link. Leave empty for using the contact form label.'),
      '#default_value' => isset($config['link_title']) ? $config['link_title'] : '',
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $config = $this
      ->getConfiguration();
    if (empty($config['contact_form'])) {
      return $build;
    }
    $storage_contact_form = $this->entityTypeManager
      ->getStorage('contact_form');
    $contact_form = $storage_contact_form
      ->load($config['contact_form']);
    if (empty($contact_form)) {
      return $build;
    }
    $id = $contact_form
      ->id();
    $options = array(
      'attributes' => array(
        'class' => array(
          'use-ajax',
          'contact-form',
        ),
        'data-dialog-type' => 'modal',
      ),
    );

    // Personnal contact form.
    if ($id === 'personal') {
      if ($user = $this->routeMatch
        ->getParameter('user')) {
        $contact_form_url = Url::fromRoute('entity.user.contact_form', [
          'user' => $user
            ->id(),
        ], $options);

        // Cache vary by url if we have a personal contact form.
        $build['#cache']['contexts'][] = 'url';
      }
      else {
        return $build;
      }
    }
    else {
      $contact_form_url = $contact_form
        ->toUrl('canonical', $options);
    }
    $contact_form_title = $contact_form
      ->label();
    $title = empty($config['link_title']) ? $contact_form_title : $config['link_title'];
    $link = Link::fromTextAndUrl($title, $contact_form_url);
    $build['contact_form'] = [
      '#theme' => 'contact_popup_block',
      '#link' => $link,
      '#contact_form' => $contact_form,
    ];
    $build['contact_form']['#attached']['library'][] = 'core/drupal.dialog.ajax';
    $build['#cache']['contexts'][] = 'user.permissions';
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['contact_form'] = !$form_state
      ->isValueEmpty('contact_form') ? $form_state
      ->getValue('contact_form') : '';
    $this->configuration['link_title'] = !$form_state
      ->isValueEmpty('link_title') ? $form_state
      ->getValue('link_title') : '';
  }

  /**
   * @return array $options
   *   An array of available contact forms.
   */
  private function listContactForms() {
    $options = [];
    $storage_contact_form = $this->entityTypeManager
      ->getStorage('contact_form');
    $list_contact_form = $storage_contact_form
      ->getQuery()
      ->execute();
    foreach ($list_contact_form as $contact_form) {

      /** @var \Drupal\contact\Entity\ContactForm $contact */
      $contact = $storage_contact_form
        ->load($contact_form);
      $options[$contact
        ->id()] = $contact
        ->label();
    }
    return $options;
  }

  /**
   * Loads the contact form entity.
   *
   * @return \Drupal\contact\Entity\ContactForm|null
   *   The contact form configuration entity. NULL if the entity does not exist.
   */
  protected function getContactForm() {
    if (!isset($this->contactForm)) {
      if (isset($this->configuration['contact_form'])) {
        $this->contactForm = $this->entityTypeManager
          ->getStorage('contact_form')
          ->load($this->configuration['contact_form']);
      }
    }
    return $this->contactForm;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.	2
BlockPluginTrait::calculateDependencies	public	function
BlockPluginTrait::defaultConfiguration	public	function		19
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
ContactPopupBlock::$entityTypeManager	protected	property	Drupal\Core\Entity\EntityTypeManager definition.
ContactPopupBlock::$routeMatch	protected	property	Drupal\Core\Routing\RouteMatchInterface definition.
ContactPopupBlock::blockAccess	protected	function	Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
ContactPopupBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
ContactPopupBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
ContactPopupBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
ContactPopupBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ContactPopupBlock::getContactForm	protected	function	Loads the contact form entity.
ContactPopupBlock::listContactForms	private	function
ContactPopupBlock::__construct	public	function	Construct. 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.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
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
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.
PluginWithFormsTrait::getFormClass	public	function
PluginWithFormsTrait::hasFormClass	public	function
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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class ContactPopupBlock in Contact Form Popup 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation