Add getters to EntityQuery

Open on Drupal.org →

Created on 8 June 2015, over 10 years ago

Updated 9 March 2025, 6 months ago

Currently the entity query has no methods that would provide information about applied conditions, sorts,.. to the query. This does not follow the typical \Drupal\Core\Database\Query\Select in any way.

For example, if someone wants to retrieve the conditions, the only way to do it is a bit dirty:

      $reflection = new \ReflectionClass($query);
      $property = $reflection->getProperty('condition');
      $property->setAccessible(TRUE);
      $conditions = $property->getValue($query);
      $values = $conditions->conditions();

or sorting:

      $reflection = new \ReflectionClass($query);
      $property = $reflection->getProperty('sort');
      $property->setAccessible(TRUE);
      $values = $property->getValue($query);

I have various filter forms that apply filters to entity queries and I need to know which filters were already applied so I can proceed accordingly(ie. add additional conditions or remove certain conditions to figure out ranges or available options ...).

The EQ was created so we won't have to write "manual" queries anymore but it looks like no one expected that someone would like to retrieve any data from these queries, just like we can/do from the good old Drupal\Core\Database\Query\Select.

Additionally there is no way to reset any of the parameters since there are no referenced getters. So if I want to completely change the order/sort of the results I cannot just unset the already applied sorts or conditions like I can do in the simple query where there are the &conditions() or &getOrderBy() methods.

For me, this is critical for my application and without this I have to use simple query instead because even though I can get the protected data via reflection I cannot unset it, only add to it or alter it.

Implemented:

&getConditions()
&getSorts()
&getRange()
...

✨ Feature request

Status

Needs work

Version

11.0 🔥

Component

entity system

Created by

Live updates comments and jobs are added and updated live.

Needs tests
The change is currently missing an automated test that fails when run with the original code, and succeeds when the bug has been fixed.

Needs subsystem maintainer review
It is used to alert the maintainer(s) of a particular core subsystem that an issue significantly impacts their subsystem, and their signoff is needed (see the governance policy draft for more information). Also, if you use this tag, make sure the issue component is set to the correct subsystem. If an issue significantly impacts more than one subsystem, use needs framework manager review instead.

Incomplete comments

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment 6 months ago →
🇺🇸United States davidwbarratt
Just ran into this trying to access the accessCheck property.
Comment about 1 month ago →
🇩🇪Germany rgpublic Düsseldorf 🇩🇪 🇪🇺
I don't know whether this is thought to be included with this issue here and I don't want to hijack this but IMHO there's also a method missing to get the raw sqlQuery. We have stuff like addTag and according hooks like hook_query_[tag]_alter to modify the query, but there's no way to get the additional results back. At the very least there should be an executeQuery() or sth. so we can get the full rows back on not just IDs.

Right now, we have to decide: Either create and use manual SQL queries - which is of course quite complicated due to all the JOINs, column names etc. or use the very comfortable entityQuery but then be forever restricted to what it provides. If there's just one thing we want to let the SQL server do or calculate, everything falls apart. This could be a whole lot easier if there was such a method.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024