You are here

Home » API reference » Entity Browser 8 » PagerTestWidget.php

class PagerTestWidget in Entity Browser 8

Same name and namespace in other branches
  1. 8.2 tests/modules/entity_browser_test/src/Plugin/EntityBrowser/Widget/PagerTestWidget.php \Drupal\entity_browser_test\Plugin\EntityBrowser\Widget\PagerTestWidget

Pager test widget implementation for test purposes.

Plugin annotation


@EntityBrowserWidget(
  id = "pager_test",
  label = @Translation("Pager test widget"),
  description = @Translation("Pager test widget existing for testing purposes."),
  auto_select = FALSE
)

Hierarchy

Expanded class hierarchy of PagerTestWidget

File

tests/modules/entity_browser_test/src/Plugin/EntityBrowser/Widget/PagerTestWidget.php, line 19

Namespace

Drupal\entity_browser_test\Plugin\EntityBrowser\Widget
View source 
class PagerTestWidget extends WidgetBase {

  /**
   * Entity to be returned.
   *
   * @var \Drupal\Core\Entity\EntityInterface
   */
  public $entity;

  /**
   * {@inheritdoc}
   */
  public function getForm(array &$original_form, FormStateInterface $form_state, array $additional_widget_parameters) {
    $form = parent::getForm($original_form, $form_state, $additional_widget_parameters);
    $form['message'] = [
      '#markup' => $this
        ->t('Current page reported by the element is: @page.', [
        '@page' => EntityBrowserPagerElement::getCurrentPage($form_state),
      ]),
    ];
    $form['first'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('First page'),
      '#submit' => [
        [
          static::class,
          'submitFirst',
        ],
      ],
    ];
    $form['last'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Last page'),
      '#submit' => [
        [
          static::class,
          'submitLast',
        ],
      ],
    ];
    $form['pager_eb'] = [
      '#type' => 'entity_browser_pager',
      '#total_pages' => 4,
    ];
    return $form;
  }

  /**
   * Submit callback for first page reset button.
   */
  public function submitFirst(array &$form, FormStateInterface $form_state) {
    EntityBrowserPagerElement::setCurrentPage($form_state);
    $form_state
      ->setRebuild();
  }

  /**
   * Submit callback for last page reset button.
   */
  public function submitLast(array &$form, FormStateInterface $form_state) {
    EntityBrowserPagerElement::setCurrentPage($form_state, 4);
    $form_state
      ->setRebuild();
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareEntities(array $form, FormStateInterface $form_state) {
  }

}

Members

Namesort descending 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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PagerTestWidget::$entity public property Entity to be returned.
PagerTestWidget::getForm public function Returns widget form. Overrides WidgetBase::getForm
PagerTestWidget::prepareEntities protected function Prepares the entities without saving them. Overrides WidgetBase::prepareEntities
PagerTestWidget::submitFirst public function Submit callback for first page reset button.
PagerTestWidget::submitLast public function Submit callback for last page reset button.
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.
PluginConfigurationFormTrait::submitConfigurationForm public function Implements PluginFormInterface::submitConfigurationForm(). 3
PluginConfigurationFormTrait::validateConfigurationForm public function Implements PluginFormInterface::validateConfigurationForm(). 2
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.
WidgetBase::$entityTypeManager protected property Entity type manager service.
WidgetBase::$eventDispatcher protected property Event dispatcher service.
WidgetBase::$id protected property Plugin id.
WidgetBase::$label protected property Plugin label.
WidgetBase::$uuid protected property Plugin uuid.
WidgetBase::$validationManager protected property The Widget Validation Manager service.
WidgetBase::$weight protected property Plugin weight.
WidgetBase::access public function Defines if the widget is visible / accessible in a given context. Overrides WidgetInterface::access 3
WidgetBase::buildConfigurationForm public function Implements PluginFormInterface::buildConfigurationForm(). Overrides PluginConfigurationFormTrait::buildConfigurationForm 3
WidgetBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 3
WidgetBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 4
WidgetBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
WidgetBase::getWeight public function Returns the widget's weight. Overrides WidgetInterface::getWeight
WidgetBase::handleWidgetContext protected function Allow configuration overrides at runtime based on widget context passed to this widget from the Entity Browser element.
WidgetBase::id public function Returns the widget id. Overrides WidgetInterface::id
WidgetBase::label public function Returns the widget label. Overrides WidgetInterface::label
WidgetBase::requiresJsCommands public function Returns if widget requires JS commands support by selection display. Overrides WidgetInterface::requiresJsCommands
WidgetBase::runWidgetValidators protected function Run widget validators.
WidgetBase::selectEntities protected function Dispatches event that informs all subscribers about new selected entities.
WidgetBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
WidgetBase::setLabel public function Sets the widget's label. Overrides WidgetInterface::setLabel
WidgetBase::setWeight public function Sets the widget's weight. Overrides WidgetInterface::setWeight
WidgetBase::submit public function Submits form. Overrides WidgetInterface::submit 5
WidgetBase::uuid public function Returns the widget UUID. Overrides WidgetInterface::uuid
WidgetBase::validate public function Validates form. Overrides WidgetInterface::validate 1
WidgetBase::__construct public function WidgetBase constructor. Overrides PluginBase::__construct 3