3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Contact_Form_Search_Custom_TagContributions
implements CRM_Contact_Form_Search_Interface
{
37 protected $_formValues;
38 public $_permissionedComponent;
43 function __construct(&$formValues) {
44 $this->_formValues
= $formValues;
45 $this->_permissionedComponent
= 'CiviContribute';
48 * Define the columns for search result rows
50 $this->_columns
= array(
51 ts('Contact ID') => 'contact_id',
52 ts('Full Name') => 'sort_name',
53 ts('First Name') => 'first_name',
54 ts('Last Name') => 'last_name',
55 ts('Tag') => 'tag_name',
56 ts('Totals') => 'amount',
63 function buildForm(&$form) {
66 * You can define a custom title for the search form
68 $this->setTitle('Find Contribution Amounts by Tag');
71 * Define the search form fields here
75 $form->addDate('start_date', ts('Contribution Date From'), FALSE, array('formatType' => 'custom'));
76 $form->addDate('end_date', ts('...through'), FALSE, array('formatType' => 'custom'));
77 $tag = array('' => ts('- any tag -')) + CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
78 $form->addElement('select', 'tag', ts('Tagged'), $tag);
81 * If you are using the sample template, this array tells the template fields to render
82 * for the search form.
84 $form->assign('elements', array('start_date', 'end_date', 'tag'));
88 * Define the smarty template used to layout the search form and results listings.
90 function templateFile() {
91 return 'CRM/Contact/Form/Search/Custom.tpl';
95 * Construct the search query
97 function all($offset = 0, $rowcount = 0, $sort = NULL,
98 $includeContactIDs = FALSE, $onlyIDs = FALSE
101 // SELECT clause must include contact_id as an alias for civicrm_contact.id
103 $select = "contact_a.id as contact_id";
108 contact_a.id as contact_id,
109 contact_a.sort_name as sort_name,
110 contact_a.first_name as first_name,
111 contact_a.last_name as last_name,
112 GROUP_CONCAT(DISTINCT civicrm_tag.name ORDER BY civicrm_tag.name ASC ) as tag_name,
113 sum(civicrm_contribution.total_amount) as amount
116 $from = $this->from();
118 $where = $this->where($includeContactIDs);
126 $sql .= " GROUP BY contact_a.id";
127 // Define ORDER BY for query in $sort, with default value
129 if (is_string($sort)) {
130 $sort = CRM_Utils_Type
::escape($sort, 'String');
131 $sql .= " ORDER BY $sort ";
134 $sql .= " ORDER BY " . trim($sort->orderBy());
148 civicrm_contribution,
149 civicrm_contact contact_a
150 LEFT JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
151 civicrm_entity_tag.entity_id = contact_a.id )
152 LEFT JOIN civicrm_tag ON civicrm_tag.id = civicrm_entity_tag.tag_id
157 * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
161 * @param bool $includeContactIDs
165 function where($includeContactIDs = FALSE) {
168 $clauses[] = "contact_a.contact_type = 'Individual'";
169 $clauses[] = "civicrm_contribution.contact_id = contact_a.id";
171 $startDate = CRM_Utils_Date
::processDate($this->_formValues
['start_date']);
173 $clauses[] = "civicrm_contribution.receive_date >= $startDate";
176 $endDate = CRM_Utils_Date
::processDate($this->_formValues
['end_date']);
178 $clauses[] = "civicrm_contribution.receive_date <= $endDate";
181 $tag = CRM_Utils_Array
::value('tag', $this->_formValues
);
183 $clauses[] = "civicrm_entity_tag.tag_id = $tag";
184 $clauses[] = "civicrm_tag.id = civicrm_entity_tag.tag_id";
187 $clauses[] = "civicrm_entity_tag.tag_id IS NOT NULL";
190 if ($includeContactIDs) {
191 $contactIDs = array();
192 foreach ($this->_formValues
as $id => $value) {
194 substr($id, 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
196 $contactIDs[] = substr($id, CRM_Core_Form
::CB_PREFIX_LEN
);
200 if (!empty($contactIDs)) {
201 $contactIDs = implode(', ', $contactIDs);
202 $clauses[] = "contact_a.id IN ( $contactIDs )";
205 return implode(' AND ', $clauses);
210 * Functions below generally don't need to be modified
218 $dao = CRM_Core_DAO
::executeQuery($sql,
219 CRM_Core_DAO
::$_nullArray
226 * @param int $rowcount
231 function contactIDs($offset = 0, $rowcount = 0, $sort = NULL) {
232 return $this->all($offset, $rowcount, $sort, FALSE, TRUE);
238 function &columns() {
239 return $this->_columns
;
245 function setTitle($title) {
247 CRM_Utils_System
::setTitle($title);
250 CRM_Utils_System
::setTitle(ts('Search'));