You are here

class Full in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/views/src/Plugin/views/pager/Full.php \Drupal\views\Plugin\views\pager\Full

The plugin to handle full pager.

Plugin annotation


@ViewsPager(
  id = "full",
  title = @Translation("Paged output, full pager"),
  short_title = @Translation("Full"),
  help = @Translation("Paged output, full Drupal style"),
  theme = "pager",
  register_theme = FALSE
)

Hierarchy

Expanded class hierarchy of Full

Related topics

6 string references to 'Full'
core.entity_view_mode.block_content.full.yml in core/modules/block_content/config/install/core.entity_view_mode.block_content.full.yml
core/modules/block_content/config/install/core.entity_view_mode.block_content.full.yml
core.entity_view_mode.entity_test.full.yml in core/modules/system/tests/modules/entity_test/config/install/core.entity_view_mode.entity_test.full.yml
core/modules/system/tests/modules/entity_test/config/install/core.entity_view_mode.entity_test.full.yml
d6_view_modes.yml in core/modules/node/migration_templates/d6_view_modes.yml
core/modules/node/migration_templates/d6_view_modes.yml
d7_view_modes.yml in core/modules/field/migration_templates/d7_view_modes.yml
core/modules/field/migration_templates/d7_view_modes.yml
MigrateViewModesTest::testMigration in core/modules/field/src/Tests/Migrate/d7/MigrateViewModesTest.php
Tests migration of D7 view mode variables to D8 config entities.

... See full list

File

core/modules/views/src/Plugin/views/pager/Full.php, line 26
Contains \Drupal\views\Plugin\views\pager\Full.

Namespace

Drupal\views\Plugin\views\pager
View source
class Full extends SqlBase {

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();

    // Use the same default quantity that core uses by default.
    $options['quantity'] = array(
      'default' => 9,
    );
    $options['tags']['contains']['first'] = array(
      'default' => $this
        ->t('« First'),
    );
    $options['tags']['contains']['last'] = array(
      'default' => $this
        ->t('Last »'),
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['quantity'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Number of pager links visible'),
      '#description' => $this
        ->t('Specify the number of links to pages to display in the pager.'),
      '#default_value' => $this->options['quantity'],
    );
    $form['tags']['first'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('First page link text'),
      '#default_value' => $this->options['tags']['first'],
      '#weight' => -10,
    );
    $form['tags']['last'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Last page link text'),
      '#default_value' => $this->options['tags']['last'],
      '#weight' => 10,
    );
  }

  /**
   * {@inheritdoc}
   */
  public function summaryTitle() {
    if (!empty($this->options['offset'])) {
      return $this
        ->formatPlural($this->options['items_per_page'], '@count item, skip @skip', 'Paged, @count items, skip @skip', array(
        '@count' => $this->options['items_per_page'],
        '@skip' => $this->options['offset'],
      ));
    }
    return $this
      ->formatPlural($this->options['items_per_page'], '@count item', 'Paged, @count items', array(
      '@count' => $this->options['items_per_page'],
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function render($input) {

    // The 0, 1, 3, 4 indexes are correct. See the template_preprocess_pager()
    // documentation.
    $tags = array(
      0 => $this->options['tags']['first'],
      1 => $this->options['tags']['previous'],
      3 => $this->options['tags']['next'],
      4 => $this->options['tags']['last'],
    );
    return array(
      '#theme' => $this
        ->themeFunctions(),
      '#tags' => $tags,
      '#element' => $this->options['id'],
      '#parameters' => $input,
      '#quantity' => $this->options['quantity'],
      '#route_name' => !empty($this->view->live_preview) ? '<current>' : '<none>',
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
Full::buildOptionsForm public function Provide the default form for setting options. Overrides SqlBase::buildOptionsForm
Full::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides SqlBase::defineOptions
Full::render public function Return the renderable array of the pager. Overrides PagerPluginBase::render
Full::summaryTitle public function Return a string to display as the clickable title for the pager plugin. Overrides PagerPluginBase::summaryTitle
PagerPluginBase::$current_page property
PagerPluginBase::$total_items 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. 2
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. 2
PluginBase::$view public property The top object of a view. 1
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 20
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 50
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
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::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::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 5
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.
PluginBase::__construct public function Constructs a PluginBase object. Overrides PluginBase::__construct
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
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
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.