<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.4 |
+ | CiviCRM version 4.5 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id$
*
*/
/**
* Class constructor
*
- * @param array $queryParams array of parameters for query
- * @param int $action - action of search basic or advanced.
- * @param string $eventClause if the caller wants to further restrict the search (used in participations)
+ * @param array $queryParams array of parameters for query
+ * @param \const|int $action - action of search basic or advanced.
+ * @param string $eventClause if the caller wants to further restrict the search (used in participations)
* @param boolean $single are we dealing only with one contact?
- * @param int $limit how many participations do we want returned
+ * @param int $limit how many participations do we want returned
*
- * @return CRM_Contact_Selector
- * @access public
+ * @param string $context
+ * @param null $compContext
+ *
+ * @return \CRM_Event_Selector_Search
+ @access public
*/
function __construct(&$queryParams,
$action = CRM_Core_Action::NONE,
* - View
* - Edit
*
+ * @param null $qfKey
+ * @param null $context
+ * @param null $compContext
+ *
* @return array
* @access public
- *
*/
static function &links($qfKey = NULL, $context = NULL, $compContext = NULL) {
$extraParams = NULL;
/**
* getter for array of the parameters required for creating pager.
*
- * @param
+ * @param $action
+ * @param $params
+ *
+ * @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
return self::$_columnHeaders;
}
+ /**
+ * @return mixed
+ */
function alphabetQuery() {
return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
}
+ /**
+ * @return string
+ */
function &getQuery() {
return $this->_query;
}