class Basic in Pagerer 8

Basic pager style similar to Views' 'mini' pager.

By default presents current page out of total, plus links to previous/next page.

Plugin annotation

@PagererStyle(
  id = "basic",
  title = @Translation("Basic pager similar to Views mini pager"),
  short_title = @Translation("Basic"),
  help = @Translation("Presents current page out of total, plus links to previous/next page."),
  style_type = "base"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\pagerer\Plugin\pagerer\PagererStyleBase implements ContainerFactoryPluginInterface, PluginFormInterface, PagererStyleInterface
      • class \Drupal\pagerer\Plugin\pagerer\Basic

File

src/Plugin/pagerer/Basic.php, line 21

Namespace

Drupal\pagerer\Plugin\pagerer

class Basic extends PagererStyleBase {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $config = parent::buildConfigurationForm($form, $form_state);
    unset($config['separators_container']);
    return $config;
  }

  /**
   * Return an empty pager render array.
   *
   * @return array
   *   Render array.
   */
  protected function buildPagerItems() {
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Basic::buildConfigurationForm	public	function	Form constructor. Overrides PagererStyleBase::buildConfigurationForm
Basic::buildPagerItems	protected	function	Return an empty pager render array.
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.
PagererStyleBase::$configFactory	protected	property	The config factory.
PagererStyleBase::$pager	protected	property	The Pagerer pager object.
PagererStyleBase::$pagererPreset	protected	property	The PagererPreset object being configured.
PagererStyleBase::$pagererPresetPane	protected	property	The PagererPreset pane being configured.
PagererStyleBase::$parameters	protected	property	Query parameters as requested by the theme call.
PagererStyleBase::$typedConfigManager	protected	property	The config type plugins manager.
PagererStyleBase::buildEmptyPager	protected	function	Render a 'no pages to display' text.	1
PagererStyleBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PagererStyleBase::getDisplayTag	protected	function	Returns a translated textual element for pages/items/item ranges.
PagererStyleBase::getNavigationItem	protected	function	Gets a link/button item to first/previous/next/last link.
PagererStyleBase::getOption	protected	function	Returns a configuration element.
PagererStyleBase::getPageItem	protected	function	Gets a 'page' item in the pager.
PagererStyleBase::getTag	protected	function	Returns a translated textual element from the configuration.
PagererStyleBase::prepareJsState	protected	function	Prepares input parameters for a JS enabled pager widget.
PagererStyleBase::preprocess	public	function	Prepares to render the pager. Overrides PagererStyleInterface::preprocess
PagererStyleBase::setConfigurationContext	public	function	Sets the current PagererPreset and pane being configured.
PagererStyleBase::setPager	public	function	Sets the Pagerer pager to be rendered. Overrides PagererStyleInterface::setPager
PagererStyleBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
PagererStyleBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
PagererStyleBase::__construct	public	function	Constructs a \Drupal\pagerer\Plugin\pagerer\PagererStyleBase object. Overrides PluginBase::__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.
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.