Skip to content

Batch load message entities in view results #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nikanderson wants to merge 1 commit into
base: 7.x-1.x
Choose a base branch
from
Open

Batch load message entities in view results #229

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion includes/views/handlers/message_handler_field_message_render.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
*/
class message_handler_field_message_render extends views_handler_field {

// Message entities
var $messages = array();
Copy link
Member

@amitaibu amitaibu Jul 10, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would avoid this $messages - as we end up caching this inside message_load and here. Instead - you can do something like:

function pre_render() {

...
+    if (empty($mids)) {
        // No Message IDs.
        return;
     }
     
    // Load the Messages in a single call, so they will be statically cached in the ::render function.
     message_load_multiple($mids);
}

Then, the render function will stay as-is, the message_load will however fetch the $message from the static cache.


/**
* Set default field name to render.
*/
Expand Down Expand Up @@ -70,14 +73,32 @@ class message_handler_field_message_render extends views_handler_field {
parent::options_form($form, $form_state);
}

function pre_render(&$values) {
$mids = array();
$field_alias = $this->field_alias;

foreach ($values as $value) {
if (!empty($value->{$field_alias})) {
Copy link
Member

@amitaibu amitaibu Jul 10, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When would this be empty?

$mids[] = $value->{$field_alias};
}
}

if (!empty($mids)) {
$this->messages = message_load_multiple($mids);
}
}

function render($values) {
$field_alias = $this->field_alias;
if (!empty($values->{$field_alias}) && $message = message_load($values->{$field_alias})) {

if (!empty($values->{$field_alias}) && isset($this->messages[$values->{$field_alias}])) {
$message = $this->messages[$values->{$field_alias}];
$options = array(
'field name' => $this->options['field_name'],
'partials' => $this->options['partials'],
'partial delta' => $this->options['partials_delta'],
);

return $message->getText(NULL, $options);
}
}
Expand Down