function Query::prepare

Same name in this branch
  1. 9 core/lib/Drupal/Core/Entity/Query/Sql/Query.php \Drupal\Core\Entity\Query\Sql\Query::prepare()
Same name in other branches
  1. 8.9.x core/modules/workspaces/src/EntityQuery/Query.php \Drupal\workspaces\EntityQuery\Query::prepare()
  2. 8.9.x core/lib/Drupal/Core/Entity/Query/Sql/Query.php \Drupal\Core\Entity\Query\Sql\Query::prepare()
  3. 10 core/modules/workspaces/src/EntityQuery/Query.php \Drupal\workspaces\EntityQuery\Query::prepare()
  4. 10 core/lib/Drupal/Core/Entity/Query/Sql/Query.php \Drupal\Core\Entity\Query\Sql\Query::prepare()
  5. 11.x core/modules/workspaces/src/EntityQuery/Query.php \Drupal\workspaces\EntityQuery\Query::prepare()
  6. 11.x core/lib/Drupal/Core/Entity/Query/Sql/Query.php \Drupal\Core\Entity\Query\Sql\Query::prepare()

Overrides Query::prepare

File

core/modules/workspaces/src/EntityQuery/Query.php, line 19

Class

Query
Alters entity queries to use a workspace revision instead of the default one.

Namespace

Drupal\workspaces\EntityQuery

Code

public function prepare() {
    $this->traitPrepare();
    // If the prepare() method from the trait decided that we need to alter this
    // query, we need to re-define the key fields for fetchAllKeyed() as SQL
    // expressions.
    if ($this->sqlQuery
        ->getMetaData('active_workspace_id')) {
        $id_field = $this->entityType
            ->getKey('id');
        $revision_field = $this->entityType
            ->getKey('revision');
        // Since the query is against the base table, we have to take into account
        // that the revision ID might come from the workspace_association
        // relationship, and, as a consequence, the revision ID field is no longer
        // a simple SQL field but an expression.
        $this->sqlFields = [];
        $this->sqlQuery
            ->addExpression("COALESCE([workspace_association].[target_entity_revision_id], [base_table].[{$revision_field}])", $revision_field);
        $this->sqlQuery
            ->addExpression("[base_table].[{$id_field}]", $id_field);
        $this->sqlGroupBy['workspace_association.target_entity_revision_id'] = 'workspace_association.target_entity_revision_id';
        $this->sqlGroupBy["base_table.{$id_field}"] = "base_table.{$id_field}";
        $this->sqlGroupBy["base_table.{$revision_field}"] = "base_table.{$revision_field}";
    }
    return $this;
}

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