CRM/Activity/BAO/ActivityAssignment.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   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_ActivityAssignment();
  61
  62     $assignment->copyValues($params);
  63     $assignment->record_type = 'Assignee';
  64     if (isset($assignment->assignee_contact_id)) {
  65       $assignment->contact_id = $assignment->assignee_contact_id;
  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     $sql = "
  87 SELECT     assignee_contact_id
  88 FROM       civicrm_activity_assignment
  89 INNER JOIN civicrm_contact ON contact_id = civicrm_contact.id
  90 WHERE      activity_id = %1
  91 AND        record_type = 'Assignee'
  92 AND        civicrm_contact.is_deleted = 0
  93 ";
  94     $assignment = CRM_Core_DAO::executeQuery($sql, array(1 => array($activity_id, 'Integer')));
  95     while ($assignment->fetch()) {
  96       $assigneeArray[] = $assignment->contact_id;
  97     }
  98
  99     return $assigneeArray;
 100   }
 101
 102   /**
 103    * Retrieve assignee names by activity_id
 104    *
 105    * @param int      $id             ID of the activity
 106    * @param boolean  $isDisplayName  if set returns display names of assignees
 107    * @param boolean  $skipDetails    if false returns all details of assignee contact.
 108    *
 109    * @return array
 110    *
 111    * @access public
 112    *
 113    */
 114   static function getAssigneeNames($activityID, $isDisplayName = FALSE, $skipDetails = TRUE) {
 115     $assigneeNames = array();
 116     if (empty($activityID)) {
 117       return $assigneeNames;
 118     }
 119
 120     $whereClause = "";
 121     if (!$skipDetails) {
 122       $whereClause = "  AND ce.is_primary= 1";
 123     }
 124
 125     $query = "
 126 SELECT     contact_a.id, contact_a.sort_name, contact_a.display_name, ce.email
 127 FROM       civicrm_contact contact_a
 128 INNER JOIN civicrm_activity_contact ON civicrm_activity_contact_contact_id = contact_a.id
 129 LEFT JOIN  civicrm_email ce ON ce.contact_id = contact_a.id
 130 WHERE      civicrm_activity_contact.activity_id = %1
 131 AND        contact_a.is_deleted = 0
 132 AND        civicrm_activity_contact.record_type = 'Assignee'
 133            {$whereClause}
 134 ";
 135
 136     $queryParam = array(1 => array($activityID, 'Integer'));
 137     $dao = CRM_Core_DAO::executeQuery($query, $queryParam);
 138     while ($dao->fetch()) {
 139       if (!$isDisplayName) {
 140         $assigneeNames[$dao->id] = $dao->sort_name;
 141       }
 142       else {
 143         if ($skipDetails) {
 144           $assigneeNames[$dao->id] = $dao->display_name;
 145         }
 146         else {
 147           $assigneeNames[$dao->id]['contact_id'] = $dao->id;
 148           $assigneeNames[$dao->id]['display_name'] = $dao->display_name;
 149           $assigneeNames[$dao->id]['sort_name'] = $dao->sort_name;
 150           $assigneeNames[$dao->id]['email'] = $dao->email;
 151           $assigneeNames[$dao->id]['role'] = ts('Activity Assignee');
 152         }
 153       }
 154     }
 155     return $assigneeNames;
 156   }
 157 }
 158