CRM/Contact/BAO/GroupOrganization.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33 class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganization {
  34
  35   /**
  36    * Class constructor.
  37    */
  38   public function __construct() {
  39     parent::__construct();
  40   }
  41
  42   /**
  43    * Takes an associative array and creates a groupOrganization object.
  44    *
  45    * @param array $params
  46    *   (reference ) an assoc array of name/value pairs.
  47    *
  48    * @return CRM_Contact_DAO_GroupOrganization
  49    */
  50   public static function add(&$params) {
  51     if (!empty($params['group_organization'])) {
  52       $params['id'] = $params['group_organization'];
  53     }
  54     $dataExists = self::dataExists($params);
  55     if (!$dataExists && empty($params['id'])) {
  56       return NULL;
  57     }
  58     $groupOrganization = new CRM_Contact_DAO_GroupOrganization();
  59     $groupOrganization->copyValues($params);
  60     if (!isset($params['id'])) {
  61       // we have ensured we have group_id & organization_id so we can do a find knowing that
  62       // this can only find a matching record
  63       $groupOrganization->find(TRUE);
  64     }
  65     $groupOrganization->save();
  66     return $groupOrganization;
  67   }
  68
  69   /**
  70    * Check if there is data to create the object.
  71    *
  72    * @param array $params
  73    *   (reference ) an assoc array of name/value pairs.
  74    *
  75    * @return bool
  76    */
  77   public static function dataExists($params) {
  78     // return if no data present
  79     if (!empty($params['organization_id']) && !empty($params['group_id'])) {
  80       return TRUE;
  81     }
  82     return FALSE;
  83   }
  84
  85   /**
  86    * @param int $groupID
  87    * @param $defaults
  88    */
  89   public static function retrieve($groupID, &$defaults) {
  90     $dao = new CRM_Contact_DAO_GroupOrganization();
  91     $dao->group_id = $groupID;
  92     if ($dao->find(TRUE)) {
  93       $defaults['group_organization'] = $dao->id;
  94       $defaults['organization_id'] = $dao->organization_id;
  95     }
  96   }
  97
  98   /**
  99    * Method to check group organization relationship exist.
 100    *
 101    * @param int $contactID
 102    *
 103    * @return bool
 104    */
 105   public static function hasGroupAssociated($contactID) {
 106     $orgID = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_GroupOrganization',
 107       $contactID, 'group_id', 'organization_id'
 108     );
 109     if ($orgID) {
 110       return TRUE;
 111     }
 112     return FALSE;
 113   }
 114
 115   /**
 116    * Delete Group Organization.
 117    *
 118    * @param int $groupOrganizationID
 119    *   Group organization id that needs to be deleted.
 120    *
 121    * @return int|null
 122    *   no of deleted group organization on success, false otherwise
 123    */
 124   public static function deleteGroupOrganization($groupOrganizationID) {
 125     $results = NULL;
 126     $groupOrganization = new CRM_Contact_DAO_GroupOrganization();
 127     $groupOrganization->id = $groupOrganizationID;
 128
 129     $results = $groupOrganization->delete();
 130
 131     return $results;
 132   }
 133
 134 }