class AnnounceBlock

Same name and namespace in other branches
  1. 11.x core/modules/announcements_feed/src/Plugin/Block/AnnounceBlock.php \Drupal\announcements_feed\Plugin\Block\AnnounceBlock
  2. 10 core/modules/announcements_feed/src/Plugin/Block/AnnounceBlock.php \Drupal\announcements_feed\Plugin\Block\AnnounceBlock

Provides an 'Announcements Feed' block.

@internal

Attributes

#[Block(id: 'announce_block', admin_label: new TranslatableMarkup('Announcements Feed'))]

Hierarchy

Expanded class hierarchy of AnnounceBlock

File

core/modules/announcements_feed/src/Plugin/Block/AnnounceBlock.php, line 21

Namespace

Drupal\announcements_feed\Plugin\Block
View source
class AnnounceBlock extends BlockBase implements ContainerFactoryPluginInterface {
  
  /**
   * Constructs a new AnnouncementsFeedBlock 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\announcements_feed\AnnounceRenderer $announceRenderer
   *   The AnnounceRenderer service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, protected AnnounceRenderer $announceRenderer) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }
  
  /**
   * {@inheritdoc}
   */
  public function blockAccess(AccountInterface $account) : AccessResultInterface {
    return AccessResult::allowedIfHasPermission($account, 'access announcements');
  }
  
  /**
   * {@inheritdoc}
   */
  public function build() : array {
    return $this->announceRenderer
      ->render();
  }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title
AnnounceBlock::blockAccess public function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
AnnounceBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
AnnounceBlock::__construct public function Constructs a new AnnouncementsFeedBlock instance. Overrides BlockPluginTrait::__construct
AutowiredInstanceTrait::createInstanceAutowired public static function Instantiates a new instance of the implementing class using autowiring.
BlockBase::buildConfigurationForm public function
BlockBase::submitConfigurationForm public function
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::blockForm public function
BlockPluginTrait::blockSubmit public function
BlockPluginTrait::blockValidate public function
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
BlockPluginTrait::createPlaceholder public function
BlockPluginTrait::defaultConfiguration public function
BlockPluginTrait::getConfiguration public function
BlockPluginTrait::getMachineNameSuggestion public function
BlockPluginTrait::getPreviewFallbackString public function
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().
Aliased as: traitSubmitConfigurationForm
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().
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
ContextAwarePluginTrait::getCacheMaxAge public function
ContextAwarePluginTrait::getCacheTags public function
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function
ContextAwarePluginTrait::setContext public function
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
DependencySerializationTrait::__wakeup public function
MessengerTrait::$messenger protected property The messenger.
MessengerTrait::messenger public function Gets the messenger.
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin ID.
PluginBase::create public static function Instantiates a new instance of the implementing class using autowiring.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function
PluginBase::getDerivativeId public function
PluginBase::getPluginId public function
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.
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.