AnnounceBlock.php

Same filename in other branches
  1. 11.x core/modules/announcements_feed/src/Plugin/Block/AnnounceBlock.php

Namespace

Drupal\announcements_feed\Plugin\Block

File

core/modules/announcements_feed/src/Plugin/Block/AnnounceBlock.php

View source
<?php

declare (strict_types=1);
namespace Drupal\announcements_feed\Plugin\Block;

use Drupal\announcements_feed\AnnounceRenderer;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Access\AccessResultInterface;
use Drupal\Core\Block\BlockBase;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Session\AccountInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides an 'Announcements Feed' block.
 *
 * @Block(
 *   id = "announce_block",
 *   admin_label = @Translation("Announcements Feed"),
 * )
 *
 * @internal
 */
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, AnnounceRenderer $announceRenderer) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) : static {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('announcements_feed.renderer'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockAccess(AccountInterface $account) : AccessResultInterface {
        return AccessResult::allowedIfHasPermission($account, 'access announcements');
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() : array {
        return $this->announceRenderer
            ->render();
    }

}

Classes

Title Deprecated Summary
AnnounceBlock Provides an 'Announcements Feed' block.

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