X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FMailing%2FSelector%2FBrowse.php;h=029acc852c8757594013d35f590602951cfe62c0;hb=b44e3f8468ceba3e1b321d31dd2e35a1aa1a5d9a;hp=8c0fca37fbb41ee1f7f144feeb41f30512867962;hpb=1219e6af26646ad548b2d7e97a7f345af4655c21;p=civicrm-core.git diff --git a/CRM/Mailing/Selector/Browse.php b/CRM/Mailing/Selector/Browse.php index 8c0fca37fb..029acc852c 100644 --- a/CRM/Mailing/Selector/Browse.php +++ b/CRM/Mailing/Selector/Browse.php @@ -3,7 +3,7 @@ +--------------------------------------------------------------------+ | CiviCRM version 4.6 | +--------------------------------------------------------------------+ - | Copyright CiviCRM LLC (c) 2004-2014 | + | Copyright CiviCRM LLC (c) 2004-2015 | +--------------------------------------------------------------------+ | This file is a part of CiviCRM. | | | @@ -23,12 +23,12 @@ | GNU Affero General Public License or the licensing of CiviCRM, | | see the CiviCRM license FAQ at http://civicrm.org/licensing | +--------------------------------------------------------------------+ -*/ + */ /** * * @package CRM - * @copyright CiviCRM LLC (c) 2004-2014 + * @copyright CiviCRM LLC (c) 2004-2015 * $Id$ * */ @@ -39,10 +39,9 @@ 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, currently null * * @var array - * @static */ static $_links = NULL; @@ -50,18 +49,16 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ * We use desc to remind us what that column is, name is used in the tpl * * @var array - * @static */ static $_columnHeaders; protected $_parent; /** - * Class constructor + * Class constructor. * * * @return \CRM_Mailing_Selector_Browse - @access public */ public function __construct() { } @@ -70,7 +67,6 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ * This method returns the links that are given for each search row. * * @return array - * */ public static function &links() { return self::$_links; @@ -81,7 +77,6 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ * * @param $action * @param array $params - * */ public function getPagerParams($action, &$params) { $params['csvString'] = NULL; @@ -95,10 +90,13 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ * 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) + * @param string $action + * The action being performed. + * @param string $output + * What should the result set include (web/email/csv). * - * @return array the column headers that need to be displayed + * @return array + * the column headers that need to be displayed */ public function &getColumnHeaders($action = NULL, $output = NULL) { $mailing = CRM_Mailing_BAO_Mailing::getTableName(); @@ -164,7 +162,8 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ ); if (CRM_Campaign_BAO_Campaign::isCampaignEnable()) { - self::$_columnHeaders[] = array('name' => ts('Campaign'), + self::$_columnHeaders[] = array( + 'name' => ts('Campaign'), 'sort' => 'campaign_id', 'direction' => CRM_Utils_Sort::DONTCARE, ); @@ -182,11 +181,12 @@ class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_ * * @param * - * @return int Total number of rows + * @return int + * Total number of rows */ public function getTotalCount($action) { - $job = CRM_Mailing_BAO_MailingJob::getTableName(); - $mailing = CRM_Mailing_BAO_Mailing::getTableName(); + $job = CRM_Mailing_BAO_MailingJob::getTableName(); + $mailing = CRM_Mailing_BAO_Mailing::getTableName(); $mailingACL = CRM_Mailing_BAO_Mailing::mailingACL(); //get the where clause. @@ -206,21 +206,27 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul } /** - * 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 - * @param int $rowCount the number of rows to return - * @param string $sort the sql string that describes the sort order - * @param enum $output what should the result set include (web/email/csv) + * @param string $action + * The action being performed. + * @param int $offset + * The row number to start from. + * @param int $rowCount + * The number of rows to return. + * @param string $sort + * The sql string that describes the sort order. + * @param string $output + * What should the result set include (web/email/csv). * - * @return int the total number of rows for this action + * @return int + * the total number of rows for this action */ 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?'); - $deleteExtra = ts('Are you sure you want to delete this mailing?'); + $cancelExtra = ts('Are you sure you want to cancel this mailing?'); + $deleteExtra = ts('Are you sure you want to delete this mailing?'); $archiveExtra = ts('Are you sure you want to archive this mailing?'); $actionLinks = array( @@ -352,7 +358,10 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul } } if (in_array($row['status'], array( - 'Scheduled', 'Running', 'Paused'))) { + 'Scheduled', + 'Running', + 'Paused', + ))) { if ($allAccess || ($showApprovalLinks && $showCreateLinks && $showScheduleLinks) ) { @@ -369,7 +378,8 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul } if (in_array($row['status'], array('Complete', 'Canceled')) && - !$row['archived']) { + !$row['archived'] + ) { if ($allAccess || $showCreateLinks) { $actionMask |= CRM_Core_Action::RENEW; } @@ -413,9 +423,11 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * - * @return string name of the file + * @return string + * name of the file */ public function getExportFileName($output = 'csv') { return ts('CiviMail Mailings'); @@ -436,7 +448,7 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul */ public function whereClause(&$params, $sortBy = TRUE) { $values = $clauses = array(); - $isFormSubmitted = $this->_parent->get('hidden_find_mailings'); + $isFormSubmitted = $this->_parent->get('hidden_find_mailings'); $title = $this->_parent->get('mailing_name'); if ($title) { @@ -471,7 +483,7 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul $dateClause1[] = 'civicrm_mailing_job.start_date <= %3'; $dateClause2[] = 'civicrm_mailing_job.scheduled_date <= %3'; } - $params[3] = array($to, 'String'); + $params[3] = array($to, 'String'); } $dateClauses = array(); @@ -494,8 +506,8 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul } // get values submitted by form - $isDraft = $this->_parent->get('status_unscheduled'); - $isArchived = $this->_parent->get('is_archived'); + $isDraft = $this->_parent->get('status_unscheduled'); + $isArchived = $this->_parent->get('is_archived'); $mailingStatus = $this->_parent->get('mailing_status'); if (!$isFormSubmitted && $this->_parent->get('scheduled')) { @@ -526,7 +538,8 @@ LEFT JOIN civicrm_contact scheduledContact ON ( $mailing.scheduled_id = schedul if (isset($isArchived)) { if ($isArchived) { $clauses[] = "civicrm_mailing.is_archived = 1"; - } else { + } + else { $clauses[] = "(civicrm_mailing.is_archived IS NULL OR civicrm_mailing.is_archived = 0)"; } } @@ -595,4 +608,5 @@ ORDER BY LEFT(name, 1) $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_parent->_sortByCharacter, TRUE); $this->_parent->assign('aToZ', $aToZBar); } + }