class ViewsReferencePager in Views Reference Field 8.2

The views reference setting pager plugin.

Plugin annotation

@ViewsReferenceSetting(
  id = "pager",
  label = @Translation("Pagination"),
  default_value = 0,
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\viewsreference\Plugin\ViewsReferenceSetting\ViewsReferencePager implements ViewsReferenceSettingInterface uses StringTranslationTrait

File

src/Plugin/ViewsReferenceSetting/ViewsReferencePager.php, line 19

Namespace

Drupal\viewsreference\Plugin\ViewsReferenceSetting

class ViewsReferencePager extends PluginBase implements ViewsReferenceSettingInterface {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function alterFormField(array &$form_field) {
    $form_field['#type'] = 'select';
    $form_field['#options'] = [
      '' => $this
        ->t('Default settings'),
      'full' => $this
        ->t('Full pager'),
      'mini' => $this
        ->t('Mini pager'),
      'some' => $this
        ->t('Hide pager (display a fixed number of items)'),
      'none' => $this
        ->t('Hide pager (display all items)'),
    ];
    $form_field['#weight'] = 35;
  }

  /**
   * {@inheritdoc}
   */
  public function alterView(ViewExecutable $view, $value) {
    if (!empty($value)) {
      $pager = $view->display_handler
        ->getOption('pager');
      $pager['type'] = $value;
      $view->display_handler
        ->setOption('pager', $pager);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
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.
ViewsReferencePager::alterFormField	public	function	Get the form field array. Overrides ViewsReferenceSettingInterface::alterFormField
ViewsReferencePager::alterView	public	function	Alter the view object. Overrides ViewsReferenceSettingInterface::alterView