You are here

Home » API reference » Views Infinite Scroll 8 » InfiniteScroll.php

class InfiniteScroll in Views Infinite Scroll 8

Views pager plugin to handle infinite scrolling.

Plugin annotation


@ViewsPager(
 id = "infinite_scroll",
 title = @Translation("Infinite Scroll"),
 short_title = @Translation("Infinite Scroll"),
 help = @Translation("A views plugin which provides infinte scroll."),
 theme = "views_infinite_scroll_pager"
)

Hierarchy

Expanded class hierarchy of InfiniteScroll

1 file declares its use of InfiniteScroll
views_infinite_scroll.module in ./views_infinite_scroll.module
Module file for views_infinite_scroll.

File

src/Plugin/views/pager/InfiniteScroll.php, line 19

Namespace

Drupal\views_infinite_scroll\Plugin\views\pager
View source 
class InfiniteScroll extends SqlBase {

  /**
   * {@inheritdoc}
   */
  public function render($input) {
    $this
      ->updatePageInfo();

    // Replace tokens in the button text.
    $text = $this->options['views_infinite_scroll']['button_text'];
    if (!empty($text) && strpos($text, '@') !== FALSE) {
      $replacements = [
        '@next_page_count' => $this
          ->getNumberItemsLeft(),
        '@remaining_items_count' => $this
          ->getRemainingNumberItems(),
        '@total' => (int) $this
          ->getTotalItems(),
      ];
      $this->options['views_infinite_scroll']['button_text'] = strtr($text, $replacements);
    }
    return [
      '#theme' => $this
        ->themeFunctions(),
      '#options' => $this->options['views_infinite_scroll'],
      '#view' => $this->view,
      '#attached' => [
        'library' => [
          'views_infinite_scroll/views-infinite-scroll',
        ],
      ],
      '#element' => $this->options['id'],
      '#parameters' => $input,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function defineOptions() {
    $options = parent::defineOptions();
    $options['views_infinite_scroll'] = [
      'contains' => [
        'button_text' => [
          'default' => $this
            ->t('Load More'),
        ],
        'automatically_load_content' => [
          'default' => FALSE,
        ],
        'initially_load_all_pages' => [
          'default' => FALSE,
        ],
      ],
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function summaryTitle() {
    $action = $this->options['views_infinite_scroll']['automatically_load_content'] ? $this
      ->t('Automatic infinite scroll') : $this
      ->t('Click to load');
    $pages = $this->options['views_infinite_scroll']['initially_load_all_pages'] ? $this
      ->t('Initially load all pages') : $this
      ->t('Initially load one page');
    return $this
      ->formatPlural($this->options['items_per_page'], '@action, @count item', '@action, @count items, @pages', [
      '@action' => $action,
      '@count' => $this->options['items_per_page'],
      '@pages' => $pages,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['tags']['#access'] = FALSE;
    $options = $this->options['views_infinite_scroll'];
    $form['views_infinite_scroll'] = [
      '#title' => $this
        ->t('Infinite Scroll Options'),
      '#description' => $this
        ->t('Note: The infinite scroll option overrides and requires the <em>Use AJAX</em> setting for this views display.'),
      '#type' => 'details',
      '#open' => TRUE,
      '#tree' => TRUE,
      '#input' => TRUE,
      '#weight' => -100,
      'button_text' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Button Text'),
        '#default_value' => $options['button_text'],
        '#description' => [
          '#theme' => 'item_list',
          '#items' => [
            '@next_page_count -- the next page record count',
            '@remaining_items_count -- the remaining amount of results',
            '@total -- the total amount of results returned from the view',
          ],
          '#prefix' => $this
            ->t('The following tokens are supported:'),
        ],
      ],
      'automatically_load_content' => [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Automatically Load Content'),
        '#description' => $this
          ->t('Automatically load subsequent pages as the user scrolls.'),
        '#default_value' => $options['automatically_load_content'],
      ],
      'initially_load_all_pages' => [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Initially load all pages up to the requested page'),
        '#description' => $this
          ->t('When initially loading a page beyond the first, this option will load all pages up to the requested page instead of just the requested page. So, if you have the pager set to 10 items per page, and you load the page with ?page=2 in the url, you will get page 0, 1 and 2 loaded for a total of 30 items. <em>Note that this could cause some long page load times when loading many pages.</em>'),
        '#default_value' => $options['initially_load_all_pages'],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function query() {

    // Run the pant method which is sufficient if we're on the first page.
    parent::query();

    // If configured, for pages beyond the first, we want to show all items up
    // to the current page.
    if ($this->options['views_infinite_scroll']['initially_load_all_pages'] && !\Drupal::request()
      ->isXmlHttpRequest() && $this->current_page > 0) {
      $limit = ($this->current_page + 1) * $this->options['items_per_page'];
      $offset = $this->options['offset'];
      $this->view->query
        ->setLimit($limit);
      $this->view->query
        ->setOffset($offset);
    }
  }

  /**
   * Returns the number of items in the next page.
   *
   * @return int
   *   The number of items in the next page.
   */
  protected function getNumberItemsLeft() {
    $items_per_page = (int) $this->view
      ->getItemsPerPage();
    $total = (int) $this
      ->getTotalItems();
    $current_page = (int) $this
      ->getCurrentPage() + 1;

    // Default to the pager amount.
    $next_page_count = $items_per_page;

    // Calculate the remaining items if we are at the 2nd to last page.
    if ($current_page >= ceil($total / $items_per_page) - 1) {
      $next_page_count = $total - $current_page * $items_per_page;
      return $next_page_count;
    }
    return $next_page_count;
  }

  /**
   * Returns the number of items remaining over the next pages.
   *
   * @return int
   *   The number of items over the remaining pages.
   */
  protected function getRemainingNumberItems() {
    $items_per_page = (int) $this->view
      ->getItemsPerPage();
    $total = (int) $this
      ->getTotalItems();
    $current_page = (int) $this
      ->getCurrentPage() + 1;
    return $total - $current_page * $items_per_page;
  }

}

Members

Namesort descending Modifiers Type Description 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 1
DependencySerializationTrait::__wakeup public function 2
InfiniteScroll::buildOptionsForm public function Provide the default form for setting options. Overrides SqlBase::buildOptionsForm
InfiniteScroll::defineOptions public function Information about options for all kinds of purposes will be held here. Overrides SqlBase::defineOptions
InfiniteScroll::getNumberItemsLeft protected function Returns the number of items in the next page.
InfiniteScroll::getRemainingNumberItems protected function Returns the number of items remaining over the next pages.
InfiniteScroll::query public function Modify the query for paging Overrides SqlBase::query
InfiniteScroll::render public function Return the renderable array of the pager. Overrides PagerPluginBase::render
InfiniteScroll::summaryTitle public function Return a string to display as the clickable title for the pager plugin. Overrides PagerPluginBase::summaryTitle
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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::executeCountQuery public function Execute the count query, which will be done just prior to the query itself being executed. 1
PagerPluginBase::exposedFormSubmit public function
PagerPluginBase::getCurrentPage public function Get the current page.
PagerPluginBase::getItemsPerPage public function Get how many items per page this pager will display. 1
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::postExecute public function Perform any needed actions just after the query executing. 2
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::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 form for submitting options Overrides PluginBase::submitOptionsForm
PagerPluginBase::useCountQuery public function Determine if a pager needs a count query. 3
PagerPluginBase::usePager public function Determine if this pager actually uses a pager. 2
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. 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::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 3
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::init public function Initialize the plugin. Overrides ViewsPluginInterface::init 8
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 Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. 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. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
SqlBase::$pagerManager protected property The pager manager.
SqlBase::$pagerParameters protected property The pager parameters.
SqlBase::create public static function Creates an instance of the plugin. Overrides PluginBase::create
SqlBase::exposedFormAlter public function Overrides PagerPluginBase::exposedFormAlter
SqlBase::exposedFormValidate public function Overrides PagerPluginBase::exposedFormValidate
SqlBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
SqlBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
SqlBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
SqlBase::getPagerTotal public function
SqlBase::isOffsetExposed protected function Overrides PagerPluginBase::isOffsetExposed
SqlBase::itemsPerPageExposed protected function Overrides PagerPluginBase::itemsPerPageExposed
SqlBase::setCurrentPage public function Set the current page. Overrides PagerPluginBase::setCurrentPage
SqlBase::updatePageInfo public function Update global paging info. Overrides PagerPluginBase::updatePageInfo
SqlBase::usesExposed public function Overrides PagerPluginBase::usesExposed
SqlBase::validateOptionsForm public function Provide the default form form for validating options Overrides PagerPluginBase::validateOptionsForm
SqlBase::__construct public function Constructs a SqlBase object. Overrides PluginBase::__construct
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.
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.