CRM/Contact/Form/Search/Custom/PostalMailing.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_PostalMailing extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
  36   protected $_aclFrom = NULL;
  37   protected $_aclWhere = NULL;
  38   /**
  39    * @param $formValues
  40    */
  41   public function __construct(&$formValues) {
  42     parent::__construct($formValues);
  43
  44     $this->_columns = array(
  45       ts('Contact ID') => 'contact_id',
  46       ts('Address') => 'address',
  47       ts('Contact Type') => 'contact_type',
  48       ts('Name') => 'sort_name',
  49       ts('State') => 'state_province',
  50     );
  51   }
  52
  53   /**
  54    * @param CRM_Core_Form $form
  55    */
  56   public function buildForm(&$form) {
  57     $groups = array('' => ts('- select group -')) + CRM_Core_PseudoConstant::nestedGroup(FALSE);
  58     $form->addElement('select', 'group_id', ts('Group'), $groups, array('class' => 'crm-select2 huge'));
  59
  60     /**
  61      * if you are using the standard template, this array tells the template what elements
  62      * are part of the search criteria
  63      */
  64     $form->assign('elements', array('group_id'));
  65   }
  66
  67   /**
  68    * @param int $offset
  69    * @param int $rowcount
  70    * @param null $sort
  71    * @param bool $returnSQL
  72    *
  73    * @return string
  74    */
  75   public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL, $returnSQL = FALSE) {
  76     return $this->all($offset, $rowcount, $sort, FALSE, TRUE);
  77   }
  78
  79   /**
  80    * @param int $offset
  81    * @param int $rowcount
  82    * @param null $sort
  83    * @param bool $includeContactIDs
  84    * @param bool $justIDs
  85    *
  86    * @return string
  87    */
  88   public function all(
  89     $offset = 0, $rowcount = 0, $sort = NULL,
  90     $includeContactIDs = FALSE, $justIDs = FALSE
  91   ) {
  92     if ($justIDs) {
  93       $selectClause = "contact_a.id as contact_id";
  94       $sort = 'contact_a.id';
  95     }
  96     else {
  97       $selectClause = "
  98 DISTINCT contact_a.id  as contact_id  ,
  99 contact_a.contact_type  as contact_type,
 100 contact_a.sort_name     as sort_name,
 101 address.street_address  as address,
 102 state_province.name     as state_province
 103 ";
 104     }
 105
 106     return $this->sql($selectClause,
 107       $offset, $rowcount, $sort,
 108       $includeContactIDs, NULL
 109     );
 110   }
 111
 112   /**
 113    * @return string
 114    */
 115   public function from() {
 116     $this->buildACLClause('contact_a');
 117     $from = "
 118 FROM      civicrm_group_contact as cgc,
 119           civicrm_contact       as contact_a
 120 LEFT JOIN civicrm_address address               ON (address.contact_id       = contact_a.id AND
 121                                                     address.is_primary       = 1 )
 122 LEFT JOIN civicrm_state_province state_province ON  state_province.id = address.state_province_id {$this->_aclFrom}
 123 ";
 124     return $from;
 125   }
 126
 127   /**
 128    * @param bool $includeContactIDs
 129    *
 130    * @return string
 131    */
 132   public function where($includeContactIDs = FALSE) {
 133     $params = array();
 134
 135     $count = 1;
 136     $clause = array();
 137     $groupID = CRM_Utils_Array::value('group_id',
 138       $this->_formValues
 139     );
 140     if ($groupID) {
 141       $params[$count] = array($groupID, 'Integer');
 142       $clause[] = "cgc.group_id = %{$count}";
 143     }
 144
 145     $clause[] = "cgc.status   = 'Added'";
 146     $clause[] = "contact_a.id = IF( EXISTS(select cr.id from civicrm_relationship cr where (cr.contact_id_a = cgc.contact_id AND (cr.relationship_type_id = 7 OR cr.relationship_type_id = 6))),
 147                                        (select cr.contact_id_b from civicrm_relationship cr where (cr.contact_id_a = cgc.contact_id AND (cr.relationship_type_id = 7 OR cr.relationship_type_id = 6))),
 148                                         cgc.contact_id )";
 149     $clause[] = "contact_a.contact_type IN ('Individual','Household')";
 150
 151     if ($this->_aclWhere) {
 152       $clause[] = " {$this->_aclWhere} ";
 153     }
 154
 155     if (!empty($clause)) {
 156       $where = implode(' AND ', $clause);
 157     }
 158
 159     return $this->whereClause($where, $params);
 160   }
 161
 162   /**
 163    * @return string
 164    */
 165   public function templateFile() {
 166     return 'CRM/Contact/Form/Search/Custom.tpl';
 167   }
 168
 169   /**
 170    * @param string $tableAlias
 171    */
 172   public function buildACLClause($tableAlias = 'contact') {
 173     list($this->_aclFrom, $this->_aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause($tableAlias);
 174   }
 175
 176 }