class SystemBrandingBlock
Provides a block to display 'Site branding' elements.
Attributes
#[Block(id: "system_branding_block", admin_label: new TranslatableMarkup("Site branding"), forms: [
'settings_tray' => SystemBrandingOffCanvasForm::class,
])]
  Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\Core\Block\BlockBase implements \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Plugin\PreviewAwarePluginInterface, \Drupal\Core\Render\PreviewFallbackInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Plugin\PluginBase- class \Drupal\system\Plugin\Block\SystemBrandingBlock implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Block\BlockBase
 
 
- class \Drupal\Core\Block\BlockBase implements \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Plugin\PreviewAwarePluginInterface, \Drupal\Core\Render\PreviewFallbackInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of SystemBrandingBlock
File
- 
              core/modules/ system/ src/ Plugin/ Block/ SystemBrandingBlock.php, line 19 
Namespace
Drupal\system\Plugin\BlockView source
class SystemBrandingBlock extends BlockBase implements ContainerFactoryPluginInterface {
  
  /**
   * Stores the configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;
  
  /**
   * Creates a SystemBrandingBlock 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\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->configFactory = $config_factory;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container->get('config.factory'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'use_site_logo' => TRUE,
      'use_site_name' => TRUE,
      'use_site_slogan' => TRUE,
      'label_display' => FALSE,
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    // Get permissions.
    $url_system_theme_settings = new Url('system.theme_settings');
    if ($url_system_theme_settings->access()) {
      // Provide links to the Appearance Settings page if the user has access to
      // administer themes.
      $site_logo_description = $this->t('Defined on the <a href="@appearance">Appearance Settings</a> page.', [
        '@appearance' => $url_system_theme_settings->toString(),
      ]);
    }
    else {
      // Explain that the user does not have access to the Appearance and Theme
      // Settings pages.
      $site_logo_description = $this->t('Defined on the Appearance or Theme Settings page. You do not have the appropriate permissions to change the site logo.');
    }
    $url_system_site_information_settings = new Url('system.site_information_settings');
    if ($url_system_site_information_settings->access()) {
      // Get paths to settings pages.
      $site_information_url = $url_system_site_information_settings->toString();
      // Provide link to Site Information page if the user has access to
      // administer site configuration.
      $site_name_description = $this->t('Defined on the <a href=":information">Site Information</a> page.', [
        ':information' => $site_information_url,
      ]);
      $site_slogan_description = $this->t('Defined on the <a href=":information">Site Information</a> page.', [
        ':information' => $site_information_url,
      ]);
    }
    else {
      // Explain that the user does not have access to the Site Information
      // page.
      $site_name_description = $this->t('Defined on the Site Information page. You do not have the appropriate permissions to change the site logo.');
      $site_slogan_description = $this->t('Defined on the Site Information page. You do not have the appropriate permissions to change the site logo.');
    }
    $form['block_branding'] = [
      '#type' => 'fieldset',
      '#title' => $this->t('Toggle branding elements'),
      '#description' => $this->t('Choose which branding elements you want to show in this block instance.'),
    ];
    $form['block_branding']['use_site_logo'] = [
      '#type' => 'checkbox',
      '#title' => $this->t('Site logo'),
      '#description' => $site_logo_description,
      '#default_value' => $this->configuration['use_site_logo'],
    ];
    $form['block_branding']['use_site_name'] = [
      '#type' => 'checkbox',
      '#title' => $this->t('Site name'),
      '#description' => $site_name_description,
      '#default_value' => $this->configuration['use_site_name'],
    ];
    $form['block_branding']['use_site_slogan'] = [
      '#type' => 'checkbox',
      '#title' => $this->t('Site slogan'),
      '#description' => $site_slogan_description,
      '#default_value' => $this->configuration['use_site_slogan'],
    ];
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $block_branding = $form_state->getValue('block_branding');
    $this->configuration['use_site_logo'] = $block_branding['use_site_logo'];
    $this->configuration['use_site_name'] = $block_branding['use_site_name'];
    $this->configuration['use_site_slogan'] = $block_branding['use_site_slogan'];
  }
  
  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $site_config = $this->configFactory
      ->get('system.site');
    $build['site_logo'] = [
      '#theme' => 'image',
      '#uri' => theme_get_setting('logo.url'),
      '#alt' => $this->t('Home'),
      '#access' => $this->configuration['use_site_logo'],
    ];
    $build['site_name'] = [
      '#markup' => $site_config->get('name'),
      '#access' => $this->configuration['use_site_name'],
    ];
    $build['site_slogan'] = [
      '#markup' => $site_config->get('slogan'),
      '#access' => $this->configuration['use_site_slogan'],
    ];
    return $build;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    return Cache::mergeTags(parent::getCacheTags(), $this->configFactory
      ->get('system.site')
      ->getCacheTags());
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | 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::$inPreview | protected | property | Whether the plugin is being rendered in preview mode. | |||
| BlockPluginTrait::$transliteration | protected | property | The transliteration service. | |||
| BlockPluginTrait::access | public | function | ||||
| BlockPluginTrait::baseConfigurationDefaults | protected | function | Returns generic default configuration for block plugins. | |||
| BlockPluginTrait::blockAccess | protected | function | Indicates whether the block should be shown. | 18 | ||
| 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 | 1 | |||
| 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::setInPreview | 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 | ||
| 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::getCacheContexts | public | function | 10 | |||
| ContextAwarePluginTrait::getCacheMaxAge | public | function | 6 | |||
| ContextAwarePluginTrait::getContext | public | function | ||||
| ContextAwarePluginTrait::getContextDefinition | public | function | ||||
| ContextAwarePluginTrait::getContextDefinitions | public | function | ||||
| ContextAwarePluginTrait::getContextMapping | public | function | 1 | |||
| ContextAwarePluginTrait::getContexts | public | function | ||||
| ContextAwarePluginTrait::getContextValue | public | function | ||||
| ContextAwarePluginTrait::getContextValues | public | function | ||||
| ContextAwarePluginTrait::getPluginDefinition | abstract public | function | 1 | |||
| ContextAwarePluginTrait::setContext | public | function | 1 | |||
| ContextAwarePluginTrait::setContextMapping | public | function | ||||
| ContextAwarePluginTrait::setContextValue | public | function | ||||
| ContextAwarePluginTrait::validateContexts | public | function | ||||
| 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 | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| 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. | 3 | ||
| 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. | |||
| SystemBrandingBlock::$configFactory | protected | property | Stores the configuration factory. | |||
| SystemBrandingBlock::blockForm | public | function | Overrides BlockPluginTrait::blockForm | |||
| SystemBrandingBlock::blockSubmit | public | function | Overrides BlockPluginTrait::blockSubmit | |||
| SystemBrandingBlock::build | public | function | Builds and returns the renderable array for this block plugin. | Overrides BlockPluginInterface::build | ||
| SystemBrandingBlock::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | ||
| SystemBrandingBlock::defaultConfiguration | public | function | Overrides BlockPluginTrait::defaultConfiguration | |||
| SystemBrandingBlock::getCacheTags | public | function | Overrides ContextAwarePluginTrait::getCacheTags | |||
| SystemBrandingBlock::__construct | public | function | Creates a SystemBrandingBlock instance. | Overrides BlockPluginTrait::__construct | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
