You are here

Home » API reference » Views Load More 8 » LoadMore.php

class LoadMore in Views Load More 8

Same name and namespace in other branches
  1. 2.x src/Plugin/views/pager/LoadMore.php \Drupal\views_load_more\Plugin\views\pager\LoadMore

The plugin to handle full pager.

Plugin annotation


@ViewsPager(
  id = "load_more",
  title = @Translation("Load more pager"),
  short_title = @Translation("Load more"),
  help = @Translation("Paged output, each page loaded via AJAX."),
  theme = "views_load_more_pager",
  register_theme = FALSE
)

Hierarchy

Expanded class hierarchy of LoadMore

1 file declares its use of LoadMore
VLMAppendCommand.php in src/Ajax/VLMAppendCommand.php
Contains \Drupal\views_load_more\Ajax\VLMAppendCommand.

File

src/Plugin/views/pager/LoadMore.php, line 26
Container Drupal\views_load_more\Plugin\views\pager\LoadMore

Namespace

Drupal\views_load_more\Plugin\views\pager
View source 
class LoadMore extends Full {

  /**
   * The default jQuery selector for views content.
   */
  const DEFAULT_CONTENT_SELECTOR = '> .view-content';

  /**
   * The default jQuery selector for view pager.
   */
  const DEFAULT_PAGER_SELECTOR = '.pager--load-more';

  /**
   * Overrides \Drupal\views\Plugin\views\pager\Full::summaryTitle().
   */
  public function summaryTitle() {
    if (!empty($this->options['offset'])) {
      return $this
        ->formatPlural($this->options['items_per_page'], 'Load more pager, @count item, skip @skip', 'Load more pager, @count items, skip @skip', array(
        '@count' => $this->options['items_per_page'],
        '@skip' => $this->options['offset'],
      ));
    }
    return $this
      ->formatPlural($this->options['items_per_page'], 'Load more pager, @count item', 'Load more pager, @count items', array(
      '@count' => $this->options['items_per_page'],
    ));
  }

  /**
   * Overrides \Drupal\views\Plugin\views\Full::defineOptions().
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['more_button_text'] = array(
      'default' => $this
        ->t('Load more'),
    );
    $options['end_text'] = array(
      'default' => '',
    );
    $options['advanced']['contains']['content_selector'] = array(
      'default' => '',
    );
    $options['advanced']['contains']['pager_selector'] = array(
      'default' => '',
    );
    $options['effects']['contains']['type'] = array(
      'default' => '',
    );
    $options['effects']['contains']['speed'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Overrides \Drupal\views\Plugin\views\Full::buildOptionsForm().
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);

    // A couple settings are irrelevant for a Load More pager
    unset($form['tags']);
    unset($form['quantity']);

    // Keep items per page as the first form element on the page followed by
    // the option to change the 'load more' button text
    $form['items_per_page']['#weight'] = -2;

    // Option for users to specify the text used on the 'load more' button.
    $form['more_button_text'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Load more text'),
      '#description' => $this
        ->t('The text that will be displayed on the link that is used to load more elements. For example "Show me more"'),
      '#default_value' => $this->options['more_button_text'] ? $this->options['more_button_text'] : $this
        ->t('Load more'),
    );

    // Option for users to specify the text shown when there are no more results
    $form['end_text'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Finished text'),
      '#description' => $this
        ->t('Optionally specify the text that is shown to the user in place of the pager link when the user has reached the end of the list, eg. "No more results".'),
      '#default_value' => $this->options['end_text'] ? $this->options['end_text'] : '',
    );

    // Adjust exposed details element weight
    $form['expose']['#weight'] = 10;

    // Advanced options, override default selectors.
    $form['advanced'] = array(
      '#type' => 'details',
      '#open' => FALSE,
      '#tree' => TRUE,
      '#title' => $this
        ->t('Advanced Options'),
      '#description' => $this
        ->t('Configure advanced options.'),
      '#weight' => 11,
    );

    // Option to specify the content_selector, which is the wrapping div for views
    // rows.  This allows the JS to both find new rows on next pages and know
    // where to put them in the page.
    $form['advanced']['content_selector'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Content selector'),
      '#description' => $this
        ->t('jQuery selector for the rows wrapper, relative to the view container.  Use when overriding the views markup.  Note that Views Load More requires a wrapping element for the rows.  Unless specified, Views Load More will use <strong><code>@content_selector</code></strong>.', array(
        '@content_selector' => LoadMore::DEFAULT_CONTENT_SELECTOR,
      )),
      '#default_value' => $this->options['advanced']['content_selector'],
    );

    // Option to specify the pager_selector, which is the pager relative to the
    // view container.
    $form['advanced']['pager_selector'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Pager selector'),
      '#description' => $this
        ->t('jQuery selector for the pager, relative to the view container.  Use when overriding the pager markup so that Views Load More knows where to find and how to replace the pager.  Unless specified, Views Load More will use <strong><code>@pager_selector</code></strong>.', array(
        '@pager_selector' => LoadMore::DEFAULT_PAGER_SELECTOR,
      )),
      '#default_value' => $this->options['advanced']['pager_selector'],
    );

    // Affect the way that Views Load More adds new rows
    $form['effects'] = array(
      '#type' => 'details',
      '#open' => FALSE,
      '#tree' => TRUE,
      '#title' => $this
        ->t('JQuery Effects'),
      '#weight' => 12,
    );
    $form['effects']['type'] = array(
      '#type' => 'select',
      '#options' => array(
        '' => $this
          ->t('None'),
        'fadeIn' => $this
          ->t('Fade'),
        'slideDown' => $this
          ->t('Slide'),
      ),
      '#default_vaue' => 'none',
      '#title' => $this
        ->t('Effect Type'),
      '#default_value' => $this->options['effects']['type'],
      '#description' => $this
        ->t('jQuery animation to use to show new rows.'),
    );
    $form['effects']['speed'] = array(
      '#type' => 'select',
      '#options' => array(
        'slow' => $this
          ->t('Slow'),
        'fast' => $this
          ->t('Fast'),
      ),
      '#states' => array(
        'visible' => array(
          array(
            '#edit-pager-options-effects-type' => array(
              'value' => 'fade',
            ),
          ),
          array(
            '#edit-pager-options-effects-type' => array(
              'value' => 'slide',
            ),
          ),
        ),
      ),
      '#title' => $this
        ->t('Effect Speed'),
      '#default_value' => $this->options['effects']['speed'],
    );
  }

  /**
   * {@inheritdoc}
   */
  function render($parameters) {
    $output = array(
      '#theme' => $this
        ->themeFunctions(),
      '#element' => $this->options['id'],
      '#parameters' => $parameters,
      '#more_button_text' => $this->options['more_button_text'],
      '#end_text' => $this->options['end_text'],
    );
    return $output;
  }

}

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
LoadMore::buildOptionsForm public function Overrides \Drupal\views\Plugin\views\Full::buildOptionsForm(). Overrides Full::buildOptionsForm
LoadMore::DEFAULT_CONTENT_SELECTOR constant The default jQuery selector for views content.
LoadMore::DEFAULT_PAGER_SELECTOR constant The default jQuery selector for view pager.
LoadMore::defineOptions protected function Overrides \Drupal\views\Plugin\views\Full::defineOptions(). Overrides Full::defineOptions
LoadMore::render function Return the renderable array of the pager. Overrides Full::render
LoadMore::summaryTitle public function Overrides \Drupal\views\Plugin\views\pager\Full::summaryTitle(). Overrides Full::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::query public function Modify the query for paging Overrides PagerPluginBase::query 83
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.