class None
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 \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\views\Plugin\views\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface extends \Drupal\Core\Plugin\PluginBase- class \Drupal\views\Plugin\views\pager\PagerPluginBase extends \Drupal\views\Plugin\views\PluginBase- class \Drupal\views\Plugin\views\pager\None extends \Drupal\views\Plugin\views\pager\PagerPluginBase
 
 
- class \Drupal\views\Plugin\views\pager\PagerPluginBase extends \Drupal\views\Plugin\views\PluginBase
 
- class \Drupal\views\Plugin\views\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of None
Related topics
1 file declares its use of None
- ViewExecutableTest.php in core/modules/ views/ tests/ src/ Unit/ ViewExecutableTest.php 
487 string references to 'None'
- AccessRoleUITest::testAccessRoleUI in core/modules/ user/ tests/ src/ Functional/ AccessRoleUITest.php 
- Tests the role access plugin UI.
- AjaxTestController::getRenderTypes in core/modules/ system/ tests/ modules/ ajax_test/ src/ Controller/ AjaxTestController.php 
- Render types.
- AreaDisplayLinkTest::setUp in core/modules/ views/ tests/ src/ Kernel/ Handler/ AreaDisplayLinkTest.php 
- AreaDisplayLinkTest::testAreaDisplayLink in core/modules/ views/ tests/ src/ Kernel/ Handler/ AreaDisplayLinkTest.php 
- Tests the views area display_link handler.
- AreaResultTest::testResultEmpty in core/modules/ views/ tests/ src/ Kernel/ Handler/ AreaResultTest.php 
- Tests the results area handler.
File
- 
              core/modules/ views/ src/ Plugin/ views/ pager/ None.php, line 21 
Namespace
Drupal\views\Plugin\views\pagerView source
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
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
| 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 | Executes the count query. | 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 | Returns 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 | Updates the pager information. | 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' 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. | 1 | |
| PluginBase::$pluginId | protected | property | The plugin_id. | ||
| PluginBase::$renderer | protected | property | Stores the render API renderer. | 3 | |
| PluginBase::$view | public | property | The top object of a view. | 1 | |
| PluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 14 | 
| PluginBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 63 | 
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||
| PluginBase::destroy | public | function | Clears a plugin. | Overrides ViewsPluginInterface::destroy | 2 | 
| PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | ||
| PluginBase::filterByDefinedOptions | public | function | Filter out stored options depending on the defined options. | Overrides ViewsPluginInterface::filterByDefinedOptions | |
| PluginBase::getAvailableGlobalTokens | public | function | Returns an array of available token replacements. | Overrides ViewsPluginInterface::getAvailableGlobalTokens | |
| 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 | 2 | 
| PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
| PluginBase::getProvider | public | function | Returns the plugin provider. | Overrides ViewsPluginInterface::getProvider | |
| PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | |
| PluginBase::globalTokenForm | public | function | Adds elements for available core tokens to a form. | Overrides ViewsPluginInterface::globalTokenForm | |
| PluginBase::globalTokenReplace | public | function | Returns a string with any core tokens replaced. | Overrides ViewsPluginInterface::globalTokenReplace | |
| 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 | Return the human readable name of the display. | Overrides ViewsPluginInterface::pluginTitle | |
| PluginBase::preRenderAddFieldsetMarkup | public static | function | Moves form elements into fieldsets for presentation purposes. | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | |
| PluginBase::preRenderFlattenData | public static | function | Flattens the structure of form elements. | Overrides ViewsPluginInterface::preRenderFlattenData | |
| 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 | Provide a full list of possible theme templates used by this style. | Overrides ViewsPluginInterface::themeFunctions | 1 | 
| PluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides TrustedCallbackInterface::trustedCallbacks | 6 | 
| PluginBase::unpackOptions | public | function | Unpacks options over our existing defaults. | Overrides ViewsPluginInterface::unpackOptions | |
| PluginBase::usesOptions | public | function | Returns the usesOptions property. | Overrides ViewsPluginInterface::usesOptions | 8 | 
| PluginBase::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides ViewsPluginInterface::validate | 6 | 
| PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | |
| PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | |||
| PluginBase::__construct | public | function | Constructs a PluginBase object. | Overrides PluginBase::__construct | 19 | 
| 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. | 2 | |
| 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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
