class FieldOrLanguageJoin

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/join/FieldOrLanguageJoin.php \Drupal\views\Plugin\views\join\FieldOrLanguageJoin
  2. 8.9.x core/modules/views/src/Plugin/views/join/FieldOrLanguageJoin.php \Drupal\views\Plugin\views\join\FieldOrLanguageJoin
  3. 11.x core/modules/views/src/Plugin/views/join/FieldOrLanguageJoin.php \Drupal\views\Plugin\views\join\FieldOrLanguageJoin

Implementation for the "field OR language" join.

If the extra conditions contain either ".langcode" or ".bundle", they will be grouped and joined with OR instead of AND. The entire group will then be joined to the other conditions with AND.

This is needed for configurable fields that are translatable on some bundles and untranslatable on others. The correct field values to fetch in this case have a langcode that matches the entity record *or* have a bundle on which the field is untranslatable. Thus, the entity base table (or data table, or revision data table, respectively) must join the field data table (or field revision table) on a matching langcode *or* a bundle where the field is untranslatable. The following example views data achieves this for a node field named 'field_tags' which is translatable on an 'article' node type, but not on the 'news' and 'page' node types:

$data['node__field_tags']['table']['join']['node_field_data'] = [
    'join_id' => 'field_or_language_join',
    'table' => 'node__field_tags',
    'left_field' => 'nid',
    'field' => 'entity_id',
    'extra' => [
        [
            'field' => 'deleted',
            'value' => 0,
            'numeric' => TRUE,
        ],
        [
            'left_field' => 'langcode',
            'field' => 'langcode',
        ],
        [
            'field' => 'bundle',
            'value' => [
                'news',
                'page',
            ],
        ],
    ],
];

The resulting join condition for this example would be the following:


  ON node__field_tags.deleted = 0
    AND (
      node_field_data.langcode = node__field_tags.langcode
      OR node__field.tags.bundle IN ['news', 'page']
    )

Hierarchy

Expanded class hierarchy of FieldOrLanguageJoin

See also

views_field_default_views_data()

Related topics

1 file declares its use of FieldOrLanguageJoin
FieldOrLanguageJoinTest.php in core/modules/views/tests/src/Kernel/Plugin/FieldOrLanguageJoinTest.php

File

core/modules/views/src/Plugin/views/join/FieldOrLanguageJoin.php, line 63

Namespace

Drupal\views\Plugin\views\join
View source
class FieldOrLanguageJoin extends JoinPluginBase {
    
    /**
     * {@inheritdoc}
     */
    protected function joinAddExtra(&$arguments, &$condition, $table, SelectInterface $select_query, $left_table = NULL) {
        if (empty($this->extra)) {
            return;
        }
        if (is_array($this->extra)) {
            $extras = [];
            foreach ($this->extra as $extra) {
                $extras[] = $this->buildExtra($extra, $arguments, $table, $select_query, $left_table);
            }
            // Remove and store the langcode OR bundle join condition extra.
            $language_bundle_conditions = [];
            foreach ($extras as $key => $extra) {
                if (str_contains($extra, '.langcode') || str_contains($extra, '.bundle')) {
                    $language_bundle_conditions[] = $extra;
                    unset($extras[$key]);
                }
            }
            if (count($extras) > 1) {
                $condition .= ' AND (' . implode(' ' . $this->extraOperator . ' ', $extras) . ')';
            }
            elseif ($extras) {
                $condition .= ' AND ' . array_shift($extras);
            }
            // Tack on the langcode OR bundle join condition extra.
            if (!empty($language_bundle_conditions)) {
                $condition .= ' AND (' . implode(' OR ', $language_bundle_conditions) . ')';
            }
        }
        elseif (is_string($this->extra)) {
            $condition .= " AND ({$this->extra})";
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
FieldOrLanguageJoin::joinAddExtra protected function Adds the extras to the join condition. Overrides JoinPluginBase::joinAddExtra
JoinPluginBase::$adjusted public property Defines whether a join has been adjusted.
JoinPluginBase::$configuration public property The configuration array passed by initJoin.
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::buildJoin public function Builds the SQL for the join this object represents. Overrides JoinPluginInterface::buildJoin 3
JoinPluginBase::__construct public function Constructs a Drupal\views\Plugin\views\join\JoinPluginBase object. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.