CRM/Contact/BAO/SearchCustom.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_SearchCustom {
  34
  35   /**
  36    * Get details.
  37    *
  38    * @param int $csID
  39    * @param int $ssID
  40    * @param int $gID
  41    *
  42    * @return array
  43    * @throws Exception
  44    */
  45   public static function details($csID, $ssID = NULL, $gID = NULL) {
  46     $error = [NULL, NULL, NULL];
  47
  48     if (!$csID &&
  49       !$ssID &&
  50       !$gID
  51     ) {
  52       return $error;
  53     }
  54
  55     $customSearchID = $csID;
  56     $formValues = [];
  57     if ($ssID || $gID) {
  58       if ($gID) {
  59         $ssID = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $gID, 'saved_search_id');
  60       }
  61
  62       $formValues = CRM_Contact_BAO_SavedSearch::getFormValues($ssID);
  63       $customSearchID = CRM_Utils_Array::value('customSearchID',
  64         $formValues
  65       );
  66     }
  67
  68     if (!$customSearchID) {
  69       return $error;
  70     }
  71
  72     // check that the csid exists in the db along with the right file
  73     // and implements the right interface
  74     $customSearchClass = civicrm_api3('OptionValue', 'getvalue', [
  75       'option_group_id' => 'custom_search',
  76       'return' => 'name',
  77       'value' => $customSearchID,
  78     ]);
  79
  80     $ext = CRM_Extension_System::singleton()->getMapper();
  81
  82     if (!$ext->isExtensionKey($customSearchClass)) {
  83       $customSearchFile = str_replace('_',
  84           DIRECTORY_SEPARATOR,
  85           $customSearchClass
  86         ) . '.php';
  87     }
  88     else {
  89       $customSearchFile = $ext->keyToPath($customSearchClass);
  90       $customSearchClass = $ext->keyToClass($customSearchClass);
  91     }
  92
  93     $error = include_once $customSearchFile;
  94     if ($error == FALSE) {
  95       CRM_Core_Error::fatal('Custom search file: ' . $customSearchFile . ' does not exist. Please verify your custom search settings in CiviCRM administrative panel.');
  96     }
  97
  98     return [$customSearchID, $customSearchClass, $formValues];
  99   }
 100
 101   /**
 102    * @param int $csID
 103    * @param int $ssID
 104    *
 105    * @return mixed
 106    * @throws Exception
 107    */
 108   public static function customClass($csID, $ssID) {
 109     list($customSearchID, $customSearchClass, $formValues) = self::details($csID, $ssID);
 110
 111     if (!$customSearchID) {
 112       CRM_Core_Error::fatal('Could not resolve custom search ID');
 113     }
 114
 115     // instantiate the new class
 116     $customClass = new $customSearchClass($formValues);
 117
 118     return $customClass;
 119   }
 120
 121   /**
 122    * @param int $csID
 123    * @param int $ssID
 124    *
 125    * @return mixed
 126    */
 127   public static function contactIDSQL($csID, $ssID) {
 128     $customClass = self::customClass($csID, $ssID);
 129     return $customClass->contactIDs();
 130   }
 131
 132   /**
 133    * @param $args
 134    *
 135    * @return array
 136    */
 137   public static function &buildFormValues($args) {
 138     $args = trim($args);
 139
 140     $values = explode("\n", $args);
 141     $formValues = [];
 142     foreach ($values as $value) {
 143       list($n, $v) = CRM_Utils_System::explode('=', $value, 2);
 144       if (!empty($v)) {
 145         $formValues[$n] = $v;
 146       }
 147     }
 148     return $formValues;
 149   }
 150
 151   /**
 152    * @param int $csID
 153    * @param int $ssID
 154    *
 155    * @return array
 156    */
 157   public static function fromWhereEmail($csID, $ssID) {
 158     $customClass = self::customClass($csID, $ssID);
 159
 160     $from = $customClass->from();
 161     $where = $customClass->where();
 162
 163     return [$from, $where];
 164   }
 165
 166 }