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