class None in Drupal 10

Plugin for views without pagers.

Plugin annotation

@ViewsPager(
  id = "none",
  title = @Translation("Display all items"),
  help = @Translation("Display all items that this view might find."),
  display_types = {"basic"}
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
      • class \Drupal\views\Plugin\views\pager\PagerPluginBase
        • class \Drupal\views\Plugin\views\pager\None

Related topics

Views pager plugins

Plugins to handle paging in views.

1 file declares its use of None

ViewExecutableTest.php in core/modules/views/tests/src/Unit/ViewExecutableTest.php

27 string references to 'None'

Block::optionsSummary in core/modules/views/src/Plugin/views/display/Block.php

Provide the summary for page options in the views UI.

BreadcrumbTest::testSetLinks in core/tests/Drupal/Tests/Core/Breadcrumb/BreadcrumbTest.php

@covers ::setLinks

CKEditorAdminTest::testExistingFormat in core/modules/ckeditor/tests/src/Functional/CKEditorAdminTest.php

Tests configuring a text editor for an existing text format.

CKEditorAdminTest::testNewFormat in core/modules/ckeditor/tests/src/Functional/CKEditorAdminTest.php

Tests configuring a text editor for a new text format.

ConfigFormTestBase::testConfigForm in core/tests/Drupal/KernelTests/ConfigFormTestBase.php

Submit the system_config_form ensure the configuration has expected values.

... See full list

File

core/modules/views/src/Plugin/views/pager/None.php, line 21

Namespace

Drupal\views\Plugin\views\pager

class None extends PagerPluginBase {

  /**
   * {@inheritdoc}
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);

    // If the pager is set to none, then it should show all items.
    $this
      ->setItemsPerPage(0);
  }
  public function summaryTitle() {
    if (!empty($this->options['offset'])) {
      return $this
        ->t('All items, skip @skip', [
        '@skip' => $this->options['offset'],
      ]);
    }
    return $this
      ->t('All items');
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['offset'] = [
      'default' => 0,
    ];
    return $options;
  }

  /**
   * Provide the default form for setting options.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['offset'] = [
      '#type' => 'number',
      '#min' => 0,
      '#title' => $this
        ->t('Offset (number of items to skip)'),
      '#description' => $this
        ->t('For example, set this to 3 and the first 3 items will not be displayed.'),
      '#default_value' => $this->options['offset'],
    ];
  }
  public function usePager() {
    return FALSE;
  }
  public function useCountQuery() {
    return FALSE;
  }
  public function getItemsPerPage() {
    return 0;
  }
  public function executeCountQuery(&$count_query) {

    // If we are displaying all items, never count. But we can update the count in post_execute.
  }
  public function postExecute(&$result) {
    $this->total_items = count($result);
  }
  public function query() {

    // The only query modifications we might do are offsets.
    if (!empty($this->options['offset'])) {
      $this->view->query
        ->setOffset($this->options['offset']);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
MessengerTrait::setMessenger	public	function	Sets the messenger.
None::buildOptionsForm	public	function	Provide the default form for setting options. Overrides PluginBase::buildOptionsForm
None::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides PluginBase::defineOptions
None::executeCountQuery	public	function	Execute the count query, which will be done just prior to the query itself being executed. Overrides PagerPluginBase::executeCountQuery
None::getItemsPerPage	public	function	Get how many items per page this pager will display. Overrides PagerPluginBase::getItemsPerPage
None::init	public	function	Initialize the plugin. Overrides PluginBase::init
None::postExecute	public	function	Perform any needed actions just after the query executing. Overrides PagerPluginBase::postExecute
None::query	public	function	Modify the query for paging. Overrides PagerPluginBase::query
None::summaryTitle	public	function	Return a string to display as the clickable title for the pager plugin. Overrides PagerPluginBase::summaryTitle
None::useCountQuery	public	function	Determine if a pager needs a count query. Overrides PagerPluginBase::useCountQuery
None::usePager	public	function	Determine if this pager actually uses a pager. Overrides PagerPluginBase::usePager
PagerPluginBase::$current_page	public	property
PagerPluginBase::$total_items	public	property
PagerPluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
PagerPluginBase::exposedFormAlter	public	function		1
PagerPluginBase::exposedFormSubmit	public	function
PagerPluginBase::exposedFormValidate	public	function		1
PagerPluginBase::getCurrentPage	public	function	Get the current page.
PagerPluginBase::getOffset	public	function	Get the page offset, or how many items to skip.
PagerPluginBase::getPagerId	public	function	Get the pager id, if it exists.
PagerPluginBase::getTotalItems	public	function	Get the total number of items.
PagerPluginBase::hasMoreRecords	public	function	Determine if there are more records available.
PagerPluginBase::isOffsetExposed	protected	function		1
PagerPluginBase::itemsPerPageExposed	protected	function		1
PagerPluginBase::preExecute	public	function	Perform any needed actions just prior to the query executing.
PagerPluginBase::preRender	public	function	Perform any needed actions just before rendering.
PagerPluginBase::render	public	function	Return the renderable array of the pager.	2
PagerPluginBase::setCurrentPage	public	function	Set the current page.	1
PagerPluginBase::setItemsPerPage	public	function	Set how many items per page this pager will display.
PagerPluginBase::setOffset	public	function	Set the page offset, or how many items to skip.
PagerPluginBase::submitOptionsForm	public	function	Provide the default form for submitting options. Overrides PluginBase::submitOptionsForm
PagerPluginBase::updatePageInfo	public	function	If there are pagers that need global values set, this method can be used to set them. It will be called after the query is run.	1
PagerPluginBase::usesExposed	public	function		1
PagerPluginBase::validateOptionsForm	public	function	Provide the default form for validating options. Overrides PluginBase::validateOptionsForm	1
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition.
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.
PluginBase::$view	public	property	The top object of a view.
PluginBase::calculateDependencies	public	function		4
PluginBase::create	public static	function		7
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy	public	function		1
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function
PluginBase::getAvailableGlobalTokens	public	function
PluginBase::getBaseId	public	function
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::getProvider	public	function
PluginBase::getRenderer	protected	function	Returns the render API renderer.
PluginBase::globalTokenForm	public	function
PluginBase::globalTokenReplace	public	function
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function
PluginBase::preRenderAddFieldsetMarkup	public static	function
PluginBase::preRenderFlattenData	public static	function
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::themeFunctions	public	function
PluginBase::trustedCallbacks	public static	function		1
PluginBase::unpackOptions	public	function
PluginBase::usesOptions	public	function		6
PluginBase::validate	public	function		2
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
PluginBase::__construct	public	function	Constructs a PluginBase object.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	3
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.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.