class ContactInfoBlock in Brainstorm profile 8

Provides an contact info block.

Plugin annotation


@Block(
  id = "adci_contact_info_block",
  admin_label = @Translation("ADCI Solutions contact information block"),
  category = @Translation("adci_contact_info")
)

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\adci_contact_info\Plugin\Block\ContactInfoBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of ContactInfoBlock

File

module/custom/adci_contact_info/src/Plugin/Block/ContactInfoBlock.php, line 23

Namespace

Drupal\adci_contact_info\Plugin\Block

View source

class ContactInfoBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The theme manager.
   *
   * @var \Drupal\Core\Theme\ThemeManagerInterface
   */
  protected $themeManager;

  /**
   * Creates a ContactInfoBlock instance.
   *
   * @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\Theme\ThemeManagerInterface $theme_manager
   *   The theme manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ThemeManagerInterface $theme_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->themeManager = $theme_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('theme.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function access(AccountInterface $account, $return_as_object = FALSE) {
    $permissions = [
      'administer site configuration',
    ];
    return AccessResult::allowedIfHasPermissions($account, $permissions, 'OR');
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $defaults = $this
      ->defaultConfiguration();
    $form['info'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Information'),
      '#open' => $defaults['info'] !== $config['info'],
    ];
    $form['info']['info'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Information'),
      '#default_value' => $config['info'],
      '#description' => $this
        ->t('You can use @version placeholder to print the version of Drupal core.'),
    ];
    $form['site'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Site link'),
      '#open' => $defaults['site'] !== $config['site'],
    ];
    $form['site']['link'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Link'),
      '#default_value' => $config['site']['link'],
      '#attributes' => [
        'id' => 'adci-info-block-site-link',
      ],
    ];
    $form['site']['text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Link text'),
      '#default_value' => $config['site']['text'],
      '#states' => [
        'disabled' => [
          ':input[id="adci-info-block-site-link"]' => [
            'empty' => TRUE,
          ],
        ],
      ],
    ];
    $form['site']['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Title'),
      '#default_value' => $config['site']['title'],
      '#states' => [
        'disabled' => [
          ':input[id="adci-info-block-site-link"]' => [
            'empty' => TRUE,
          ],
        ],
      ],
    ];
    $form['email'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Email'),
      '#open' => $defaults['email'] !== $config['email'],
    ];
    $form['email']['email'] = [
      '#type' => 'email',
      '#title' => $this
        ->t('Email'),
      '#default_value' => $config['email']['email'],
      '#attributes' => [
        'id' => 'adci-info-block-email-email',
      ],
    ];
    $form['email']['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Title'),
      '#default_value' => $config['email']['title'],
      '#states' => [
        'disabled' => [
          ':input[id="adci-info-block-email-email"]' => [
            'empty' => TRUE,
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this->configuration['info'] = $values['info']['info'];
    $this->configuration['site'] = $values['site'];
    $this->configuration['email'] = $values['email'];
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $config = $this
      ->getConfiguration();
    $version = \Drupal::VERSION;
    $system_manager = \Drupal::service('system.manager');
    $requirements = $system_manager
      ->listRequirements();
    $severities = [];
    foreach ($requirements as $requirement) {
      if (isset($requirement['severity'])) {
        if (isset($severities[$requirement['severity']])) {
          $severities[(int) $requirement['severity']]++;
          continue;
        }
        $severities += [
          (int) $requirement['severity'] => 1,
        ];
      }
    }
    $listItems = [];
    if (isset($severities[$system_manager::REQUIREMENT_ERROR])) {
      $count = $severities[$system_manager::REQUIREMENT_ERROR];
      $listItems[] = [
        '#title' => $this
          ->formatPlural($count, '1 error', '@count errors'),
        '#type' => 'link',
        '#url' => Url::fromRoute('system.status'),
      ];
    }
    if (isset($severities[$system_manager::REQUIREMENT_WARNING])) {
      $count = $severities[$system_manager::REQUIREMENT_WARNING];
      $listItems[] = [
        '#title' => $this
          ->formatPlural($count, '1 warning', '@count warnings'),
        '#type' => 'link',
        '#url' => Url::fromRoute('system.status'),
      ];
    }
    $build['info'] = [
      '#type' => 'html_tag',
      '#tag' => 'p',
      '#value' => str_replace('@version', $version, $config['info']),
    ];
    if (!empty($config['site']['link'])) {
      $build['site'] = [
        '#type' => 'container',
      ];
      $build['site']['title'] = [
        '#type' => 'label',
        '#title' => $config['site']['title'],
        "#title_display" => 'before',
      ];
      $build['site']['link'] = [
        '#title' => $config['site']['text'],
        '#type' => 'link',
        '#url' => Url::fromUri($config['site']['link']),
        '#attributes' => [
          'target' => '_blank',
          'rel' => 'noopener noreferrer',
        ],
      ];
    }
    if (!empty($config['email']['email'])) {
      $build['email'] = [
        '#type' => 'container',
      ];
      $build['email']['title'] = [
        '#type' => 'label',
        '#title' => $config['email']['title'],
        "#title_display" => 'before',
      ];
      $build['email']['email'] = [
        '#type' => 'html_tag',
        '#tag' => 'a',
        '#value' => $config['email']['email'],
        '#attributes' => [
          'href' => 'mailto:' . $config['email']['email'],
        ],
      ];
    }
    if (count($listItems) > 0) {
      $build['errors'] = [
        '#theme' => 'item_list',
        '#list_type' => 'ul',
        '#title' => $this
          ->t('Your website requires your attention:'),
        '#items' => $listItems,
      ];
    }
    $build['#attributes'] = [
      'class' => [
        'adci-contact-info',
      ],
    ];
    if ($this->themeManager
      ->getActiveTheme()
      ->getName() === 'adminimal_theme') {
      $build['#attributes']['class'][] = 'adci-contact-info-adminimal';
    }
    $build['#attached'] = [
      'library' => [
        'adci_contact_info/main',
      ],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'info' => 'The website is using Drupal @version',
      'site' => [
        'title' => 'Supported by',
        'text' => 'ADCI Solutions',
        'link' => 'https://www.adcisolutions.com/',
      ],
      'email' => [
        'title' => 'Email',
        'email' => 'hello@adcillc.com',
      ],
    ];
  }

}

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::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess	protected	function	Indicates whether the block should be shown.	16
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::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
ContactInfoBlock::$themeManager	protected	property	The theme manager.
ContactInfoBlock::access	public	function	Overrides BlockPluginTrait::access
ContactInfoBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
ContactInfoBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
ContactInfoBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
ContactInfoBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ContactInfoBlock::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
ContactInfoBlock::__construct	public	function	Creates a ContactInfoBlock instance. 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 ContactInfoBlock in Brainstorm profile 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation