<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.4 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id$
*
*/
class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
/**
- * array of supported links, currenly null
+ * Array of supported links, currenly null
*
* @var array
* @static
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
/**
* Class constructor
*
- * @param
*
- * @return CRM_Contact_Selector_Profile
- * @access public
+ * @return \CRM_Mailing_Selector_Browse
+ @access public
*/
- function __construct() {
+ public function __construct() {
}
- //end of constructor
/**
* This method returns the links that are given for each search row.
*
* @return array
- * @access public
*
*/
- static function &links() {
+ public static function &links() {
return self::$_links;
}
- //end of function
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
+ *
+ * @param $action
+ * @param array $params
*
- * @param
- * @access public
*/
- function getPagerParams($action, &$params) {
+ public function getPagerParams($action, &$params) {
$params['csvString'] = NULL;
$params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
$params['status'] = ts('Mailings %%StatusMessage%%');
$params['buttonTop'] = 'PagerTopButton';
$params['buttonBottom'] = 'PagerBottomButton';
}
- //end of function
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
* @param enum $output what should the result set include (web/email/csv)
*
* @return array the column headers that need to be displayed
- * @access public
*/
- function &getColumnHeaders($action = NULL, $output = NULL) {
+ public function &getColumnHeaders($action = NULL, $output = NULL) {
$mailing = CRM_Mailing_BAO_Mailing::getTableName();
$job = CRM_Mailing_BAO_MailingJob::getTableName();
if (!isset(self::$_columnHeaders)) {
* @param
*
* @return int Total number of rows
- * @access public
*/
- function getTotalCount($action) {
+ public function getTotalCount($action) {
$job = CRM_Mailing_BAO_MailingJob::getTableName();
$mailing = CRM_Mailing_BAO_Mailing::getTableName();
$mailingACL = CRM_Mailing_BAO_Mailing::mailingACL();
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
*
* @return int the total number of rows for this action
*/
- function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
+ public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
static $actionLinks = NULL;
if (empty($actionLinks)) {
$cancelExtra = ts('Are you sure you want to cancel this mailing?');
}
}
- if ($row['status'] == 'Complete' && !$row['archived']) {
+ if (in_array($row['status'], array('Complete', 'Canceled')) &&
+ !$row['archived']) {
if ($allAccess || $showCreateLinks) {
$actionMask |= CRM_Core_Action::RENEW;
}
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
* @return string name of the file
*/
- function getExportFileName($output = 'csv') {
+ public function getExportFileName($output = 'csv') {
return ts('CiviMail Mailings');
}
- function setParent($parent) {
+ /**
+ * @param $parent
+ */
+ public function setParent($parent) {
$this->_parent = $parent;
}
- function whereClause(&$params, $sortBy = TRUE) {
+ /**
+ * @param array $params
+ * @param bool $sortBy
+ *
+ * @return int|string
+ */
+ public function whereClause(&$params, $sortBy = TRUE) {
$values = $clauses = array();
$isFormSubmitted = $this->_parent->get('hidden_find_mailings');
$isDraft = 1;
}
+ $statusClauses = array();
if ($isDraft) {
- $clauses[] = "civicrm_mailing_job.status IS NULL";
- $clauses[] = "civicrm_mailing.scheduled_id IS NULL";
+ $statusClauses[] = "civicrm_mailing.scheduled_id IS NULL";
}
-
- // CRM-4290, do not show archived or unscheduled mails
- // on 'Scheduled and Sent Mailing' page selector
if (!empty($mailingStatus)) {
- $clauses[] = "civicrm_mailing.scheduled_id IS NOT NULL";
- $clauses[] = "civicrm_mailing_job.status IN ('" . implode("', '", array_keys($mailingStatus)) . "')";
+ $statusClauses[] = "civicrm_mailing_job.status IN ('" . implode("', '", array_keys($mailingStatus)) . "')";
+ }
+ if (!empty($statusClauses)) {
+ $clauses[] = "(" . implode(' OR ', $statusClauses) . ")";
}
if (isset($isArchived)) {
if ($isArchived) {
- // CRM-6446: archived view should also show cancelled mailings
- $clauses[] = "(civicrm_mailing.is_archived = 1 OR civicrm_mailing_job.status = 'Canceled')";
+ $clauses[] = "civicrm_mailing.is_archived = 1";
} else {
$clauses[] = "(civicrm_mailing.is_archived IS NULL OR civicrm_mailing.is_archived = 0)";
}
return implode(' AND ', $clauses);
}
- function pagerAtoZ() {
+ public function pagerAtoZ() {
$params = array();
$whereClause = $this->whereClause($params, FALSE);
$this->_parent->assign('aToZ', $aToZBar);
}
}
-//end of class
-