You are here

class SystemBrandingBlock in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/system/src/Plugin/Block/SystemBrandingBlock.php \Drupal\system\Plugin\Block\SystemBrandingBlock

Provides a block to display 'Site branding' elements.

Plugin annotation


@Block(
  id = "system_branding_block",
  admin_label = @Translation("Site branding")
)

Hierarchy

Expanded class hierarchy of SystemBrandingBlock

File

core/modules/system/src/Plugin/Block/SystemBrandingBlock.php, line 26
Contains \Drupal\system\Plugin\Block\SystemBrandingBlock.

Namespace

Drupal\system\Plugin\Block
View 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 array(
      'use_site_logo' => TRUE,
      'use_site_name' => TRUE,
      'use_site_slogan' => TRUE,
      'label_display' => FALSE,
    );
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {

    // Get the theme.
    $theme = $form_state
      ->get('block_theme');

    // Get permissions.
    $url_system_theme_settings = new Url('system.theme_settings');
    $url_system_theme_settings_theme = new Url('system.theme_settings_theme', array(
      'theme' => $theme,
    ));
    if ($url_system_theme_settings
      ->access() && $url_system_theme_settings_theme
      ->access()) {

      // Provide links to the Appearance Settings and Theme Settings pages
      // if the user has access to administer themes.
      $site_logo_description = $this
        ->t('Defined on the <a href=":appearance">Appearance Settings</a> or <a href=":theme">Theme Settings</a> page.', array(
        ':appearance' => $url_system_theme_settings
          ->toString(),
        ':theme' => $url_system_theme_settings_theme
          ->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.', array(
        ':information' => $site_information_url,
      ));
      $site_slogan_description = $this
        ->t('Defined on the <a href=":information">Site Information</a> page.', array(
        ':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'] = array(
      '#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'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Site logo'),
      '#description' => $site_logo_description,
      '#default_value' => $this->configuration['use_site_logo'],
    );
    $form['block_branding']['use_site_name'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Site name'),
      '#description' => $site_name_description,
      '#default_value' => $this->configuration['use_site_name'],
    );
    $form['block_branding']['use_site_slogan'] = array(
      '#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 = array();
    $site_config = $this->configFactory
      ->get('system.site');
    $build['site_logo'] = array(
      '#theme' => 'image',
      '#uri' => theme_get_setting('logo.url'),
      '#alt' => $this
        ->t('Home'),
      '#access' => $this->configuration['use_site_logo'],
    );
    $build['site_name'] = array(
      '#markup' => $site_config
        ->get('name'),
      '#access' => $this->configuration['use_site_name'],
    );
    $build['site_slogan'] = array(
      '#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

Namesort descending Modifiers Type Description Overrides
BlockBase::$transliteration protected property The transliteration service.
BlockBase::access public function Indicates whether the block should be shown. Overrides BlockPluginInterface::access
BlockBase::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockBase::blockAccess protected function Indicates whether the block should be shown. 12
BlockBase::blockValidate public function Adds block type-specific validation for the block form. Overrides BlockPluginInterface::blockValidate 1
BlockBase::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. Overrides PluginFormInterface::buildConfigurationForm 1
BlockBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
BlockBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration 1
BlockBase::getMachineNameSuggestion public function Suggests a machine name to identify an instance of this block. Overrides BlockPluginInterface::getMachineNameSuggestion 1
BlockBase::label public function Returns the user-facing block label. Overrides BlockPluginInterface::label
BlockBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
BlockBase::setConfigurationValue public function Sets a particular value in the block settings. Overrides BlockPluginInterface::setConfigurationValue
BlockBase::setTransliteration public function Sets the transliteration service.
BlockBase::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit(). Overrides PluginFormInterface::submitConfigurationForm
BlockBase::transliteration protected function Wraps the transliteration service.
BlockBase::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). Overrides PluginFormInterface::validateConfigurationForm
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function 9
ContextAwarePluginBase::getCacheMaxAge public function 7
ContextAwarePluginBase::getContext public function 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
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
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
PluginBase::$pluginDefinition protected property The plugin implementation definition.
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
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
StringTranslationTrait::$stringTranslation protected property The string translation service.
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
SystemBrandingBlock::$configFactory protected property Stores the configuration factory.
SystemBrandingBlock::blockForm public function Returns the configuration form elements specific to this block plugin. Overrides BlockBase::blockForm
SystemBrandingBlock::blockSubmit public function Adds block type-specific submission handling for the block form. Overrides BlockBase::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 Gets default configuration for this plugin. Overrides BlockBase::defaultConfiguration
SystemBrandingBlock::getCacheTags public function Overrides ContextAwarePluginBase::getCacheTags
SystemBrandingBlock::__construct public function Creates a SystemBrandingBlock instance. Overrides BlockBase::__construct
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 1
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 1