class NextPreviousBlock in Next Previous Post Block (Node or Page Pagination) 8

Same name and namespace in other branches

8.5 src/Plugin/Block/NextPreviousBlock.php \Drupal\nextpre\Plugin\Block\NextPreviousBlock
9.0.x src/Plugin/Block/NextPreviousBlock.php \Drupal\nextpre\Plugin\Block\NextPreviousBlock
1.0.x src/Plugin/Block/NextPreviousBlock.php \Drupal\nextpre\Plugin\Block\NextPreviousBlock

Provides a 'Next Previous' block.

Plugin annotation


@Block(
  id = "next_previous_block",
  admin_label = @Translation("Next Previous link"),
  category = @Translation("Blocks")
)

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\nextpre\Plugin\Block\NextPreviousBlock implements BlockPluginInterface, ContainerFactoryPluginInterface

Expanded class hierarchy of NextPreviousBlock

File

src/Plugin/Block/NextPreviousBlock.php, line 27

Namespace

Drupal\nextpre\Plugin\Block

View source

class NextPreviousBlock extends BlockBase implements BlockPluginInterface, ContainerFactoryPluginInterface {

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

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The Query Factory.
   *
   * @var \Drupal\Core\Entity\Query\QueryFactory
   */
  protected $queryFactory;

  /**
   * Creates a NextPreviousBlock 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\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\Query\QueryFactory $queryFactory
   *   The Query Factory.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match, EntityTypeManagerInterface $entityTypeManager, QueryFactory $queryFactory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->routeMatch = $route_match;
    $this->entityTypeManager = $entityTypeManager;
    $this->queryFactory = $queryFactory;
  }

  /**
   * {@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'), $container
      ->get('entity_type.manager'), $container
      ->get('entity.query'));
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $node_types = node_type_get_names();
    $form['content_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Content Types'),
      '#empty_option' => $this
        ->t('-None-'),
      '#options' => $node_types,
      '#default_value' => isset($this->configuration['content_type']) ? $this->configuration['content_type'] : '',
      '#required' => TRUE,
    ];
    $form['previous_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Previous text'),
      '#description' => $this
        ->t('Add your previous button name'),
      '#default_value' => isset($this->configuration['previous_text']) ? $this->configuration['previous_text'] : '',
      '#required' => TRUE,
    ];
    $form['next_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Next text'),
      '#description' => $this
        ->t('Add your next button name'),
      '#default_value' => isset($this->configuration['next_text']) ? $this->configuration['next_text'] : '',
      '#required' => TRUE,
    ];
    $form['previouslink_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Previous link class'),
      '#description' => $this
        ->t('Add your class in previous link'),
      '#default_value' => isset($this->configuration['previouslink_class']) ? $this->configuration['previouslink_class'] : '',
    ];
    $form['nextlink_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Next link class'),
      '#description' => $this
        ->t('Add your class in next link'),
      '#default_value' => isset($this->configuration['nextlink_class']) ? $this->configuration['nextlink_class'] : '',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this->configuration['content_type'] = $form_state
      ->getValue('content_type');
    $this->configuration['previous_text'] = $values['previous_text'];
    $this->configuration['next_text'] = $values['next_text'];
    $this->configuration['previouslink_class'] = $values['previouslink_class'];
    $this->configuration['nextlink_class'] = $values['nextlink_class'];
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $link = [];

    // Get the created time of the current node.
    $node = $this->routeMatch
      ->getParameter('node');
    if ($node instanceof NodeInterface && $node
      ->getType() == $this->configuration['content_type']) {
      $current_nid = $node
        ->id();
      $link['prev'] = $this
        ->generatePrevious($current_nid);
      $link['next'] = $this
        ->generateNext($current_nid);
    }
    return $link;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {

    // Get the created time of the current node.
    $node = $this->routeMatch
      ->getParameter('node');
    if (!empty($node)) {

      // If there is node add its cachetag.
      return Cache::mergeTags(parent::getCacheTags(), [
        'node:' . $node
          ->id(),
      ]);
    }
    else {

      // Return default tags instead.
      return parent::getCacheTags();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return Cache::mergeContexts(parent::getCacheContexts(), [
      'route',
    ]);
  }

  /**
   * Lookup the previous node,youngest node which is still older than the node.
   *
   * @param string $current_nid
   *   Show current page node id.
   *
   * @return array
   *   A render array for a previous node.
   */
  private function generatePrevious($current_nid) {
    return $this
      ->generateNextPrevious($current_nid, 'prev');
  }

  /**
   * Lookup the next node,oldest node which is still younger than the node.
   *
   * @param string $current_nid
   *   Show current page node id.
   *
   * @return array
   *   A render array for a next node.
   */
  private function generateNext($current_nid) {
    return $this
      ->generateNextPrevious($current_nid, 'next');
  }
  const DIRECTION__NEXT = 'next';

  /**
   * Lookup the next or previous node.
   *
   * @param string $current_nid
   *   Get current page node id.
   * @param string $direction
   *   Default value is "next" and other value come from
   *   generatePrevious() and generatePrevious().
   *
   * @return array
   *   Find the alias of the next node.
   */
  private function generateNextPrevious($current_nid, $direction = self::DIRECTION__NEXT) {
    $comparison_opperator = '>';
    $sort = 'ASC';
    $display_text = $this->configuration['next_text'];
    $class = $this->configuration['nextlink_class'] ? $this->configuration['nextlink_class'] : 'btn';
    if ($direction === 'prev') {
      $comparison_opperator = '<';
      $sort = 'DESC';
      $display_text = $this->configuration['previous_text'];
      $class = $this->configuration['previouslink_class'] ? $this->configuration['previouslink_class'] : 'btn';
    }

    // Lookup 1 node younger (or older) than the current node.
    $query = $this->entityTypeManager
      ->getStorage('node');
    $query_result = $query
      ->getQuery();
    $next = $query_result
      ->condition('nid', $current_nid, $comparison_opperator)
      ->condition('type', $this->configuration['content_type'])
      ->condition('status', 1)
      ->sort('nid', $sort)
      ->range(0, 1)
      ->execute();

    // If this is not the youngest (or oldest) node.
    if (!empty($next) && is_array($next)) {
      $next = array_values($next);
      $next = $next[0];

      // Find the alias of the next node.
      $nid = $next;
      $url = Url::fromRoute('entity.node.canonical', [
        'node' => $nid,
      ], []);
      $link = Link::fromTextAndUrl($display_text, Url::fromUri('internal:/' . $url
        ->getInternalPath()));
      $link = $link
        ->toRenderable();
      $link['#attributes'] = [
        'class' => [
          'nextpre__btn',
          $class,
        ],
      ];
      return $link;
    }
    return '';
  }

}

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::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::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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
NextPreviousBlock::$entityTypeManager	protected	property	The entity type manager.
NextPreviousBlock::$queryFactory	protected	property	The Query Factory.
NextPreviousBlock::$routeMatch	protected	property	The current route match.
NextPreviousBlock::blockForm	public	function	Returns the configuration form elements specific to this block plugin. Overrides BlockPluginTrait::blockForm
NextPreviousBlock::blockSubmit	public	function	Adds block type-specific submission handling for the block form. Overrides BlockPluginTrait::blockSubmit
NextPreviousBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
NextPreviousBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
NextPreviousBlock::DIRECTION__NEXT		constant
NextPreviousBlock::generateNext	private	function	Lookup the next node,oldest node which is still younger than the node.
NextPreviousBlock::generateNextPrevious	private	function	Lookup the next or previous node.
NextPreviousBlock::generatePrevious	private	function	Lookup the previous node,youngest node which is still older than the node.
NextPreviousBlock::getCacheContexts	public	function	The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
NextPreviousBlock::getCacheTags	public	function	The cache tags associated with this object. Overrides ContextAwarePluginBase::getCacheTags
NextPreviousBlock::__construct	public	function	Creates a NextPreviousBlock instance. Overrides BlockPluginTrait::__construct
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 NextPreviousBlock in Next Previous Post Block (Node or Page Pagination) 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation