class None

Same name in this branch
  1. 11.x core/modules/views/src/Plugin/views/argument_validator/None.php \Drupal\views\Plugin\views\argument_validator\None
  2. 11.x core/modules/views/src/Plugin/views/cache/None.php \Drupal\views\Plugin\views\cache\None
  3. 11.x core/modules/views/src/Plugin/views/access/None.php \Drupal\views\Plugin\views\access\None
Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/argument_validator/None.php \Drupal\views\Plugin\views\argument_validator\None
  2. 9 core/modules/views/src/Plugin/views/cache/None.php \Drupal\views\Plugin\views\cache\None
  3. 9 core/modules/views/src/Plugin/views/access/None.php \Drupal\views\Plugin\views\access\None
  4. 9 core/modules/views/src/Plugin/views/pager/None.php \Drupal\views\Plugin\views\pager\None
  5. 8.9.x core/modules/views/src/Plugin/views/argument_validator/None.php \Drupal\views\Plugin\views\argument_validator\None
  6. 8.9.x core/modules/views/src/Plugin/views/cache/None.php \Drupal\views\Plugin\views\cache\None
  7. 8.9.x core/modules/views/src/Plugin/views/access/None.php \Drupal\views\Plugin\views\access\None
  8. 8.9.x core/modules/views/src/Plugin/views/pager/None.php \Drupal\views\Plugin\views\pager\None
  9. 10 core/modules/views/src/Plugin/views/argument_validator/None.php \Drupal\views\Plugin\views\argument_validator\None
  10. 10 core/modules/views/src/Plugin/views/cache/None.php \Drupal\views\Plugin\views\cache\None
  11. 10 core/modules/views/src/Plugin/views/access/None.php \Drupal\views\Plugin\views\access\None
  12. 10 core/modules/views/src/Plugin/views/pager/None.php \Drupal\views\Plugin\views\pager\None

Plugin for views without pagers.

Hierarchy

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
515 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.

... See full list

File

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

Namespace

Drupal\views\Plugin\views\pager
View 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
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
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::$headingOptions protected property Options available for setting pagination headers.
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::getHeadingLevel public function Get the pager heading tag.
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::setHeadingLevel public function Set the pager heading.
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::$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::$position public property The handler position.
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 61
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::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::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. 19
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.