Aggregation option don't work with generated datas from custom field handler class

/** * @file * Definition of Drupal\mymodule\Plugin\views\field\MyCustomClass */ namespace Drupal\mymodule\Plugin\views\field; use Drupal\Core\Form\FormStateInterface; use Drupal\views\Plugin\views\field\NumericField; use Drupal\views\ResultRow; /** * Field handler to show a custom_views_field of the current row. * * @ingroup views_field_handlers * * @ViewsField("my_custom_class") */ class MyCustomClass extends NumericField { /** * Retrieve metrics from the api directory */ protected function metrics() { // Build a function with defined metrics module_load_include('php', 'mymodule', '/src/Plugin/api/metrics'); // Return metrics return metrics(); } /** * {@inheritdoc} */ public function usesGroupBy() { // Enable the aggregation option return TRUE; } /** * {@inheritdoc} */ protected function defineOptions() { // Load defined metrics $metrics = $this->metrics(); // Define options $options = parent::defineOptions(); $options['metrics'] = array('default' => key($metrics)); // Return options return $options; } /** * {@inheritdoc} */ public function buildOptionsForm(&$form, FormStateInterface $form_state) { // Load defined metrics $metrics = $this->metrics(); // Define the field options with defined metrics $options = []; foreach ($metrics as $parameter => $metric) { $options[$parameter] = $metric['title']->render(); } $form['metrics'] = array( '#title' => $this->t('Choose a metric'), '#type' => 'select', '#default_value' => $this->options['metrics'], '#options' => $options, ); // Build options parent::buildOptionsForm($form, $form_state); } /** * {@inheritdoc} */ public function query() { // do nothing -- to override the parent query. } /** * {@inheritdoc} */ public function render(ResultRow $values) { // Customize the field value $datas_json = $values->_entity->get('field_datas')->value; $datas = json_decode($datas_json); $metric = $this->options['metrics']; $metric_value = $datas->$metric; // Return metric value return $metric_value; } }

Comments & Activities

Not all content is available!

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

Comment about 1 year ago →
🇺🇸United States bwong
This patch was initially submitted to address an integration issue with modules like Views Raw SQL → .

As it turns out, I didn't fully understand the entire mechanism for implementing aggregation. Turns out that selection a method other than Group By replaces the handler with NumericField that essentially ignores the existing handler and it assumes that a field is involved. There are two ways to address this. The more complicated way, and possibly better, is to come up with a NumericField replacement and change how the handler is changed. The replacement could keep the details of the original field support in place. The other alternative is to put any support for aggregation into the desired plugin.

I chose the latter with the Views Raw SQL #15023002 patch #5 🐛 the Value is lost with Aggregation Needs review . This essentially keeps the Group By setting but hides it so the NumericField substitution does not occur. The aggregation support is handled by replacing the options form selection with a new one and using the value in the aggregation support handled by the original field support.

For Views Raw SQL, this solution works for all of the field types including field, filter, sort and argument.

The solution I presented here does not really address the issue as it is trying to adjust changes imposed by NumericField. Assuming either approach above, the need for an aggregation override is not needed. If this is the case then this issue should be closed.
Status changed to Needs work about 1 year ago10:22pm 25 April 2023
Comment about 1 year ago →
needs-review-queue-bot
The Needs Review Queue Bot → tested this issue. It fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

This does not mean that the patch needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.