CRM/Event/Tokens.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.7                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2015                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  * Class CRM_Event_Tokens
  31  *
  32  * Generate "event.*" tokens.
  33  *
  34  * This TokenSubscriber was produced by refactoring the code from the
  35  * scheduled-reminder system with the goal of making that system
  36  * more flexible. The current implementation is still coupled to
  37  * scheduled-reminders. It would be good to figure out a more generic
  38  * implementation which is not tied to scheduled reminders, although
  39  * that is outside the current scope.
  40  */
  41 class CRM_Event_Tokens extends \Civi\Token\AbstractTokenSubscriber {
  42
  43   public function __construct() {
  44     parent::__construct('event', array(
  45       'event_type' => ts('Event Type'),
  46       'title' => ts('Event Title'),
  47       'event_id' => ts('Event ID'),
  48       'start_date' => ts('Event Start Date'),
  49       'end_date' => ts('Event End Date'),
  50       'summary' => ts('Event Summary'),
  51       'description' => ts('Event Description'),
  52       'location' => ts('Event Location'),
  53       'info_url' => ts('Event Info URL'),
  54       'registration_url' => ts('Event Registration URL'),
  55       'fee_amount' => ts('Event Fee'),
  56       'contact_email' => ts('Event Contact (Email)'),
  57       'contact_phone' => ts('Event Contact (Phone)'),
  58       'balance' => ts('Event Balance'),
  59     ));
  60   }
  61
  62   public function checkActive(\Civi\Token\TokenProcessor $processor) {
  63     // Extracted from scheduled-reminders code. See the class description.
  64     return
  65       !empty($processor->context['actionMapping'])
  66       && $processor->context['actionMapping']->getEntity() === 'civicrm_participant';
  67   }
  68
  69   public function alterActionScheduleQuery(\Civi\ActionSchedule\Event\MailingQueryEvent $e) {
  70     if ($e->mapping->getEntity() !== 'civicrm_participant') {
  71       return;
  72     }
  73
  74     $e->query->select('e.*'); // FIXME: seems too broad.
  75     $e->query->select('ov.label as event_type, ev.title, ev.id as event_id, ev.start_date, ev.end_date, ev.summary, ev.description, address.street_address, address.city, address.state_province_id, address.postal_code, email.email as contact_email, phone.phone as contact_phone');
  76     $e->query->join('participant_stuff', "
  77 !casMailingJoinType civicrm_event ev ON e.event_id = ev.id
  78 !casMailingJoinType civicrm_option_group og ON og.name = 'event_type'
  79 !casMailingJoinType civicrm_option_value ov ON ev.event_type_id = ov.value AND ov.option_group_id = og.id
  80 LEFT JOIN civicrm_loc_block lb ON lb.id = ev.loc_block_id
  81 LEFT JOIN civicrm_address address ON address.id = lb.address_id
  82 LEFT JOIN civicrm_email email ON email.id = lb.email_id
  83 LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id
  84 ");
  85   }
  86
  87   /**
  88    * Evaluate the content of a single token.
  89    *
  90    * @param \Civi\Token\TokenRow $row
  91    *   The record for which we want token values.
  92    * @param string $field
  93    *   The name of the token field.
  94    * @param mixed $prefetch
  95    *   Any data that was returned by the prefetch().
  96    * @return mixed
  97    */
  98   public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) {
  99     $actionSearchResult = $row->context['actionSearchResult'];
 100
 101     if ($field == 'location') {
 102       $loc = array();
 103       $stateProvince = \CRM_Core_PseudoConstant::stateProvince();
 104       $loc['street_address'] = $actionSearchResult->street_address;
 105       $loc['city'] = $actionSearchResult->city;
 106       $loc['state_province'] = \CRM_Utils_Array::value($actionSearchResult->state_province_id, $stateProvince);
 107       $loc['postal_code'] = $actionSearchResult->postal_code;
 108       //$entityTokenParams[$tokenEntity][$field] = \CRM_Utils_Address::format($loc);
 109       $row->tokens($entity, $field, \CRM_Utils_Address::format($loc));
 110     }
 111     elseif ($field == 'info_url') {
 112       $row
 113         ->tokens($entity, $field, \CRM_Utils_System::url('civicrm/event/info', 'reset=1&id=' . $actionSearchResult->event_id, TRUE, NULL, FALSE));
 114     }
 115     elseif ($field == 'registration_url') {
 116       $row
 117         ->tokens($entity, $field, \CRM_Utils_System::url('civicrm/event/register', 'reset=1&id=' . $actionSearchResult->event_id, TRUE, NULL, FALSE));
 118     }
 119     elseif (in_array($field, array('start_date', 'end_date'))) {
 120       $row->tokens($entity, $field, \CRM_Utils_Date::customFormat($actionSearchResult->$field));
 121     }
 122     elseif ($field == 'balance') {
 123       if ($actionSearchResult->entityTable == 'civicrm_contact') {
 124         $balancePay = 'N/A';
 125       }
 126       elseif (!empty($actionSearchResult->entityID)) {
 127         $info = \CRM_Contribute_BAO_Contribution::getPaymentInfo($actionSearchResult->entityID, 'event');
 128         $balancePay = \CRM_Utils_Array::value('balance', $info);
 129         $balancePay = \CRM_Utils_Money::format($balancePay);
 130       }
 131       $row->tokens($entity, $field, $balancePay);
 132     }
 133     elseif ($field == 'fee_amount') {
 134       $row->tokens($entity, $field, \CRM_Utils_Money::format($actionSearchResult->$field));
 135     }
 136     elseif (isset($actionSearchResult->$field)) {
 137       $row->tokens($entity, $field, $actionSearchResult->$field);
 138     }
 139     else {
 140       $row->tokens($entity, $field, '');
 141     }
 142   }
 143
 144 }