class JoinTest in Drupal 9

Defines a join test plugin.

Plugin annotation

@ViewsJoin("join_test");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\views\Plugin\views\join\JoinPluginBase implements JoinPluginInterface
      • class \Drupal\views_test_data\Plugin\views\join\JoinTest

1 file declares its use of JoinTest

JoinTest.php in core/modules/views/tests/src/Kernel/Plugin/JoinTest.php

File

core/modules/views/tests/modules/views_test_data/src/Plugin/views/join/JoinTest.php, line 12

Namespace

Drupal\views_test_data\Plugin\views\join

class JoinTest extends JoinPluginBase {

  /**
   * A value which is used to build an additional join condition.
   *
   * @var int
   */
  protected $joinValue;

  /**
   * Returns the joinValue property.
   *
   * @return int
   */
  public function getJoinValue() {
    return $this->joinValue;
  }

  /**
   * Sets the joinValue property.
   *
   * @param int $join_value
   */
  public function setJoinValue($join_value) {
    $this->joinValue = $join_value;
  }

  /**
   * {@inheritdoc}
   */
  public function buildJoin($select_query, $table, $view_query) {

    // Add an additional hardcoded condition to the query.
    $this->extra = 'views_test_data.uid = ' . $this
      ->getJoinValue();
    parent::buildJoin($select_query, $table, $view_query);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
JoinPluginBase::$adjusted	public	property	Defines whether a join has been adjusted.
JoinPluginBase::$configuration	public	property	The configuration array passed by initJoin. Overrides PluginBase::$configuration
JoinPluginBase::$extra	public	property	An array of extra conditions on the join.
JoinPluginBase::$extraOperator	public	property	How all the extras will be combined. Either AND or OR.
JoinPluginBase::$field	public	property	The field to join on (right field).
JoinPluginBase::$leftField	public	property	The field we join to.
JoinPluginBase::$leftFormula	public	property	A formula to be used instead of the left field.
JoinPluginBase::$leftTable	public	property	The table we join to.
JoinPluginBase::$table	public	property	The table to join (right table).
JoinPluginBase::$type	public	property	The join type, so for example LEFT (default) or INNER.
JoinPluginBase::buildExtra	protected	function	Builds a single extra condition.
JoinPluginBase::joinAddExtra	protected	function	Adds the extras to the join condition.	1
JoinPluginBase::__construct	public	function	Constructs a Drupal\views\Plugin\views\join\JoinPluginBase object. Overrides PluginBase::__construct	1
JoinTest::$joinValue	protected	property	A value which is used to build an additional join condition.
JoinTest::buildJoin	public	function	Builds the SQL for the join this object represents. Overrides JoinPluginBase::buildJoin
JoinTest::getJoinValue	public	function	Returns the joinValue property.
JoinTest::setJoinValue	public	function	Sets the joinValue property.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
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	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.