You are here

Home » API reference » Previous/Next API 8.2 » PrevNextBlock.php

class PrevNextBlock in Previous/Next API 8.2

Provides a 'Previous Next' block.

Plugin annotation


@Block(
 id = "prev_next_block",
 admin_label = @Translation("Prev/Next"),
 context_definitions = {
   "node" = @ContextDefinition("entity:node", label = @Translation("Node"))
 }
)

Hierarchy

Expanded class hierarchy of PrevNextBlock

File

src/Plugin/Block/PrevNextBlock.php, line 25

Namespace

Drupal\prev_next\Plugin\Block
View source 
class PrevNextBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * Symfony\Component\HttpFoundation\RequestStack definition.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The PrevNextHelper service.
   *
   * @var \Drupal\prev_next\PrevNextHelperInterface
   */
  protected $prevnextHelper;

  /**
   * Constructs an PrevNextBlock object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param string $plugin_definition
   *   The plugin implementation definition.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The Request Stack.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\prev_next\PrevNextHelperInterface $prevnext_helper
   *   The PrevNextHelper service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RequestStack $request_stack, ModuleHandlerInterface $module_handler, PrevNextHelperInterface $prevnext_helper) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->requestStack = $request_stack;
    $this->moduleHandler = $module_handler;
    $this->prevnextHelper = $prevnext_helper;
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'prev_display' => TRUE,
      'prev_text' => $this
        ->t('«prev'),
      'next_display' => TRUE,
      'next_text' => $this
        ->t('next»'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form['previous'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Previous Node'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $form['previous']['prev_display'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display'),
      '#default_value' => $this->configuration['prev_display'],
    ];
    $form['previous']['prev_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Link text'),
      '#description' => $this
        ->t('Provide the text to customize the previous link text.'),
      '#default_value' => $this->configuration['prev_text'],
    ];
    $form['next'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Next Node'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $form['next']['next_display'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display'),
      '#default_value' => $this->configuration['next_display'],
    ];
    $form['next']['next_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Link text'),
      '#description' => $this
        ->t('Provide the text to customize the next link text.'),
      '#default_value' => $this->configuration['next_text'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $previous_settings = $form_state
      ->getValue('previous');
    foreach ($previous_settings as $key => $value) {
      $this
        ->setConfigurationValue($key, $value);
    }
    $next_settings = $form_state
      ->getValue('next');
    foreach ($next_settings as $key => $value) {
      $this
        ->setConfigurationValue($key, $value);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [
      '#theme' => 'prev_next_block',
    ];

    /* @var $node \Drupal\node\NodeInterface */
    $node = $this
      ->getContextValue('node');
    if ($node instanceof NodeInterface) {
      $prev_id = $this->prevnextHelper
        ->getPrevnextId($node
        ->id(), 'prev');
      $next_id = $this->prevnextHelper
        ->getPrevnextId($node
        ->id(), 'next');
      if ($next_id || $prev_id) {
        if ($prev_id && $this->configuration['prev_display'] && $this->configuration['prev_text'] != '') {
          $build += [
            '#prev_display' => $this->configuration['prev_display'],
            '#prev_text' => $this->configuration['prev_text'],
            '#prev_id' => $prev_id,
          ];
        }
        if ($next_id && $this->configuration['next_display'] && $this->configuration['next_text'] != '') {
          $build += [
            '#next_display' => $this->configuration['next_display'],
            '#next_text' => $this->configuration['next_text'],
            '#next_id' => $next_id,
          ];
        }
      }
    }
    return $build;
  }

}

Members

Namesort descending 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::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::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
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
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
PrevNextBlock::$moduleHandler protected property The module handler service.
PrevNextBlock::$prevnextHelper protected property The PrevNextHelper service.
PrevNextBlock::$requestStack protected property Symfony\Component\HttpFoundation\RequestStack definition.
PrevNextBlock::blockForm public function Overrides BlockPluginTrait::blockForm
PrevNextBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
PrevNextBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
PrevNextBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PrevNextBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
PrevNextBlock::__construct public function Constructs an PrevNextBlock object. Overrides BlockPluginTrait::__construct
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