<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
* the HTML_QuickForm_Controller for that page.
*
* @var array
- * @access protected
*/
public $_formValues;
* Params is the array in a value used by the search query creator
*
* @var array
- * @access protected
*/
public $_params;
* Represent the type of selector
*
* @var int
- * @access protected
*/
protected $_action;
* The public visible fields to be shown to the user
*
* @var array
- * @access protected
*/
protected $_fields;
* Class constructor
*
* @param $customSearchClass
- * @param array $formValues array of form values imported
- * @param array $params array of parameters for query
+ * @param array $formValues
+ * Array of form values imported.
+ * @param array $params
+ * Array of parameters for query.
* @param null $returnProperties
* @param \const|int $action - action of search basic or advanced.
*
*/
function __construct(
$customSearchClass,
- $formValues = NULL,
- $params = NULL,
- $returnProperties = NULL,
- $action = CRM_Core_Action::NONE,
+ $formValues = NULL,
+ $params = NULL,
+ $returnProperties = NULL,
+ $action = CRM_Core_Action::NONE,
$includeContactIds = FALSE,
$searchChildGroups = TRUE,
- $searchContext = 'search',
- $contextMenu = NULL
+ $searchContext = 'search',
+ $contextMenu = NULL
) {
$this->_customSearchClass = $customSearchClass;
$this->_formValues = $formValues;
if (!$ext->isExtensionKey($customSearchClass)) {
if ($ext->isExtensionClass($customSearchClass)) {
$customSearchFile = $ext->classToPath($customSearchClass);
- require_once ($customSearchFile);
+ require_once $customSearchFile;
}
else {
- require_once (str_replace('_', DIRECTORY_SEPARATOR, $customSearchClass) . '.php');
+ require_once str_replace('_', DIRECTORY_SEPARATOR, $customSearchClass) . '.php';
}
$this->_search = new $customSearchClass( $formValues );
}
* - Edit
*
* @return array
- * @access public
*
*/
- static function &links() {
+ public static function &links() {
list($key) = func_get_args();
$searchContext = "&context=custom";
$extraParams = ($key) ? "&key={$key}" : NULL;
* @param $action
* @param array $params
*
- * @access public
*/
- function getPagerParams($action, &$params) {
+ public function getPagerParams($action, &$params) {
$params['status'] = ts('Contact %%StatusMessage%%');
$params['csvString'] = NULL;
$params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
* 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
*/
- function &getColumnHeaders($action = NULL, $output = NULL) {
+ public function &getColumnHeaders($action = NULL, $output = NULL) {
$columns = $this->_search->columns();
if ($output == CRM_Core_Selector_Controller::EXPORT) {
return array_keys($columns);
* @param
*
* @return int Total number of rows
- * @access public
*/
- function getTotalCount($action) {
+ public function getTotalCount($action) {
return $this->_search->count();
}
/**
* 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 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) {
$includeContactIDs = FALSE;
if (($output == CRM_Core_Selector_Controller::EXPORT ||
}
if ($image) {
- $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($dao->contact_sub_type ?
- $dao->contact_sub_type : $dao->contact_type, FALSE, $contactID
+ $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($dao->contact_sub_type ? $dao->contact_sub_type : $dao->contact_type, FALSE, $contactID
);
}
$rows[] = $row;
* Given the current formValues, gets the query in local
* language
*
- * @param array(
- reference) $formValues submitted formValues
+ * @param array(
+ reference) $formValues submitted formValues
*
* @return array $qill which contains an array of strings
- * @access public
*/
public function getQILL() {
return NULL;
/**
* 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 Custom Search');
}
/**
* @return null
*/
- function alphabetQuery() {
+ public function alphabetQuery() {
return NULL;
}
*
* @return Object
*/
- function &contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
+ public function &contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
$params = array();
$sql = $this->_search->contactIDs($params);
/**
* @param $rows
*/
- function addActions(&$rows) {
+ public function addActions(&$rows) {
$links = self::links($this->_key);
$permissions = array(CRM_Core_Permission::getPermission());
/**
* @param $rows
*/
- function removeActions(&$rows) {
+ public function removeActions(&$rows) {
foreach ($rows as $rid => & $rValue) {
unset($rValue['action']);
}
}
}
-
projects / civicrm-core.git / blobdiff