class SystemBrandingBlock
Same name and namespace in other branches
- 9 core/modules/system/src/Plugin/Block/SystemBrandingBlock.php \Drupal\system\Plugin\Block\SystemBrandingBlock
- 10 core/modules/system/src/Plugin/Block/SystemBrandingBlock.php \Drupal\system\Plugin\Block\SystemBrandingBlock
- 11.x 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"),
forms = {
"settings_tray" = "Drupal\system\Form\SystemBrandingOffCanvasForm",
},
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\ContextAwarePluginInterface implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Plugin\ContextAwarePluginBase extends \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait implements \Drupal\Component\Plugin\ContextAwarePluginBase
- class \Drupal\Core\Block\BlockBase extends \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Render\PreviewFallbackInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait implements \Drupal\Core\Plugin\ContextAwarePluginBase
- class \Drupal\system\Plugin\Block\SystemBrandingBlock extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Block\BlockBase
- class \Drupal\Core\Block\BlockBase extends \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Render\PreviewFallbackInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait implements \Drupal\Core\Plugin\ContextAwarePluginBase
- class \Drupal\Core\Plugin\ContextAwarePluginBase extends \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait implements \Drupal\Component\Plugin\ContextAwarePluginBase
- class \Drupal\Component\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\ContextAwarePluginInterface implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of SystemBrandingBlock
File
-
core/
modules/ system/ src/ Plugin/ Block/ SystemBrandingBlock.php, line 24
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 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', [
'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.', [
':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.', [
':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 | Deprecated | Modifiers | Object type | Summary | Overriden Title | 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::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 | ||
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::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 | 2 | |
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. | |||
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 | The cache tags associated with this object. | Overrides ContextAwarePluginBase::getCacheTags | ||
SystemBrandingBlock::__construct | public | function | Creates a SystemBrandingBlock instance. | Overrides BlockPluginTrait::__construct | ||
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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.