CRM/Activity/BAO/ActivityContact.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  */
  33
  34 /**
  35  * This class is for activity assignment functions.
  36  */
  37 class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact {
  38
  39   /**
  40    * Class constructor.
  41    */
  42   public function __construct() {
  43     parent::__construct();
  44   }
  45
  46   /**
  47    * Function to add activity contact.
  48    *
  49    * @param array $params
  50    *   The values for this table: activity id, contact id, record type.
  51    *
  52    * @return object
  53    *   activity_contact object
  54    */
  55   public static function create(&$params) {
  56     $activityContact = new CRM_Activity_DAO_ActivityContact();
  57
  58     $activityContact->copyValues($params);
  59     if (!$activityContact->find(TRUE)) {
  60       return $activityContact->save();
  61     }
  62     return $activityContact;
  63   }
  64
  65   /**
  66    * Retrieve names of contact by activity_id.
  67    *
  68    * @param int $activityID
  69    * @param int $recordTypeID
  70    * @param bool $alsoIDs
  71    *
  72    * @return array
  73    */
  74   public static function getNames($activityID, $recordTypeID, $alsoIDs = FALSE) {
  75     $names = array();
  76     $ids = array();
  77
  78     if (empty($activityID)) {
  79       return $alsoIDs ? array($names, $ids) : $names;
  80     }
  81
  82     $query = "
  83 SELECT     contact_a.id, contact_a.sort_name
  84 FROM       civicrm_contact contact_a
  85 INNER JOIN civicrm_activity_contact ON civicrm_activity_contact.contact_id = contact_a.id
  86 WHERE      civicrm_activity_contact.activity_id = %1
  87 AND        civicrm_activity_contact.record_type_id = %2
  88 AND        contact_a.is_deleted = 0
  89 ";
  90     $params = array(
  91       1 => array($activityID, 'Integer'),
  92       2 => array($recordTypeID, 'Integer'),
  93     );
  94
  95     $dao = CRM_Core_DAO::executeQuery($query, $params);
  96     while ($dao->fetch()) {
  97       $names[$dao->id] = $dao->sort_name;
  98       $ids[] = $dao->id;
  99     }
 100
 101     return $alsoIDs ? array($names, $ids) : $names;
 102   }
 103
 104   /**
 105    * Retrieve id of target contact by activity_id.
 106    *
 107    * @param int $activityID
 108    * @param int $recordTypeID
 109    *
 110    * @return mixed
 111    */
 112   public static function retrieveContactIdsByActivityId($activityID, $recordTypeID) {
 113     $activityContact = array();
 114     if (!CRM_Utils_Rule::positiveInteger($activityID) ||
 115       !CRM_Utils_Rule::positiveInteger($recordTypeID)
 116     ) {
 117       return $activityContact;
 118     }
 119
 120     $sql = "                                                                                                                                                                                             SELECT     contact_id
 121 FROM       civicrm_activity_contact
 122 INNER JOIN civicrm_contact ON contact_id = civicrm_contact.id
 123 WHERE      activity_id = %1
 124 AND        record_type_id = %2
 125 AND        civicrm_contact.is_deleted = 0
 126 ";
 127     $params = array(
 128       1 => array($activityID, 'Integer'),
 129       2 => array($recordTypeID, 'Integer'),
 130     );
 131
 132     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 133     while ($dao->fetch()) {
 134       $activityContact[] = $dao->contact_id;
 135     }
 136     return $activityContact;
 137   }
 138
 139   /**
 140    * Get the links associate array  as defined by the links.ini file.
 141    *
 142    * Experimental... -
 143    * Should look a bit like
 144    *       [local_col_name] => "related_tablename:related_col_name"
 145    *
 146    *
 147    * @return array|null
 148    *           array       = if there are links defined for this table.
 149    *           empty array - if there is a links.ini file, but no links on this table
 150    *           null        - if no links.ini exists for this database (hence try auto_links).
 151    * @see      DB_DataObject::getLinks(), DB_DataObject::getLink()
 152    */
 153   /**
 154    * @return array|null
 155    */
 156   public function links() {
 157     $link = array('activity_id' => 'civicrm_activity:id');
 158     return $link;
 159   }
 160
 161 }