X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FMailing%2FSelector%2FEvent.php;h=fe09cbff07e53dd4427a0c45ee498dd0bcd5900a;hb=aa0b568b0563900aa6ddc792014cc17af2c3fc90;hp=91036a8df7c76fe6cf05587eedbaf862432da630;hpb=9747cc7e7676edd433c3c76e476a0fd0bd74ea7e;p=civicrm-core.git diff --git a/CRM/Mailing/Selector/Event.php b/CRM/Mailing/Selector/Event.php index 91036a8df7..fe09cbff07 100644 --- a/CRM/Mailing/Selector/Event.php +++ b/CRM/Mailing/Selector/Event.php @@ -42,7 +42,7 @@ 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 @@ -50,32 +50,32 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C 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 */ @@ -100,7 +100,6 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C $this->_job_id = $job; $this->_url_id = $url; } - //end of constructor /** * This method returns the links that are given for each search row. @@ -112,15 +111,13 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C 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 $params + * @param array $params * - * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -130,10 +127,9 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C $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 @@ -341,7 +337,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C } /** - * 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 @@ -421,7 +417,7 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C } /** - * name of export file. + * Name of export file. * * @param string $output type of output * @@ -458,5 +454,4 @@ class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_C return $this->eventToTitle(); } } -//end of class