class Some
Same name in other branches
- 9 core/modules/views/src/Plugin/views/pager/Some.php \Drupal\views\Plugin\views\pager\Some
- 8.9.x core/modules/views/src/Plugin/views/pager/Some.php \Drupal\views\Plugin\views\pager\Some
- 10 core/modules/views/src/Plugin/views/pager/Some.php \Drupal\views\Plugin\views\pager\Some
Plugin for views without pagers.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\pager\PagerPluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\pager\Some 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 extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Some
Related topics
66 string references to 'Some'
- CategorizingPluginManagerTraitTest::testProcessDefinitionCategory in core/
tests/ Drupal/ Tests/ Core/ Plugin/ CategorizingPluginManagerTraitTest.php - @covers ::processDefinitionCategory
- DisplayPageTest::testReadMore in core/
modules/ views/ tests/ src/ Kernel/ Plugin/ DisplayPageTest.php - Tests the readmore functionality.
- DisplayPluginBase::defineOptions in core/
modules/ views/ src/ Plugin/ views/ display/ DisplayPluginBase.php - Information about options for all kinds of purposes will be held here.
- PagerTest::testStorePagerSettings in core/
modules/ views/ tests/ src/ Functional/ Plugin/ PagerTest.php - Pagers was sometimes not stored.
- PathParentCacheContextTest::providerTestGetContext in core/
tests/ Drupal/ Tests/ Core/ Cache/ Context/ PathParentCacheContextTest.php - Provides a list of paths and expected cache contexts.
File
-
core/
modules/ views/ src/ Plugin/ views/ pager/ Some.php, line 14
Namespace
Drupal\views\Plugin\views\pagerView source
class Some extends PagerPluginBase {
public function summaryTitle() {
if (!empty($this->options['offset'])) {
return $this->formatPlural($this->options['items_per_page'], '@count item, skip @skip', '@count items, skip @skip', [
'@count' => $this->options['items_per_page'],
'@skip' => $this->options['offset'],
]);
}
return $this->formatPlural($this->options['items_per_page'], '@count item', '@count items', [
'@count' => $this->options['items_per_page'],
]);
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['items_per_page'] = [
'default' => 10,
];
$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);
$pager_text = $this->displayHandler
->getPagerText();
$form['items_per_page'] = [
'#title' => $pager_text['items per page title'],
'#type' => 'number',
'#min' => 0,
'#description' => $pager_text['items per page description'],
'#default_value' => $this->options['items_per_page'],
];
$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 query() {
$this->view->query
->setLimit($this->options['items_per_page']);
$this->view->query
->setOffset($this->options['offset']);
}
/**
* {@inheritdoc}
*/
public function postExecute(&$result) : void {
$this->total_items = count($result);
}
}
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 | |
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::executeCountQuery | public | function | Executes the count query. | 1 | |
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::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::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::init | public | function | Initialize the plugin. | Overrides ViewsPluginInterface::init | 6 |
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 | |
Some::buildOptionsForm | public | function | Provide the default form for setting options. | Overrides PluginBase::buildOptionsForm | |
Some::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides PluginBase::defineOptions | |
Some::postExecute | public | function | Perform any needed actions just after the query executing. | Overrides PagerPluginBase::postExecute | |
Some::query | public | function | Modify the query for paging. | Overrides PagerPluginBase::query | |
Some::summaryTitle | public | function | Returns a string to display as the clickable title for the pager plugin. | Overrides PagerPluginBase::summaryTitle | |
Some::useCountQuery | public | function | Determine if a pager needs a count query. | Overrides PagerPluginBase::useCountQuery | |
Some::usePager | public | function | Determine if this pager actually uses a pager. | Overrides PagerPluginBase::usePager | |
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.