CRM/Contact/Form/Search/Custom.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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(array('title' => ts('Custom Searches'),
  68         'url' => CRM_Utils_System::url('civicrm/contact/search/custom/list',
  69           'reset=1'
  70         ),
  71       ));
  72     CRM_Utils_System::appendBreadCrumb($breadCrumb);
  73
  74     // use the custom selector
  75     self::$_selectorName = 'CRM_Contact_Selector_Custom';
  76
  77     $this->set('customSearchID', $this->_customSearchID);
  78     $this->set('customSearchClass', $this->_customSearchClass);
  79
  80     parent::preProcess();
  81
  82     // instantiate the new class
  83     $this->_customClass = new $this->_customSearchClass( $this->_formValues );
  84
  85     // CRM-12747
  86     if (isset($this->_customClass->_permissionedComponent) &&
  87       !self::isPermissioned($this->_customClass->_permissionedComponent)) {
  88       CRM_Utils_System::permissionDenied();
  89     }
  90   }
  91
  92   function setDefaultValues() {
  93     if (method_exists($this->_customSearchClass, 'setDefaultValues')) {
  94       return $this->_customClass->setDefaultValues();
  95     }
  96     return $this->_formValues;
  97   }
  98
  99   function buildQuickForm() {
 100     $this->_customClass->buildForm($this);
 101
 102     parent::buildQuickForm();
 103   }
 104
 105   function getTemplateFileName() {
 106
 107     $ext = CRM_Extension_System::singleton()->getMapper();
 108
 109     if ($ext->isExtensionClass(CRM_Utils_System::getClassName($this->_customClass))) {
 110       $fileName = $ext->getTemplatePath(CRM_Utils_System::getClassName($this->_customClass)) . '/' . $ext->getTemplateName(CRM_Utils_System::getClassName($this->_customClass));
 111     }
 112     else {
 113       $fileName = $this->_customClass->templateFile();
 114     }
 115
 116     return $fileName ? $fileName : parent::getTemplateFileName();
 117   }
 118
 119   function postProcess() {
 120     $this->set('isAdvanced', '3');
 121     $this->set('isCustom', '1');
 122
 123     // get user submitted values
 124     // get it from controller only if form has been submitted, else preProcess has set this
 125     if (!empty($_POST)) {
 126       $this->_formValues = $this->controller->exportValues($this->_name);
 127
 128       $this->_formValues['customSearchID'] = $this->_customSearchID;
 129       $this->_formValues['customSearchClass'] = $this->_customSearchClass;
 130     }
 131
 132     //use the custom selector
 133     self::$_selectorName = 'CRM_Contact_Selector_Custom';
 134
 135     parent::postProcess();
 136   }
 137
 138   public function getTitle() {
 139     return ts('Custom Search');
 140   }
 141
 142   function isPermissioned($components) {
 143     if (empty($components)) {
 144       return TRUE;
 145     }
 146     if (is_array($components)) {
 147       foreach ($components as $component) {
 148         if (!CRM_Core_Permission::access($component)) {
 149           return FALSE;
 150         }
 151       }
 152     }
 153     else {
 154       if (!CRM_Core_Permission::access($components)) {
 155         return FALSE;
 156       }
 157     }
 158     return TRUE;
 159   }
 160 }