X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FActivity%2FSelector%2FSearch.php;h=c46c439b4678dc5332eec44c346c9a9be35f5556;hb=32864ccf6ecdf9927f12f57a693ef0f22d9ccfb4;hp=61b70d40b635b7993a79c57b73f18b099af3b492;hpb=718e934e2c6fa496ee84f56502d73cae125b1331;p=civicrm-core.git diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php index 61b70d40b6..c46c439b46 100644 --- a/CRM/Activity/Selector/Search.php +++ b/CRM/Activity/Selector/Search.php @@ -84,7 +84,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * Are we restricting ourselves to a single contact * - * @access protected * @var boolean */ protected $_single = FALSE; @@ -92,7 +91,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * Are we restricting ourselves to a single contact * - * @access protected * @var boolean */ protected $_limit = NULL; @@ -100,7 +98,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * What context are we being invoked from * - * @access protected * @var string */ protected $_context = NULL; @@ -108,7 +105,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * What component context are we being invoked from * - * @access protected * @var string */ protected $_compContext = NULL; @@ -118,7 +114,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM * the HTML_QuickForm_Controller for that page. * * @var array - * @access protected */ public $_queryParams; @@ -126,7 +121,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM * Represent the type of selector * * @var int - * @access protected */ protected $_action; @@ -147,11 +141,15 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * Class constructor * - * @param array $queryParams array of parameters for query + * @param array $queryParams + * Array of parameters for query. * @param \const|int $action - action of search basic or advanced. - * @param string $activityClause if the caller wants to further restrict the search (used in activities) - * @param boolean $single are we dealing only with one contact? - * @param int $limit how many activities do we want returned + * @param string $activityClause + * If the caller wants to further restrict the search (used in activities). + * @param bool $single + * Are we dealing only with one contact?. + * @param int $limit + * How many activities do we want returned. * * @param string $context * @param null $compContext @@ -160,12 +158,12 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM @access public */ function __construct(&$queryParams, - $action = CRM_Core_Action::NONE, + $action = CRM_Core_Action::NONE, $activityClause = NULL, - $single = FALSE, - $limit = NULL, - $context = 'search', - $compContext = NULL + $single = FALSE, + $limit = NULL, + $context = 'search', + $compContext = NULL ) { // submitted form values $this->_queryParams = &$queryParams; @@ -196,9 +194,8 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM * @param $action * @param array $params * - * @access public */ - function getPagerParams($action, &$params) { + public function getPagerParams($action, &$params) { $params['status'] = ts('Activities %%StatusMessage%%'); $params['csvString'] = NULL; $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT; @@ -212,9 +209,8 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM * @param * * @return int Total number of rows - * @access public */ - function getTotalCount($action) { + public function getTotalCount($action) { return $this->_query->searchQuery(0, 0, NULL, TRUE, FALSE, FALSE, FALSE, @@ -226,15 +222,20 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * 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 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). * * @return array rows in the given offset and rowCount */ - function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { + public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { $result = $this->_query->searchQuery( $offset, $rowCount, $sort, FALSE, FALSE, @@ -286,8 +287,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM if ($this->_context == 'search') { $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->activity_id; } - $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? - $result->contact_sub_type : $result->contact_type, FALSE, $result->contact_id + $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type, FALSE, $result->contact_id ); $accessMailingReport = FALSE; $activityTypeId = $row['activity_type_id']; @@ -359,7 +359,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * @return array $qill which contains an array of strings - * @access public */ public function getQILL() { return $this->_query->qill(); @@ -369,11 +368,12 @@ class CRM_Activity_Selector_Search 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 enum $output + * What should the result set include (web/email/csv). * * @return array the column headers that need to be displayed - * @access public */ public function &getColumnHeaders($action = NULL, $output = NULL) { if (!isset(self::$_columnHeaders)) { @@ -416,25 +416,26 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * @return mixed */ - function alphabetQuery() { + public function alphabetQuery() { return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE); } /** * @return string */ - function &getQuery() { + public function &getQuery() { return $this->_query; } /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * * @return string name of the file */ - function getExportFileName($output = 'csv') { + public function getExportFileName($output = 'csv') { return ts('CiviCRM Activity Search'); } }