You are here

Home » API reference » Open Social 10.2.x » SocialAlbumCountAndAddBlock.php

class SocialAlbumCountAndAddBlock in Open Social 10.2.x

Same name and namespace in other branches
  1. 10.3.x modules/social_features/social_album/src/Plugin/Block/SocialAlbumCountAndAddBlock.php \Drupal\social_album\Plugin\Block\SocialAlbumCountAndAddBlock
  2. 10.0.x modules/social_features/social_album/src/Plugin/Block/SocialAlbumCountAndAddBlock.php \Drupal\social_album\Plugin\Block\SocialAlbumCountAndAddBlock
  3. 10.1.x modules/social_features/social_album/src/Plugin/Block/SocialAlbumCountAndAddBlock.php \Drupal\social_album\Plugin\Block\SocialAlbumCountAndAddBlock

Provides a block to display images count and a button for adding new images.

Plugin annotation


@Block(
  id = "social_album_count_and_add_block",
  admin_label = @Translation("Album(s)"),
)

Hierarchy

Expanded class hierarchy of SocialAlbumCountAndAddBlock

File

modules/social_features/social_album/src/Plugin/Block/SocialAlbumCountAndAddBlock.php, line 24

Namespace

Drupal\social_album\Plugin\Block
View source 
class SocialAlbumCountAndAddBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The templates for labels with the number of entities.
   */
  const ITEM = [
    'count' => [
      'singular' => '@count album',
      'plural' => '@count albums',
    ],
  ];

  /**
   * The currently active route match object.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Constructs a SocialAlbumCountAndAddBlock object.
   *
   * @param array $configuration
   *   The block configuration.
   * @param string $plugin_id
   *   The ID of the plugin.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The currently active route match object.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('current_route_match'));
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    if (!($properties = $this
      ->getProperties())) {
      return $build;
    }
    $view = Views::getView('albums');
    $view
      ->setArguments([
      $this->routeMatch
        ->getRawParameter($properties['type']),
    ]);
    $view
      ->execute($properties['display']);
    $build['count'] = [
      '#markup' => $this
        ->formatPlural($view->total_rows, $properties['count']['singular'], $properties['count']['plural']),
    ];
    $url = Url::fromRoute($properties['link']['route']['name'], $properties['link']['route']['parameters'], [
      'attributes' => [
        'class' => [
          'btn',
          'btn-primary',
        ],
      ],
    ]);
    if ($url
      ->access()) {
      $build['link'] = Link::fromTextAndUrl($properties['link']['text'], $url)
        ->toRenderable();
    }
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    return AccessResult::allowedIf($this
      ->getProperties() !== NULL);
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    $cache_contexts = parent::getCacheContexts();
    if ($this
      ->getProperties()) {
      $cache_contexts = Cache::mergeContexts($cache_contexts, [
        'url',
      ]);
    }
    return $cache_contexts;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    $tags = parent::getCacheTags();
    if ($properties = $this
      ->getProperties()) {
      $type = $properties['type'];
      $tags = Cache::mergeTags($tags, [
        $type . ':' . $this->routeMatch
          ->getRawParameter($type),
      ]);
    }
    return $tags;
  }

  /**
   * Returns block properties for the current route.
   *
   * @return array|null
   *   The renderable data if block is allowed for the current route otherwise
   *   NULL.
   */
  protected function getProperties() {
    $items = [
      'entity.node.canonical' => [
        'type' => 'node',
        'display' => 'embed_album_overview',
        'count' => [
          'singular' => '@count image',
          'plural' => '@count images',
        ],
        'link' => [
          'text' => $this
            ->t('Add images'),
          'route' => [
            'name' => 'social_album.post',
            'parameters' => [
              'node' => $this->routeMatch
                ->getRawParameter('node'),
            ],
          ],
        ],
      ],
      'view.albums.page_albums_overview' => [
        'type' => 'user',
        'display' => 'page_albums_overview',
        'link' => [
          'text' => $this
            ->t('Create new album'),
          'route' => [
            'name' => 'node.add',
            'parameters' => [
              'node_type' => 'album',
            ],
          ],
        ],
      ] + self::ITEM,
      'view.albums.page_group_albums_overview' => [
        'type' => 'group',
        'display' => 'page_group_albums_overview',
        'link' => [
          'text' => $this
            ->t('Create new album'),
          'route' => [
            'name' => 'social_album.add',
            'parameters' => [
              'group' => $this->routeMatch
                ->getRawParameter('group'),
            ],
          ],
        ],
      ] + self::ITEM,
    ];
    return $items[$this->routeMatch
      ->getRouteName()] ?? NULL;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
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::blockForm public function 16
BlockPluginTrait::blockSubmit public function 13
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. Aliased as: traitBuildConfigurationForm
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.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheMaxAge public function 7
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 protected function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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::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 Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
SocialAlbumCountAndAddBlock::$routeMatch protected property The currently active route match object.
SocialAlbumCountAndAddBlock::blockAccess protected function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
SocialAlbumCountAndAddBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
SocialAlbumCountAndAddBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SocialAlbumCountAndAddBlock::getCacheContexts public function Overrides ContextAwarePluginTrait::getCacheContexts
SocialAlbumCountAndAddBlock::getCacheTags public function Overrides ContextAwarePluginTrait::getCacheTags
SocialAlbumCountAndAddBlock::getProperties protected function Returns block properties for the current route.
SocialAlbumCountAndAddBlock::ITEM constant The templates for labels with the number of entities.
SocialAlbumCountAndAddBlock::__construct public function Constructs a SocialAlbumCountAndAddBlock object. Overrides BlockPluginTrait::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.