class StringArgument
Same name in other branches
- 9 core/modules/views/src/Plugin/views/argument/StringArgument.php \Drupal\views\Plugin\views\argument\StringArgument
- 10 core/modules/views/src/Plugin/views/argument/StringArgument.php \Drupal\views\Plugin\views\argument\StringArgument
- 11.x core/modules/views/src/Plugin/views/argument/StringArgument.php \Drupal\views\Plugin\views\argument\StringArgument
Basic argument handler to implement string arguments that may have length limits.
Plugin annotation
@ViewsArgument("string");
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\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\argument\ArgumentPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- class \Drupal\views\Plugin\views\argument\StringArgument extends \Drupal\views\Plugin\views\argument\ArgumentPluginBase
- class \Drupal\views\Plugin\views\argument\ArgumentPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- 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 StringArgument
Related topics
2 files declare their use of StringArgument
- StringListField.php in core/
modules/ options/ src/ Plugin/ views/ argument/ StringListField.php - Type.php in core/
modules/ node/ src/ Plugin/ views/ argument/ Type.php
File
-
core/
modules/ views/ src/ Plugin/ views/ argument/ StringArgument.php, line 20
Namespace
Drupal\views\Plugin\views\argumentView source
class StringArgument extends ArgumentPluginBase {
/**
* {@inheritdoc}
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
parent::init($view, $display, $options);
if (!empty($this->definition['many to one'])) {
$this->helper = new ManyToOneHelper($this);
// Ensure defaults for these, during summaries and stuff:
$this->operator = 'or';
$this->value = [];
}
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['glossary'] = [
'default' => FALSE,
];
$options['limit'] = [
'default' => 0,
];
$options['case'] = [
'default' => 'none',
];
$options['path_case'] = [
'default' => 'none',
];
$options['transform_dash'] = [
'default' => FALSE,
];
$options['break_phrase'] = [
'default' => FALSE,
];
if (!empty($this->definition['many to one'])) {
$options['add_table'] = [
'default' => FALSE,
];
$options['require_value'] = [
'default' => FALSE,
];
}
return $options;
}
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$form['glossary'] = [
'#type' => 'checkbox',
'#title' => $this->t('Glossary mode'),
'#description' => $this->t('Glossary mode applies a limit to the number of characters used in the filter value, which allows the summary view to act as a glossary.'),
'#default_value' => $this->options['glossary'],
'#group' => 'options][more',
];
$form['limit'] = [
'#type' => 'textfield',
'#title' => $this->t('Character limit'),
'#description' => $this->t('How many characters of the filter value to filter against. If set to 1, all fields starting with the first letter in the filter value would be matched.'),
'#default_value' => $this->options['limit'],
'#states' => [
'visible' => [
':input[name="options[glossary]"]' => [
'checked' => TRUE,
],
],
],
'#group' => 'options][more',
];
$form['case'] = [
'#type' => 'select',
'#title' => $this->t('Case'),
'#description' => $this->t('When printing the title and summary, how to transform the case of the filter value.'),
'#options' => [
'none' => $this->t('No transform'),
'upper' => $this->t('Upper case'),
'lower' => $this->t('Lower case'),
'ucfirst' => $this->t('Capitalize first letter'),
'ucwords' => $this->t('Capitalize each word'),
],
'#default_value' => $this->options['case'],
'#group' => 'options][more',
];
$form['path_case'] = [
'#type' => 'select',
'#title' => $this->t('Case in path'),
'#description' => $this->t('When printing URL paths, how to transform the case of the filter value. Do not use this unless with Postgres as it uses case sensitive comparisons.'),
'#options' => [
'none' => $this->t('No transform'),
'upper' => $this->t('Upper case'),
'lower' => $this->t('Lower case'),
'ucfirst' => $this->t('Capitalize first letter'),
'ucwords' => $this->t('Capitalize each word'),
],
'#default_value' => $this->options['path_case'],
'#group' => 'options][more',
];
$form['transform_dash'] = [
'#type' => 'checkbox',
'#title' => $this->t('Transform spaces to dashes in URL'),
'#default_value' => $this->options['transform_dash'],
'#group' => 'options][more',
];
if (!empty($this->definition['many to one'])) {
$form['add_table'] = [
'#type' => 'checkbox',
'#title' => $this->t('Allow multiple filter values to work together'),
'#description' => $this->t('If selected, multiple instances of this filter can work together, as though multiple values were supplied to the same filter. This setting is not compatible with the "Reduce duplicates" setting.'),
'#default_value' => !empty($this->options['add_table']),
'#group' => 'options][more',
];
$form['require_value'] = [
'#type' => 'checkbox',
'#title' => $this->t('Do not display items with no value in summary'),
'#default_value' => !empty($this->options['require_value']),
'#group' => 'options][more',
];
}
// allow + for or, , for and
$form['break_phrase'] = [
'#type' => 'checkbox',
'#title' => $this->t('Allow multiple values'),
'#description' => $this->t('If selected, users can enter multiple values in the form of 1+2+3 (for OR) or 1,2,3 (for AND).'),
'#default_value' => !empty($this->options['break_phrase']),
'#group' => 'options][more',
];
}
/**
* Build the summary query based on a string
*/
protected function summaryQuery() {
if (empty($this->definition['many to one'])) {
$this->ensureMyTable();
}
else {
$this->tableAlias = $this->helper
->summaryJoin();
}
if (empty($this->options['glossary'])) {
// Add the field.
$this->base_alias = $this->query
->addField($this->tableAlias, $this->realField);
$this->query
->setCountField($this->tableAlias, $this->realField);
}
else {
// Add the field.
$formula = $this->getFormula();
$this->base_alias = $this->query
->addField(NULL, $formula, $this->field . '_truncated');
$this->query
->setCountField(NULL, $formula, $this->field, $this->field . '_truncated');
}
$this->summaryNameField();
return $this->summaryBasics(FALSE);
}
/**
* Get the formula for this argument.
*
* $this->ensureMyTable() MUST have been called prior to this.
*/
public function getFormula() {
$formula = "SUBSTRING({$this->tableAlias}.{$this->realField}, 1, " . intval($this->options['limit']) . ")";
if ($this->options['case'] != 'none') {
// Support case-insensitive substring comparisons for SQLite by using the
// 'NOCASE_UTF8' collation.
// @see Drupal\Core\Database\Driver\sqlite\Connection::open()
if (Database::getConnection()->databaseType() == 'sqlite') {
$formula .= ' COLLATE NOCASE_UTF8';
}
// Support case-insensitive substring comparisons for PostgreSQL by
// converting the formula to lowercase.
if (Database::getConnection()->databaseType() == 'pgsql') {
$formula = 'LOWER(' . $formula . ')';
}
}
return $formula;
}
/**
* Build the query based upon the formula
*/
public function query($group_by = FALSE) {
$argument = $this->argument;
if (!empty($this->options['transform_dash'])) {
$argument = strtr($argument, '-', ' ');
}
if (!empty($this->options['break_phrase'])) {
$this->unpackArgumentValue();
}
else {
$this->value = [
$argument,
];
$this->operator = 'or';
}
// Support case-insensitive substring comparisons for PostgreSQL by
// converting the arguments to lowercase.
if ($this->options['case'] != 'none' && Database::getConnection()->databaseType() == 'pgsql') {
foreach ($this->value as $key => $value) {
$this->value[$key] = mb_strtolower($value);
}
}
if (!empty($this->definition['many to one'])) {
if (!empty($this->options['glossary'])) {
$this->helper->formula = TRUE;
}
$this->helper
->ensureMyTable();
$this->helper
->addFilter();
return;
}
$this->ensureMyTable();
$formula = FALSE;
if (empty($this->options['glossary'])) {
$field = "{$this->tableAlias}.{$this->realField}";
}
else {
$formula = TRUE;
$field = $this->getFormula();
}
if (count($this->value) > 1) {
$operator = 'IN';
$argument = $this->value;
}
else {
$operator = '=';
}
if ($formula) {
$placeholder = $this->placeholder();
if ($operator == 'IN') {
$field .= " IN({$placeholder})";
}
else {
$field .= ' = ' . $placeholder;
}
$placeholders = [
$placeholder => $argument,
];
$this->query
->addWhereExpression(0, $field, $placeholders);
}
else {
$this->query
->addWhere(0, $field, $argument, $operator);
}
}
public function summaryArgument($data) {
$value = $this->caseTransform($data->{$this->base_alias}, $this->options['path_case']);
if (!empty($this->options['transform_dash'])) {
$value = strtr($value, ' ', '-');
}
return $value;
}
/**
* {@inheritdoc}
*/
public function getSortName() {
return $this->t('Alphabetical', [], [
'context' => 'Sort order',
]);
}
public function title() {
// Support case-insensitive title comparisons for PostgreSQL by converting
// the title to lowercase.
if ($this->options['case'] != 'none' && Database::getConnection()->databaseType() == 'pgsql') {
$this->options['case'] = 'lower';
}
$this->argument = $this->caseTransform($this->argument, $this->options['case']);
if (!empty($this->options['transform_dash'])) {
$this->argument = strtr($this->argument, '-', ' ');
}
if (!empty($this->options['break_phrase'])) {
$this->unpackArgumentValue();
}
else {
$this->value = [
$this->argument,
];
$this->operator = 'or';
}
if (empty($this->value)) {
return !empty($this->definition['empty field name']) ? $this->definition['empty field name'] : $this->t('Uncategorized');
}
if ($this->value === [
-1,
]) {
return !empty($this->definition['invalid input']) ? $this->definition['invalid input'] : $this->t('Invalid input');
}
return implode($this->operator == 'or' ? ' + ' : ', ', $this->titleQuery());
}
/**
* Override for specific title lookups.
*/
public function titleQuery() {
return $this->value;
}
public function summaryName($data) {
return $this->caseTransform(parent::summaryName($data), $this->options['case']);
}
/**
* {@inheritdoc}
*/
public function getContextDefinition() {
if ($context_definition = parent::getContextDefinition()) {
return $context_definition;
}
// If the parent does not provide a context definition through the
// validation plugin, fall back to the string type.
return new ContextDefinition('string', $this->adminLabel(), FALSE);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ArgumentPluginBase::$argument | public | property | |||
ArgumentPluginBase::$name_field | public | property | The field to use for the name to use in the summary, which is the displayed output. For example, for the node: nid argument, the argument itself is the nid, but node.title is displayed. |
||
ArgumentPluginBase::$name_table | public | property | The table to use for the name, should it not be in the same table as the argument. | ||
ArgumentPluginBase::$validator | public | property | |||
ArgumentPluginBase::$value | public | property | 1 | ||
ArgumentPluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides HandlerBase::calculateDependencies | |
ArgumentPluginBase::decodeValidatorId | public static | function | Revert sanitized validator options. | ||
ArgumentPluginBase::defaultAccessDenied | public | function | Default action: access denied. | ||
ArgumentPluginBase::defaultAction | public | function | Handle the default action, which means our argument wasn't present. | ||
ArgumentPluginBase::defaultActions | protected | function | Provide a list of default behaviors for this argument if the argument is not present. |
3 | |
ArgumentPluginBase::defaultArgumentForm | public | function | Provide a form for selecting the default argument when the default action is set to provide default argument. |
1 | |
ArgumentPluginBase::defaultDefault | protected | function | This just returns true. The view argument builder will know where to find the argument from. |
||
ArgumentPluginBase::defaultEmpty | public | function | Default action: empty | ||
ArgumentPluginBase::defaultIgnore | public | function | Default action: ignore. | ||
ArgumentPluginBase::defaultNotFound | protected | function | Default action: not found. | ||
ArgumentPluginBase::defaultSummary | protected | function | Default action: summary. | ||
ArgumentPluginBase::defaultSummaryForm | public | function | Provide a form for selecting further summary options when the default action is set to display one. |
||
ArgumentPluginBase::encodeValidatorId | public static | function | Sanitize validator options including derivatives with : for js. | ||
ArgumentPluginBase::exceptionTitle | public | function | |||
ArgumentPluginBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | |
ArgumentPluginBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | |
ArgumentPluginBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | |
ArgumentPluginBase::getDefaultArgument | public | function | Get a default argument, if available. | 1 | |
ArgumentPluginBase::getPlugin | public | function | Get the display or row plugin, if it exists. | ||
ArgumentPluginBase::getTitle | public | function | Called by the view object to get the title. This may be set by a validator so we don't necessarily call through to title(). |
||
ArgumentPluginBase::getTokenHelp | protected | function | Provide token help information for the argument. | ||
ArgumentPluginBase::getValue | public | function | Get the value of this argument. | ||
ArgumentPluginBase::hasDefaultArgument | public | function | Determine if the argument is set to provide a default argument. | ||
ArgumentPluginBase::isException | public | function | |||
ArgumentPluginBase::needsStylePlugin | public | function | Determine if the argument needs a style plugin. | ||
ArgumentPluginBase::preRenderMoveArgumentOptions | public static | function | Moves argument options into their place. | ||
ArgumentPluginBase::processContainerRadios | public static | function | Custom form radios process function. | ||
ArgumentPluginBase::processSummaryArguments | public | function | Process the summary arguments for display. | ||
ArgumentPluginBase::setArgument | public | function | Set the input for this argument | ||
ArgumentPluginBase::submitOptionsForm | public | function | Handle any special handling on the validate form. | Overrides PluginBase::submitOptionsForm | |
ArgumentPluginBase::summaryBasics | public | function | Some basic summary behavior that doesn't need to be repeated as much as code that goes into summaryQuery() |
||
ArgumentPluginBase::summaryNameField | protected | function | Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric. |
||
ArgumentPluginBase::summarySort | public | function | Sorts the summary based upon the user's selection. The base variant of this is usually adequate. |
||
ArgumentPluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides PluginBase::trustedCallbacks | |
ArgumentPluginBase::unpackArgumentValue | protected | function | Splits an argument into value and operator properties on this instance. | ||
ArgumentPluginBase::validateArgument | public | function | Validate that this argument works. By default, all arguments are valid. | ||
ArgumentPluginBase::validateFail | public | function | How to act if validation fails. | ||
ArgumentPluginBase::validateMenuArgument | public | function | Called by the menu system to validate an argument. | ||
ArgumentPluginBase::validateOptionsForm | public | function | Validate the options form. | Overrides PluginBase::validateOptionsForm | |
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 | |
HandlerBase::$field | public | property | With field you can override the realField if the real field is not set. | ||
HandlerBase::$moduleHandler | protected | property | The module handler. | 3 | |
HandlerBase::$query | public | property | Where the $query object will reside: | 7 | |
HandlerBase::$realField | public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. |
||
HandlerBase::$relationship | public | property | The relationship used for this field. | ||
HandlerBase::$table | public | property | The table this handler is attached to. | ||
HandlerBase::$tableAlias | public | property | The alias of the table of this handler which is used in the query. | ||
HandlerBase::$viewsData | protected | property | The views data service. | ||
HandlerBase::acceptExposedInput | public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | |
HandlerBase::access | public | function | Check whether given user has access to this handler. | Overrides ViewsHandlerInterface::access | 4 |
HandlerBase::adminLabel | public | function | Return a string representing this handler's name in the UI. | Overrides ViewsHandlerInterface::adminLabel | 4 |
HandlerBase::adminSummary | public | function | Provide text for the administrative summary. | Overrides ViewsHandlerInterface::adminSummary | 4 |
HandlerBase::breakString | public static | function | Breaks x,y,z and x+y+z into an array. | Overrides ViewsHandlerInterface::breakString | |
HandlerBase::broken | public | function | Determines if the handler is considered 'broken', meaning it's a placeholder used when a handler can't be found. |
Overrides ViewsHandlerInterface::broken | |
HandlerBase::buildExposedForm | public | function | Render our chunk of the exposed handler form when selecting | 1 | |
HandlerBase::buildExposeForm | public | function | Form for exposed handler options. | 2 | |
HandlerBase::buildExtraOptionsForm | public | function | Provide a form for setting options. | 1 | |
HandlerBase::buildGroupByForm | public | function | Provide a form for aggregation settings. | 1 | |
HandlerBase::canExpose | public | function | Determine if a handler can be exposed. | 2 | |
HandlerBase::caseTransform | protected | function | Transform a string by a certain method. | ||
HandlerBase::defaultExposeOptions | public | function | Set new exposed option defaults when exposed setting is flipped on. |
2 | |
HandlerBase::defineExtraOptions | public | function | Provide defaults for the handler. | ||
HandlerBase::displayExposedForm | public | function | Displays the Expose form. | ||
HandlerBase::ensureMyTable | public | function | Ensure the main table for this handler is in the query. This is used a lot. |
Overrides ViewsHandlerInterface::ensureMyTable | 2 |
HandlerBase::exposedInfo | public | function | Get information about the exposed form for the form renderer. | 1 | |
HandlerBase::getDateField | public | function | Creates cross-database SQL dates. | 2 | |
HandlerBase::getDateFormat | public | function | Creates cross-database SQL date formatting. | 2 | |
HandlerBase::getEntityType | public | function | Determines the entity type used by this handler. | Overrides ViewsHandlerInterface::getEntityType | |
HandlerBase::getField | public | function | Shortcut to get a handler's raw field value. | Overrides ViewsHandlerInterface::getField | |
HandlerBase::getJoin | public | function | Get the join object that should be used for this handler. | Overrides ViewsHandlerInterface::getJoin | |
HandlerBase::getModuleHandler | protected | function | Gets the module handler. | ||
HandlerBase::getTableJoin | public static | function | Fetches a handler to join one table to a primary table from the data cache. | Overrides ViewsHandlerInterface::getTableJoin | |
HandlerBase::getViewsData | protected | function | Gets views data service. | ||
HandlerBase::hasExtraOptions | public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. |
1 | |
HandlerBase::isAGroup | public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 | |
HandlerBase::isExposed | public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. |
||
HandlerBase::multipleExposedInput | public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. |
1 | |
HandlerBase::placeholder | protected | function | Provides a unique placeholders for handlers. | ||
HandlerBase::postExecute | public | function | Run after the view is executed, before the result is cached. | Overrides ViewsHandlerInterface::postExecute | |
HandlerBase::preQuery | public | function | Run before the view is built. | Overrides ViewsHandlerInterface::preQuery | 2 |
HandlerBase::sanitizeValue | public | function | Sanitize the value for output. | Overrides ViewsHandlerInterface::sanitizeValue | |
HandlerBase::setModuleHandler | public | function | Sets the module handler. | ||
HandlerBase::setRelationship | public | function | Called just prior to query(), this lets a handler set up any relationship it needs. |
Overrides ViewsHandlerInterface::setRelationship | |
HandlerBase::setViewsData | public | function | |||
HandlerBase::showExposeButton | public | function | Shortcut to display the expose/hide button. | 2 | |
HandlerBase::showExposeForm | public | function | Shortcut to display the exposed options form. | Overrides ViewsHandlerInterface::showExposeForm | |
HandlerBase::storeExposedInput | public | function | If set to remember exposed input in the session, store it there. | 1 | |
HandlerBase::submitExposed | public | function | Submit the exposed handler form | ||
HandlerBase::submitExposeForm | public | function | Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data. |
||
HandlerBase::submitExtraOptionsForm | public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. |
||
HandlerBase::submitFormCalculateOptions | public | function | Calculates options stored on the handler | 1 | |
HandlerBase::submitGroupByForm | public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. |
1 | |
HandlerBase::submitTemporaryForm | public | function | A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests. |
||
HandlerBase::usesGroupBy | public | function | Provides the handler some groupby. | 13 | |
HandlerBase::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides PluginBase::validate | 2 |
HandlerBase::validateExposed | public | function | Validate the exposed handler form | 4 | |
HandlerBase::validateExposeForm | public | function | Validate the options form. | 1 | |
HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | ||
HandlerBase::__construct | public | function | Constructs a Handler object. | Overrides PluginBase::__construct | 44 |
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::$renderer | protected | property | Stores the render API renderer. | 3 | |
PluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | 8 | |
PluginBase::$view | public | property | The top object of a view. | 1 | |
PluginBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 62 |
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::summaryTitle | public | function | Returns the summary of the settings in the display. | Overrides ViewsPluginInterface::summaryTitle | 6 |
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::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. | |||
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 | |
StringArgument::buildOptionsForm | public | function | Provide a form to edit options for this plugin. | Overrides ArgumentPluginBase::buildOptionsForm | 1 |
StringArgument::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides ArgumentPluginBase::defineOptions | 1 |
StringArgument::getContextDefinition | public | function | Returns a context definition for this argument. | Overrides ArgumentPluginBase::getContextDefinition | |
StringArgument::getFormula | public | function | Get the formula for this argument. | ||
StringArgument::getSortName | public | function | Return a description of how the argument would normally be sorted. | Overrides ArgumentPluginBase::getSortName | |
StringArgument::init | public | function | Overrides Drupal\views\Plugin\views\HandlerBase:init(). | Overrides ArgumentPluginBase::init | 1 |
StringArgument::query | public | function | Build the query based upon the formula | Overrides ArgumentPluginBase::query | |
StringArgument::summaryArgument | public | function | Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->getUrl(). |
Overrides ArgumentPluginBase::summaryArgument | |
StringArgument::summaryName | public | function | Provides the name to use for the summary. By default this is just the name field. |
Overrides ArgumentPluginBase::summaryName | 2 |
StringArgument::summaryQuery | protected | function | Build the summary query based on a string | Overrides ArgumentPluginBase::summaryQuery | |
StringArgument::title | public | function | Get the title this argument will assign the view, given the argument. | Overrides ArgumentPluginBase::title | 1 |
StringArgument::titleQuery | public | function | Override for specific title lookups. | ||
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.