From dbec742be7bcce7763196c4fdf425871ceb4b87d Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 12 Oct 2021 01:56:14 -0700 Subject: [PATCH] (NFC) MailingQueryEvent - Update docblock --- Civi/ActionSchedule/Event/MailingQueryEvent.php | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/Civi/ActionSchedule/Event/MailingQueryEvent.php b/Civi/ActionSchedule/Event/MailingQueryEvent.php index bd6324c429..eaad9364ee 100644 --- a/Civi/ActionSchedule/Event/MailingQueryEvent.php +++ b/Civi/ActionSchedule/Event/MailingQueryEvent.php @@ -32,13 +32,10 @@ use Symfony\Component\EventDispatcher\Event; * * - Joining to business tables - to help target filter-criteria/temporal criteria on other entites. * (Ex: Join to the `civicrm_participant` table and filter on participant status or registration date.) - * - Joining business tables - to select/return additional columns. Feed the data downstream for mail-merge/token-handling. As in: - * - (Recommended) Return the IDs of business-records. Use the prefix `tokenContext_*`. - * Ex query: `$event->query->select('foo.id AS tokenContext_fooId') - * Ex output: `$tokenRow->context['fooId']` - * - (Deprecated) Return detailed data of business-records. Ex: - * Ex query: `$event->query->select('foo.title as foo_title, foo.status_id as foo_status_id')` - * Ex output: `$tokenRow->context['actionSearchResult']->foo_title` + * - Joining business tables - to select/return additional columns. In particular, return the IDs of business-records that + * may be useful for token-handling. Use the prefix `tokenContext_*`. + * Ex query: `$event->query->select('foo.id AS tokenContext_fooId') + * Ex output: `$tokenRow->context['fooId']` * * There are several parameters pre-set for use in queries: * - 'casActionScheduleId' -- 2.25.1