<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
* 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
*
* @var array
- * @static
*/
static $_columnHeaders;
protected $_parent;
/**
- * Class constructor
+ * Class constructor.
*
*
* @return \CRM_Mailing_Selector_Browse
- @access public
*/
- function __construct() {
+ public function __construct() {
}
/**
* 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;
}
*
* @param $action
* @param array $params
- *
- * @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%%');
* 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
- * @access public
+ * @return array
+ * the column headers that need to be displayed
*/
- 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)) {
);
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,
);
*
* @param
*
- * @return int Total number of rows
- * @access public
+ * @return int
+ * Total number of rows
*/
- function getTotalCount($action) {
- $job = CRM_Mailing_BAO_MailingJob::getTableName();
- $mailing = CRM_Mailing_BAO_Mailing::getTableName();
+ public function getTotalCount($action) {
+ $job = CRM_Mailing_BAO_MailingJob::getTableName();
+ $mailing = CRM_Mailing_BAO_Mailing::getTableName();
$mailingACL = CRM_Mailing_BAO_Mailing::mailingACL();
//get the where clause.
}
/**
- * 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
*/
- 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?');
- $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(
}
}
if (in_array($row['status'], array(
- 'Scheduled', 'Running', 'Paused'))) {
+ 'Scheduled',
+ 'Running',
+ 'Paused',
+ ))) {
if ($allAccess ||
($showApprovalLinks && $showCreateLinks && $showScheduleLinks)
) {
}
if (in_array($row['status'], array('Complete', 'Canceled')) &&
- !$row['archived']) {
+ !$row['archived']
+ ) {
if ($allAccess || $showCreateLinks) {
$actionMask |= CRM_Core_Action::RENEW;
}
/**
* 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
*/
- function getExportFileName($output = 'csv') {
+ public function getExportFileName($output = 'csv') {
return ts('CiviMail Mailings');
}
/**
* @param $parent
*/
- function setParent($parent) {
+ public function setParent($parent) {
$this->_parent = $parent;
}
*
* @return int|string
*/
- function whereClause(&$params, $sortBy = TRUE) {
+ 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) {
$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();
}
// 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')) {
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)";
}
}
return implode(' AND ', $clauses);
}
- function pagerAtoZ() {
+ public function pagerAtoZ() {
$params = array();
$whereClause = $this->whereClause($params, FALSE);
$aToZBar = CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_parent->_sortByCharacter, TRUE);
$this->_parent->assign('aToZ', $aToZBar);
}
-}
+}