CRM/Contact/Form/Search/Custom.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  */
  33 class CRM_Contact_Form_Search_Custom extends CRM_Contact_Form_Search {
  34
  35   protected $_customClass = NULL;
  36
  37   public function preProcess() {
  38     $this->set('searchFormName', 'Custom');
  39
  40     $this->set('context', 'custom');
  41
  42     $csID = CRM_Utils_Request::retrieve('csid', 'Integer', $this);
  43     $ssID = CRM_Utils_Request::retrieve('ssID', 'Integer', $this);
  44     $gID = CRM_Utils_Request::retrieve('gid', 'Integer', $this);
  45
  46     list(
  47       $this->_customSearchID,
  48       $this->_customSearchClass,
  49       $formValues
  50       ) = CRM_Contact_BAO_SearchCustom::details($csID, $ssID, $gID);
  51
  52     if (!$this->_customSearchID) {
  53       CRM_Core_Error::fatal('Could not get details for custom search.');
  54     }
  55
  56     // stash this as a hidden element so we can potentially go there if the session
  57     // is reset but this is available in the POST
  58     $this->addElement('hidden', 'csid', $csID);
  59
  60     if (!empty($formValues)) {
  61       $this->_formValues = $formValues;
  62     }
  63
  64     // set breadcrumb to return to Custom Search listings page
  65     $breadCrumb = array(
  66       array(
  67         'title' => ts('Custom Searches'),
  68         'url' => CRM_Utils_System::url('civicrm/contact/search/custom/list',
  69           'reset=1'
  70         ),
  71       ),
  72     );
  73     CRM_Utils_System::appendBreadCrumb($breadCrumb);
  74
  75     // use the custom selector
  76     self::$_selectorName = 'CRM_Contact_Selector_Custom';
  77
  78     $this->set('customSearchID', $this->_customSearchID);
  79     $this->set('customSearchClass', $this->_customSearchClass);
  80
  81     parent::preProcess();
  82
  83     // instantiate the new class
  84     $this->_customClass = new $this->_customSearchClass($this->_formValues);
  85
  86     // CRM-12747
  87     if (isset($this->_customClass->_permissionedComponent) &&
  88       !self::isPermissioned($this->_customClass->_permissionedComponent)
  89     ) {
  90       CRM_Utils_System::permissionDenied();
  91     }
  92   }
  93
  94   /**
  95    * Set the default values of various form elements.
  96    *
  97    * @return array
  98    *   reference to the array of default values
  99    */
 100   public function setDefaultValues() {
 101     if (method_exists($this->_customSearchClass, 'setDefaultValues')) {
 102       return $this->_customClass->setDefaultValues();
 103     }
 104     return $this->_formValues;
 105   }
 106
 107   /**
 108    * Builds the list of tasks or actions that a searcher can perform on a result set.
 109    *
 110    * @return array
 111    */
 112   public function buildTaskList() {
 113     // call the parent method to populate $this->_taskList for the custom search
 114     parent::buildTaskList();
 115
 116     return $this->_customClass->buildTaskList($this);
 117   }
 118
 119   public function buildQuickForm() {
 120     $this->_customClass->buildForm($this);
 121
 122     parent::buildQuickForm();
 123   }
 124
 125   /**
 126    * Use the form name to create the tpl file name.
 127    *
 128    * @return string
 129    */
 130   /**
 131    * @return string
 132    */
 133   public function getTemplateFileName() {
 134
 135     $ext = CRM_Extension_System::singleton()->getMapper();
 136
 137     if ($ext->isExtensionClass(CRM_Utils_System::getClassName($this->_customClass))) {
 138       $fileName = $ext->getTemplatePath(CRM_Utils_System::getClassName($this->_customClass)) . '/' . $ext->getTemplateName(CRM_Utils_System::getClassName($this->_customClass));
 139     }
 140     else {
 141       $fileName = $this->_customClass->templateFile();
 142     }
 143
 144     return $fileName ? $fileName : parent::getTemplateFileName();
 145   }
 146
 147   public function postProcess() {
 148     $this->set('isAdvanced', '3');
 149     $this->set('isCustom', '1');
 150
 151     // get user submitted values
 152     // get it from controller only if form has been submitted, else preProcess has set this
 153     if (!empty($_POST)) {
 154       $this->_formValues = $this->controller->exportValues($this->_name);
 155
 156       $this->_formValues['customSearchID'] = $this->_customSearchID;
 157       $this->_formValues['customSearchClass'] = $this->_customSearchClass;
 158     }
 159
 160     //use the custom selector
 161     self::$_selectorName = 'CRM_Contact_Selector_Custom';
 162
 163     parent::postProcess();
 164   }
 165
 166   /**
 167    * Return a descriptive name for the page, used in wizard header.
 168    *
 169    * @return string
 170    */
 171   public function getTitle() {
 172     return ts('Custom Search');
 173   }
 174
 175   /**
 176    * @param $components
 177    *
 178    * @return bool
 179    */
 180   public function isPermissioned($components) {
 181     if (empty($components)) {
 182       return TRUE;
 183     }
 184     if (is_array($components)) {
 185       foreach ($components as $component) {
 186         if (!CRM_Core_Permission::access($component)) {
 187           return FALSE;
 188         }
 189       }
 190     }
 191     else {
 192       if (!CRM_Core_Permission::access($components)) {
 193         return FALSE;
 194       }
 195     }
 196     return TRUE;
 197   }
 198
 199 }