CiviCRM Community Forums (archive)

I'm trying to figure out if there is a pattern to how the Smarty variables in the component message templates are named (eg Memberships - Receipt (on-line)). Some are camelCase versions of db field names ($lineItem), some are the field names ($is_pay_later for civicrm_participant.is_pay_later), some are custom made up ($mem_end_date for civicrm_membership.end_date, $membership_name for label of civicrm_membership.membership_type_id - though I think it is called $title in the subject line, $isOnWaitlist for (non-standard name for a boolean field) civicrm_participant.must_wait (booleans are supposed to start with is_)).

I like the clarity of references like $line_item.description and $line_item.qty. Is there a problem if we exposed $grant with field names as keys? This seems cleaner.

The only additional point would be that we would add a translation of pseudo-FK id's into label values before the variable is assigned to Smarty so that this work would not be done by a callback from browser.  For example if we have a grant status, reason for grant rejection, etc., I was thinking it might be nice to create $grant.grant_status as the label as well as $grant.grant_status_id, and $grant.grant_reason_rejected as well as $grant.grant_reason_rejected_id. I'd prefer this to $grantStatus or $grant_status.

Comments and feedback?

See https://github.com/civicrm/civicrm-core/pull/1167