class EntityBrowserPagerElement in Entity Browser 8

Provides an Entity Browser pager form element.

Properties:

• #total_pages: Total number of pages. This is optional with default value set on NULL. With default value pager can't calculate last page correctly and "next" will be available even on last page. For correct functionality #total_pages must be set up.

Example:

$form['pager'] = [
  '#type' => 'entity_browser_pager',
  '#total_pages' => 12,
];

Number of the current page is stored in the form state. In order to get it the provided helper function needs to be utilized:

$page = EntityBrowserPagerElement::getCurrentPage($form_state);

Plugin annotation

@FormElement("entity_browser_pager");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
        • class \Drupal\entity_browser\Element\EntityBrowserPagerElement

See also

::getCurrentPage($form_state).

1 file declares its use of EntityBrowserPagerElement

PagerTestWidget.php in tests/modules/entity_browser_test/src/Plugin/EntityBrowser/Widget/PagerTestWidget.php

1 #type use of EntityBrowserPagerElement

PagerTestWidget::getForm in tests/modules/entity_browser_test/src/Plugin/EntityBrowser/Widget/PagerTestWidget.php

Returns widget form.

File

src/Element/EntityBrowserPagerElement.php, line 36

Namespace

Drupal\entity_browser\Element

class EntityBrowserPagerElement extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#process' => [
        [
          $class,
          'processEntityBrowserPager',
        ],
      ],
      '#theme_wrappers' => [
        'form_element',
      ],
      '#total_pages' => NULL,
      '#attached' => [
        'library' => [
          'entity_browser/pager',
        ],
      ],
    ];
  }

  /**
   * Process Entity browser pager element.
   */
  public static function processEntityBrowserPager(&$element, FormStateInterface $form_state, &$complete_form) {
    $page = static::getCurrentPage($form_state);
    $element['previous'] = [
      '#type' => 'submit',
      '#submit' => [
        [
          static::class,
          'submitPager',
        ],
      ],
      '#value' => t('‹ Previous'),
      '#name' => 'prev_page',
      '#disabled' => $page === 1,
      '#attributes' => [
        'class' => [
          'prev',
        ],
      ],
      '#limit_validation_errors' => [
        array_merge($element['#parents'], [
          'previous',
        ]),
      ],
    ];
    $element['current'] = [
      '#type' => 'html_tag',
      '#tag' => 'span',
      '#value' => t('Page @page', [
        '@page' => $page,
      ]),
      '#attributes' => [
        'class' => [
          'current',
        ],
      ],
    ];
    $element['next'] = [
      '#type' => 'submit',
      '#submit' => [
        [
          static::class,
          'submitPager',
        ],
      ],
      '#value' => t('Next ›'),
      '#name' => 'next_page',
      '#disabled' => $element['#total_pages'] == $page,
      '#attributes' => [
        'class' => [
          'next',
        ],
      ],
      '#limit_validation_errors' => [
        array_merge($element['#parents'], [
          'next',
        ]),
      ],
    ];
    return $element;
  }

  /**
   * Submit handler for next and previous buttons.
   *
   * @param array $form
   *   The form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   */
  public static function submitPager(array $form, FormStateInterface $form_state) {
    $page = static::getCurrentPage($form_state);
    $triggering_element = $form_state
      ->getTriggeringElement();
    if ($triggering_element['#name'] == 'prev_page') {
      $page--;
    }
    elseif ($triggering_element['#name'] == 'next_page') {
      $page++;
    }
    $form_state
      ->set('page', $page);
    $form_state
      ->setRebuild();
  }

  /**
   * Gets current page from the form state.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   *
   * @return int
   *   Current page.
   */
  public static function getCurrentPage(FormStateInterface $form_state) {
    return !empty($form_state
      ->get('page')) ? $form_state
      ->get('page') : 1;
  }

  /**
   * Sets current page.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   * @param int $page
   *   (Optional) Page to set as current. Pager will be reset to the first page
   *   if omitted.
   */
  public static function setCurrentPage(FormStateInterface $form_state, $page = 1) {
    $form_state
      ->set('page', $page);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
EntityBrowserPagerElement::getCurrentPage	public static	function	Gets current page from the form state.
EntityBrowserPagerElement::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
EntityBrowserPagerElement::processEntityBrowserPager	public static	function	Process Entity browser pager element.
EntityBrowserPagerElement::setCurrentPage	public static	function	Sets current page.
EntityBrowserPagerElement::submitPager	public static	function	Submit handler for next and previous buttons.
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.