3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
37 * This class is used to retrieve and display a range of
38 * contacts that match the given criteria (specifically for
39 * results of advanced search options.
42 class CRM_Mailing_Selector_Search
extends CRM_Core_Selector_Base
implements CRM_Core_Selector_API
{
45 * This defines two actions- View and Edit.
49 static $_links = NULL;
52 * We use desc to remind us what that column is, name is used in the tpl
56 static $_columnHeaders;
59 * Properties of contact we're interested in displaying
62 static $_properties = array(
72 'mailing_job_end_date',
76 * Are we restricting ourselves to a single contact
80 protected $_single = FALSE;
83 * Are we restricting ourselves to a single contact
87 protected $_limit = NULL;
90 * What context are we being invoked from
94 protected $_context = NULL;
97 * What component context are we being invoked from
101 protected $_compContext = NULL;
104 * QueryParams is the array returned by exportValues called on
105 * the HTML_QuickForm_Controller for that page.
109 public $_queryParams;
112 * Represent the type of selector.
119 * The additional clause that we restrict the search with.
123 protected $_mailingClause = NULL;
135 * @param array $queryParams
136 * Array of parameters for query.
137 * @param \const|int $action - action of search basic or advanced.
138 * @param string $mailingClause
139 * If the caller wants to further restrict the search.
140 * @param bool $single
141 * Are we dealing only with one contact?.
143 * How many mailing do we want returned.
145 * @param string $context
146 * @param null $compContext
148 * @return \CRM_Mailing_Selector_Search
150 public function __construct(
152 $action = CRM_Core_Action
::NONE
,
153 $mailingClause = NULL,
159 // submitted form values
160 $this->_queryParams
= &$queryParams;
162 $this->_single
= $single;
163 $this->_limit
= $limit;
164 $this->_context
= $context;
165 $this->_compContext
= $compContext;
167 $this->_mailingClause
= $mailingClause;
170 $this->_action
= $action;
171 $this->_query
= new CRM_Contact_BAO_Query($this->_queryParams
,
172 CRM_Mailing_BAO_Query
::defaultReturnProperties(CRM_Contact_BAO_Query
::MODE_MAILING
,
176 CRM_Contact_BAO_Query
::MODE_MAILING
179 $this->_query
->_distinctComponentClause
= " civicrm_mailing_recipients.id ";
183 * This method returns the links that are given for each search row.
184 * currently the links added for each row are
191 public static function &links() {
192 if (!(self
::$_links)) {
193 list($context, $key) = func_get_args();
194 $extraParams = ($key) ?
"&key={$key}" : NULL;
195 $searchContext = ($context) ?
"&context=$context" : NULL;
197 self
::$_links = array(
198 CRM_Core_Action
::VIEW
=> array(
199 'name' => ts('View'),
200 'url' => 'civicrm/contact/view',
201 'qs' => "reset=1&cid=%%cid%%{$searchContext}{$extraParams}",
202 'title' => ts('View Contact Details'),
204 CRM_Core_Action
::UPDATE
=> array(
205 'name' => ts('Edit'),
206 'url' => 'civicrm/contact/add',
207 'qs' => "reset=1&action=update&cid=%%cid%%{$searchContext}{$extraParams}",
208 'title' => ts('Edit Contact Details'),
210 CRM_Core_Action
::DELETE
=> array(
211 'name' => ts('Delete'),
212 'url' => 'civicrm/contact/view/delete',
213 'qs' => "reset=1&delete=1&cid=%%cid%%{$searchContext}{$extraParams}",
214 'title' => ts('Delete Contact'),
218 return self
::$_links;
222 * Getter for array of the parameters required for creating pager.
225 * @param array $params
227 public function getPagerParams($action, &$params) {
228 $params['status'] = ts('Mailing Recipient') . ' %%StatusMessage%%';
229 $params['csvString'] = NULL;
231 $params['rowCount'] = $this->_limit
;
234 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
237 $params['buttonTop'] = 'PagerTopButton';
238 $params['buttonBottom'] = 'PagerBottomButton';
242 * Returns total number of rows for the query.
247 * Total number of rows
249 public function getTotalCount($action) {
250 return $this->_query
->searchQuery(0, 0, NULL,
254 $this->_mailingClause
259 * Returns all the rows in the given offset and rowCount.
261 * @param string $action
262 * The action being performed.
264 * The row number to start from.
265 * @param int $rowCount
266 * The number of rows to return.
267 * @param string $sort
268 * The sql string that describes the sort order.
269 * @param string $output
270 * What should the result set include (web/email/csv).
273 * the total number of rows for this action
275 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
276 $result = $this->_query
->searchQuery($offset, $rowCount, $sort,
280 $this->_mailingClause
283 // process the result of the query
285 $permissions = array(CRM_Core_Permission
::getPermission());
286 if (CRM_Core_Permission
::check('delete contacts')) {
287 $permissions[] = CRM_Core_Permission
::DELETE
;
289 $mask = CRM_Core_Action
::mask($permissions);
290 $qfKey = $this->_key
;
292 while ($result->fetch()) {
294 // the columns we are interested in
295 foreach (self
::$_properties as $property) {
296 if (property_exists($result, $property)) {
297 $row[$property] = $result->$property;
301 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->mailing_recipients_id
;
304 'cid' => $result->contact_id
,
305 'cxt' => $this->_context
,
308 $row['action'] = CRM_Core_Action
::formLink(
309 self
::links($qfKey, $this->_context
),
314 'contact.mailing.row',
318 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
, FALSE, $result->contact_id
329 public function getQILL() {
330 return $this->_query
->qill();
334 * Returns the column headers as an array of tuples:
335 * (name, sortName (key to the sort array))
337 * @param string $action
338 * The action being performed.
339 * @param string $output
340 * What should the result set include (web/email/csv).
343 * the column headers that need to be displayed
345 public function &getColumnHeaders($action = NULL, $output = NULL) {
346 if (!isset(self
::$_columnHeaders)) {
347 self
::$_columnHeaders = array(
348 array('desc' => ts('Contact Type')),
350 'name' => ts('Name'),
351 'sort' => 'sort_name',
352 'direction' => CRM_Utils_Sort
::DONTCARE
,
355 'name' => ts('Email'),
357 'direction' => CRM_Utils_Sort
::DONTCARE
,
360 'name' => ts('Mailing Name'),
361 'sort' => 'mailing_name',
362 'direction' => CRM_Utils_Sort
::DONTCARE
,
365 'name' => ts('Mailing Subject'),
366 'sort' => 'mailing_subject',
367 'direction' => CRM_Utils_Sort
::DONTCARE
,
370 'name' => ts('Mailing Status'),
371 'sort' => 'mailing_job_status',
372 'direction' => CRM_Utils_Sort
::DONTCARE
,
375 'name' => ts('Completed Date'),
376 'sort' => 'mailing_job_end_date',
377 'direction' => CRM_Utils_Sort
::DONTCARE
,
379 array('desc' => ts('Actions')),
382 return self
::$_columnHeaders;
388 public function alphabetQuery() {
389 return $this->_query
->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
395 public function &getQuery() {
396 return $this->_query
;
400 * Name of export file.
402 * @param string $output
408 public function getExportFileName($output = 'csv') {
409 return ts('CiviCRM Mailing Search');