<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
class CRM_Mailing_Selector_Event 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;
/**
- * what event type are we browsing?
+ * What event type are we browsing?
*/
private $_event;
/**
- * should we only count distinct contacts?
+ * Should we only count distinct contacts?
*/
private $_is_distinct;
/**
- * which mailing are we browsing events from?
+ * Which mailing are we browsing events from?
*/
private $_mailing_id;
/**
- * do we want events tied to a specific job?
+ * Do we want events tied to a specific job?
*/
private $_job_id;
/**
- * for click-through events, do we only want those from a specific url?
+ * For click-through events, do we only want those from a specific url?
*/
private $_url_id;
/**
- * 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
*/
/**
* Class constructor
*
- * @param string $event The event type (queue/delivered/open...)
- * @param boolean $distinct Count only distinct contact events?
- * @param int $mailing ID of the mailing to query
- * @param int $job ID of the job to query. If null, all jobs from $mailing are queried.
- * @param int $url If the event type is a click-through, do we want only those from a specific url?
+ * @param string $event The event type (queue/delivered/open...)
+ * @param boolean $distinct Count only distinct contact events?
+ * @param int $mailing ID of the mailing to query
+ * @param int $job ID of the job to query. If null, all jobs from $mailing are queried.
+ * @param int $url If the event type is a click-through, do we want only those from a specific url?
*
- * @return CRM_Contact_Selector_Profile
- * @access public
+ * @return \CRM_Mailing_Selector_Event
+ @access public
*/
function __construct($event, $distinct, $mailing, $job = NULL, $url = NULL) {
$this->_event_type = $event;
$this->_job_id = $job;
$this->_url_id = $url;
}
- //end of constructor
/**
* This method returns the links that are given for each search row.
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) {
$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
}
/**
- * 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
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
return $this->eventToTitle();
}
}
-//end of class