Skip to content
Snippets Groups Projects
Commit dbec742b authored by totten's avatar totten
Browse files

(NFC) MailingQueryEvent - Update docblock

parent 0029275a
Branches
Tags
No related merge requests found
......@@ -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'
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment