class DraggableBlock in Draggable dashboard 8.2

Same name and namespace in other branches

8 src/Plugin/Block/DraggableBlock.php \Drupal\draggable_dashboard\Plugin\Block\DraggableBlock

Provides a draggable block with a simple text.

Plugin annotation


@Block(
  id = "draggable_dashboard_block",
  admin_label = @Translation("Draggable Block"),
  deriver = "Drupal\draggable_dashboard\Plugin\Block\DraggableBlockDeriver"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\draggable_dashboard\Plugin\Block\DraggableBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of DraggableBlock

File

src/Plugin/Block/DraggableBlock.php, line 30

Namespace

Drupal\draggable_dashboard\Plugin\Block

View source

class DraggableBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * Entity Type Manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The title resolver.
   *
   * @var \Drupal\Core\Controller\TitleResolverInterface
   */
  protected $titleResolver;

  /**
   * Block manager service.
   *
   * @var \Drupal\Core\Block\BlockManagerInterface
   */
  protected $blockManager;

  /**
   * Current user service.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * @var RequestStack
   */
  protected $requestStack;

  /**
   * @var RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * DraggableBlock constructor.
   *
   * @param array $configuration
   *   Plugin configuration.
   * @param string $plugin_id
   *   Plugin id.
   * @param array $plugin_definition
   *   Plugin definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity Type Manager.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   Request stack.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   Current Route Matcher.
   * @param \Drupal\Core\Theme\ThemeManagerInterface $theme_manager
   *   The theme manager.
   * @param \Drupal\Core\Controller\TitleResolverInterface $title_resolver
   *   Title resolver.
   * @param \Drupal\Core\Block\BlockManagerInterface $block_plugin_manager
   *   Block manager.
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   Current user.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, EntityTypeManagerInterface $entity_type_manager, RequestStack $request_stack, RouteMatchInterface $route_match, TitleResolverInterface $title_resolver, BlockManagerInterface $block_plugin_manager, AccountProxyInterface $current_user) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->titleResolver = $title_resolver;
    $this->entityTypeManager = $entity_type_manager;
    $this->blockManager = $block_plugin_manager;
    $this->currentUser = $current_user;
    $this->routeMatch = $route_match;
    $this->requestStack = $request_stack;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('request_stack'), $container
      ->get('current_route_match'), $container
      ->get('title_resolver'), $container
      ->get('plugin.manager.block'), $container
      ->get('current_user'));
  }

  /**
   * Gets the current dashboard entity.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   */
  private function getDashboard() {
    $dashboard_id = str_replace('draggable_dashboard_block:draggable_dashboard_', '', $this
      ->getConfiguration()['id']);
    return $this->entityTypeManager
      ->getStorage('dashboard_entity')
      ->load($dashboard_id);
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $dashboard = $this
      ->getDashboard();
    $columns = [];
    if (!empty($dashboard)) {
      $all_blocks = $dashboard
        ->get('blocks');
      $max_blocks = 0;

      // Create dashboard columns.
      for ($i = 1; $i <= $dashboard
        ->get('columns'); $i++) {
        $blocks = [];
        if (!empty($all_blocks)) {
          foreach ($all_blocks as $key => $relation) {
            if ($relation['column'] == $i) {
              $blocks[] = $relation + [
                'block_id' => $key,
              ];
            }
          }
        }
        if (!empty($blocks)) {
          if ($max_blocks < count($blocks)) {
            $max_blocks = count($blocks);
          }
          foreach ($blocks as $delta => $relation) {
            $block_instance = $this->blockManager
              ->createInstance($relation['settings']['id'], $relation['settings']);
            if ($block_instance instanceof TitleBlockPluginInterface) {
              $pageTitle = $this->titleResolver
                ->getTitle($this->requestStack
                ->getCurrentRequest(), $this->routeMatch
                ->getRouteObject());
              if ($pageTitle) {
                $block_instance
                  ->setTitle($pageTitle);
              }
            }

            // Some blocks might implement access check.
            // Return empty render array if user doesn't have access.
            if ($block_instance
              ->access($this->currentUser)) {

              // See \Drupal\block\BlockViewBuilder::buildPreRenderableBlock
              // See template_preprocess_block()
              $element = [
                '#theme' => 'block',
                '#attributes' => [
                  'id' => "block-" . $relation['block_id'],
                  'data-id' => $relation['block_id'],
                ],
                '#configuration' => $block_instance
                  ->getConfiguration(),
                '#plugin_id' => $block_instance
                  ->getPluginId(),
                '#base_plugin_id' => $block_instance
                  ->getBaseId(),
                '#derivative_plugin_id' => $block_instance
                  ->getDerivativeId(),
                '#draggable_dashboard' => true,
                'content' => $block_instance
                  ->build(),
                'title' => [
                  '#markup' => $block_instance
                    ->label(),
                ],
                'id' => [
                  '#markup' => $relation['block_id'],
                ],
              ];
              CacheableMetadata::createFromRenderArray($element)
                ->merge(CacheableMetadata::createFromRenderArray($element['content']))
                ->addCacheableDependency($block_instance)
                ->applyTo($element);
              $columns[$i][] = $element;
            }
          }
        }
      }
    }
    return [
      '#theme' => 'draggable_dashboard_block',
      '#attributes' => [
        'data-id' => $dashboard
          ->id(),
      ],
      '#dashboard' => $dashboard,
      '#columns' => $columns,
      '#attached' => [
        'library' => [
          'draggable_dashboard/frontend',
          'draggable_dashboard/draggable',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    return AccessResult::allowedIfHasPermission($account, 'access content');
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    $dashboard = $this
      ->getDashboard();
    return $dashboard
      ->getCacheTags();
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return [
      'user.permissions',
    ];
  }

}

Members

Name	Modifiers	Type	Description	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::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::defaultConfiguration	public	function		19
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::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
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
DraggableBlock::$blockManager	protected	property	Block manager service.
DraggableBlock::$currentUser	protected	property	Current user service.
DraggableBlock::$entityTypeManager	protected	property	Entity Type Manager service.
DraggableBlock::$requestStack	protected	property
DraggableBlock::$routeMatch	protected	property
DraggableBlock::$titleResolver	protected	property	The title resolver.
DraggableBlock::blockAccess	protected	function	Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
DraggableBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
DraggableBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
DraggableBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
DraggableBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DraggableBlock::getCacheContexts	public	function	The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
DraggableBlock::getCacheTags	public	function	The cache tags associated with this object. Overrides ContextAwarePluginBase::getCacheTags
DraggableBlock::getDashboard	private	function	Gets the current dashboard entity.
DraggableBlock::__construct	public	function	DraggableBlock constructor. Overrides BlockPluginTrait::__construct
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.
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

You are here

class DraggableBlock in Draggable dashboard 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation