1. class
  2. Drupal
  3. \
  4. views
  5. \
  6. Plugin
  7. \
  8. views
  9. \
  10. join
  11. \
  12. Subquery

Subquery

class Subquery extends JoinPluginBase (View source)

Join handler for relationships that join with a subquery as the left field.

For example:

Traits

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

DependencySerializationTrait

Provides dependency injection friendly methods for serialization.

MessengerTrait

Provides a trait for the messenger service.

Constants

DERIVATIVE_SEPARATOR

A string which is used to separate base plugin IDs from the derivative ID.

Properties

protected string $pluginId

The plugin_id.

 from  PluginBase
protected array $pluginDefinition

The plugin implementation definition.

 from  PluginBase
array $configuration

The configuration array passed by initJoin.

 from  JoinPluginBase
protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected array $_serviceIds

An array of service IDs keyed by property name used for serialization.

 from  DependencySerializationTrait
protected array $_entityStorages

An array of entity type IDs keyed by the property name of their storages.

 from  DependencySerializationTrait
protected MessengerInterface $messenger

The messenger.

 from  MessengerTrait
string $table

The table to join (right table).

 from  JoinPluginBase
string $field

The field to join on (right field).

 from  JoinPluginBase
string $leftTable

The table we join to.

 from  JoinPluginBase
string $leftField

The field we join to.

 from  JoinPluginBase
string $leftFormula

A formula to be used instead of the left field.

 from  JoinPluginBase
array $extra

An array of extra conditions on the join.

 from  JoinPluginBase
string $type

The join type, so for example LEFT (default) or INNER.

 from  JoinPluginBase
string $extraOperator

How all the extras will be combined. Either AND or OR.

 from  JoinPluginBase
bool $adjusted

Defines whether a join has been adjusted.

 from  JoinPluginBase

Methods

__construct(array $configuration, string $plugin_id, mixed $plugin_definition)

Constructs a Subquery object.

string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginBase
string
getBaseId()

Gets the base_plugin_id of the plugin instance.

from  PluginBase
string|null
getDerivativeId()

Gets the derivative_id of the plugin instance.

from  PluginBase
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginBase
bool
isConfigurable()

Determines if the plugin is configurable.

from  PluginBase
TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__sleep()

{@inheritdoc}

from  DependencySerializationTrait
__wakeup()

{@inheritdoc}

from  DependencySerializationTrait
setMessenger(MessengerInterface $messenger)

Sets the messenger.

from  MessengerTrait
MessengerInterface
messenger()

Gets the messenger.

from  MessengerTrait
buildJoin($select_query, $table, QueryPluginBase $view_query)

Builds the SQL for the join this object represents.

joinAddExtra(array $arguments, string $condition, array $table, SelectInterface $select_query, array $left_table = NULL)

Adds the extras to the join condition.

from  JoinPluginBase
string
buildExtra(array $info, array $arguments, array $table, SelectInterface $select_query, array $left)

Builds a single extra condition.

from  JoinPluginBase

Details

at line 25
__construct(array $configuration, string $plugin_id, mixed $plugin_definition)

Constructs a Subquery object.

Parameters

array $configuration

A configuration array containing information about the plugin instance.
string $plugin_id

The plugin_id for the plugin instance.
mixed $plugin_definition

The plugin implementation definition.

in PluginBase at line 66
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginBase at line 73
string getBaseId()

Gets the base_plugin_id of the plugin instance.

Return Value

string

The base_plugin_id of the plugin instance.

in PluginBase at line 84
string|null getDerivativeId()

Gets the derivative_id of the plugin instance.

Return Value

string|null

The derivative_id of the plugin instance NULL otherwise.

in PluginBase at line 96
array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

in PluginBase at line 106
bool isConfigurable()

Determines if the plugin is configurable.

Return Value

bool

A boolean indicating whether the plugin is configurable.

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

in DependencySerializationTrait at line 30
__sleep()

{@inheritdoc}

in DependencySerializationTrait at line 65
__wakeup()

{@inheritdoc}

in MessengerTrait at line 23
setMessenger(MessengerInterface $messenger)

Sets the messenger.

Parameters

MessengerInterface $messenger

The messenger.

in MessengerTrait at line 33
MessengerInterface messenger()

Gets the messenger.

Return Value

MessengerInterface

The messenger.

at line 41
buildJoin($select_query, $table, QueryPluginBase $view_query)

Builds the SQL for the join this object represents.

Parameters

$select_query

An select query object.
$table

The base table to join.
QueryPluginBase $view_query

The source views query.

in JoinPluginBase at line 334
protected joinAddExtra(array $arguments, string $condition, array $table, SelectInterface $select_query, array $left_table = NULL)

Adds the extras to the join condition.

Parameters

array $arguments

Array of query arguments.
string $condition

The condition to be built.
array $table

The right table.
SelectInterface $select_query

The current select query being built.
array $left_table

The left table.

in JoinPluginBase at line 372
protected string buildExtra(array $info, array $arguments, array $table, SelectInterface $select_query, array $left)

Builds a single extra condition.

Parameters

array $info

The extra information. See JoinPluginBase::$extra for details.
array $arguments

Array of query arguments.
array $table

The right table.
SelectInterface $select_query

The current select query being built.
array $left

The left table.

Return Value

string

The extra condition