CRM/Activity/BAO/ActivityAssignment.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class is for activity assignment functions
  38  *
  39  */
  40 class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityContact {
  41
  42   /**
  43    * class constructor
  44    */
  45   function __construct() {
  46     parent::__construct();
  47   }
  48
  49   /**
  50    * Add activity assignment.
  51    *
  52    * @param array  $params       (reference ) an assoc array of name/value pairs
  53    * @param array  $ids          (reference ) the array that holds all the db ids
  54    *
  55    * @return object activity type of object that is added
  56    * @access public
  57    *
  58    */
  59   public static function create(&$params) {
  60     $assignment = new CRM_Activity_BAO_ActivityContact();
  61     $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
  62     $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
  63
  64     $assignment->copyValues($params);
  65     $assignment->record_type_id = $assigneeID;
  66
  67     return $assignment->save();
  68   }
  69
  70   /**
  71    * Retrieve assignee_id by activity_id
  72    *
  73    * @param int    $id  ID of the activity
  74    *
  75    * @return void
  76    *
  77    * @access public
  78    *
  79    */
  80   static function retrieveAssigneeIdsByActivityId($activity_id) {
  81     $assigneeArray = array();
  82     if (!CRM_Utils_Rule::positiveInteger($activity_id)) {
  83       return $assigneeArray;
  84     }
  85
  86     $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
  87     $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
  88
  89     $sql = "
  90 SELECT     contact_id
  91 FROM       civicrm_activity_contact
  92 INNER JOIN civicrm_contact ON contact_id = civicrm_contact.id
  93 WHERE      activity_id = %1
  94 AND        record_type_id = $assigneeID
  95 AND        civicrm_contact.is_deleted = 0
  96 ";
  97     $assignment = CRM_Core_DAO::executeQuery($sql, array(1 => array($activity_id, 'Integer')));
  98     while ($assignment->fetch()) {
  99       $assigneeArray[] = $assignment->contact_id;
 100     }
 101
 102     return $assigneeArray;
 103   }
 104
 105   /**
 106    * Retrieve assignee names by activity_id
 107    *
 108    * @param array    $activityIDs    IDs of the activities
 109    * @param boolean  $isDisplayName  if set returns display names of assignees
 110    * @param boolean  $skipDetails    if false returns all details of assignee contact.
 111    *
 112    * @return array
 113    *
 114    * @access public
 115    *
 116    */
 117   static function getAssigneeNames($activityIDs, $isDisplayName = FALSE, $skipDetails = TRUE) {
 118     $assigneeNames = array();
 119     if (empty($activityIDs)) {
 120       return $assigneeNames;
 121     }
 122     $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
 123     $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
 124
 125     $whereClause = "";
 126     if (!$skipDetails) {
 127       $whereClause = "  AND ce.is_primary= 1";
 128     }
 129     $inClause = implode(",", $activityIDs);
 130
 131     $query = "
 132 SELECT     contact_a.id, contact_a.sort_name, contact_a.display_name, ce.email,
 133            civicrm_activity_contact.activity_id
 134 FROM       civicrm_contact contact_a
 135 INNER JOIN civicrm_activity_contact ON civicrm_activity_contact.contact_id = contact_a.id
 136 LEFT JOIN  civicrm_email ce ON ce.contact_id = contact_a.id
 137 WHERE      civicrm_activity_contact.activity_id IN ( $inClause )
 138 AND        contact_a.is_deleted = 0
 139 AND        civicrm_activity_contact.record_type_id = $assigneeID
 140            {$whereClause}
 141 ";
 142
 143     $dao = CRM_Core_DAO::executeQuery($query);
 144     while ($dao->fetch()) {
 145       if (!$isDisplayName) {
 146         $assigneeNames[$dao->id] = $dao->sort_name;
 147       }
 148       else {
 149         if ($skipDetails) {
 150           $assigneeNames[$dao->id] = $dao->display_name;
 151         }
 152         else {
 153           $assigneeNames[$dao->id]['contact_id'] = $dao->id;
 154           $assigneeNames[$dao->id]['display_name'] = $dao->display_name;
 155           $assigneeNames[$dao->id]['sort_name'] = $dao->sort_name;
 156           $assigneeNames[$dao->id]['email'] = $dao->email;
 157           $assigneeNames[$dao->id]['role'] = ts('Activity Assignee');
 158           $assigneeNames[$dao->id]['activity_id'] = $dao->activity_id;
 159         }
 160       }
 161     }
 162     return $assigneeNames;
 163   }
 164 }
 165