Commit dd244018 authored by Eileen McNaughton's avatar Eileen McNaughton

bulk comment fixes

parent 77b97be7
......@@ -1643,7 +1643,9 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
* scheme. Adding weight is super important and should be done in the
* next week or so, before this can be called complete.
*
* @param NULL
* @param bool $status
*
* @internal param $NULL
*
* @return array array of importable Fields
* @access public
......
......@@ -69,8 +69,12 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C
* @param int $contactId - contact whose activities we want to display
* @param int $permission - the permission we have for this contact
*
* @return CRM_Contact_Selector_Activity
* @access public
* @param bool $admin
* @param string $context
* @param null $activityTypeIDs
*
* @return \CRM_Activity_Selector_Activity
@access public
*/
function __construct($contactId,
$permission,
......
......@@ -147,14 +147,17 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM
/**
* Class constructor
*
* @param array $queryParams array of parameters for query
* @param int $action - action of search basic or advanced.
* @param string $activityClause if the caller wants to further restrict the search (used in activities)
* @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 int $limit how many activities do we want returned
*
* @return CRM_Contact_Selector
* @access public
* @param string $context
* @param null $compContext
*
* @return \CRM_Activity_Selector_Search
@access public
*/
function __construct(&$queryParams,
$action = CRM_Core_Action::NONE,
......@@ -253,7 +256,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM
$assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
$targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
//get all activity types
$activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'name', TRUE);
$activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'name', TRUE);
while ($result->fetch()) {
$row = array();
......
......@@ -148,6 +148,8 @@ class CRM_Admin_Form_PaymentProcessorType extends CRM_Admin_Form {
/**
* Function to build the form
*
* @param bool $check
*
* @return void
* @access public
*/
......
......@@ -114,6 +114,8 @@ class CRM_Admin_Page_CaseType extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -90,6 +90,8 @@ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic {
/**
* Browse all jobs.
*
* @param null $action
*
* @return void
* @access public
* @static
......
......@@ -121,6 +121,8 @@ class CRM_Admin_Page_LabelFormats extends CRM_Core_Page_Basic {
/**
* Browse all Label Format settings.
*
* @param null $action
*
* @return void
* @access public
* @static
......
......@@ -112,6 +112,8 @@ class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -83,6 +83,8 @@ class CRM_Admin_Page_Navigation extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -281,6 +281,8 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -111,6 +111,8 @@ class CRM_Admin_Page_PaymentProcessorType extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -106,6 +106,8 @@ class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......@@ -115,6 +117,8 @@ class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic {
/**
* Browse all PDF Page Formats
*
* @param null $action
*
* @return void
* @access public
* @static
......
......@@ -112,6 +112,8 @@ class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -338,7 +338,8 @@ class CRM_Badge_BAO_Badge {
/**
* function to build badges parameters before actually creating badges.
*
* @param array $params associated array of submitted values
* @param array $params associated array of submitted values
* @param $form
* @params object $form form/controller object
*
* @return void
......
......@@ -67,6 +67,8 @@ class CRM_Campaign_BAO_Query {
/**
* if survey, campaign are involved, add the specific fields.
*
* @param $query
*
* @return void
* @access public
*/
......
......@@ -1033,6 +1033,8 @@ INNER JOIN civicrm_survey survey ON ( activity.source_record_id = survey.id )
/**
* Check and update the survey respondents.
*
* @param $params
*
* @return array success message
*/
public function releaseRespondent($params) {
......
......@@ -72,6 +72,8 @@ class CRM_Campaign_PseudoConstant extends CRM_Core_PseudoConstant {
*
* @access public
*
* @param string $returnColumn
*
* @return array - array reference of all survey activity types.
* @static
*/
......
......@@ -139,15 +139,18 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM
/**
* Class constructor
*
* @param array $queryParams array of parameters for query
* @param int $action - action of search basic or advanced.
* @param string $surveyClause if the caller wants to further restrict the search.
* @param boolean $single are we dealing only with one contact?
* @param int $limit how many voters do we want returned
* @param array $queryParams array of parameters for query
* @param \const|int $action - action of search basic or advanced.
* @param string $surveyClause if the caller wants to further restrict the search.
* @param boolean $single are we dealing only with one contact?
* @param int $limit how many voters do we want returned
*
* @return CRM_Contact_Selector
* @access public
*/ function __construct(&$queryParams,
* @param string $context
*
* @return \CRM_Campaign_Selector_Search
@access public
*/
function __construct(&$queryParams,
$action = CRM_Core_Action::NONE,
$surveyClause = NULL,
$single = FALSE,
......
......@@ -93,6 +93,9 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate {
*
* @param array $values posted values of the form
*
* @param $files
* @param $form
*
* @return array list of errors to be posted back to the form
* @static
* @access public
......
......@@ -125,6 +125,10 @@ class CRM_Case_Form_Activity_ChangeCaseStatus {
*
* @access public
*
* @param $form
* @param $params
* @param $activity
*
* @return void
*/
static function endPostProcess(&$form, &$params, $activity) {
......
......@@ -111,6 +111,9 @@ class CRM_Case_Form_Activity_LinkCases {
*
* @access public
*
* @param $form
* @param $params
*
* @return void
*/
static function beginPostProcess(&$form, &$params) {}
......
......@@ -89,6 +89,8 @@ class CRM_Case_Form_Activity_OpenCase {
*
* @access public
*
* @param $form
*
* @return void
*/
static function setDefaultValues(&$form) {
......
......@@ -150,7 +150,11 @@ class CRM_Case_Form_Task extends CRM_Core_Form {
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
* @param string $type button type for the form after processing
* @param string $nextType
* @param string $backType
* @param bool $submitOnce
*
* @internal param string $type button type for the form after processing
*
* @return void
* @access public
......
......@@ -135,15 +135,18 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base {
/**
* Class constructor
*
* @param array $queryParams array of parameters for query
* @param int $action - action of search basic or advanced.
* @param string $additionalClause 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 $additionalClause 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 signers do we want returned
* @param int $limit how many signers do we want returned
*
* @return CRM_Contact_Selector
* @access public
*/ function __construct(&$queryParams,
* @param string $context
*
* @return \CRM_Case_Selector_Search
@access public
*/
function __construct(&$queryParams,
$action = CRM_Core_Action::NONE,
$additionalClause = NULL,
$single = FALSE,
......
......@@ -1035,12 +1035,13 @@ WHERE id={$id}; ";
*
* @param int $id - id of the contact whose contact sub type is needed
*
* @param null $implodeDelimiter
*
* @return string contact_sub_type if $id found else null ""
*
* @access public
*
* @static
*
*/
public static function getContactSubType($id, $implodeDelimiter = NULL) {
$subtype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_sub_type');
......@@ -1096,12 +1097,14 @@ WHERE id={$id}; ";
* The ordering is important, since currently we do not have a weight
* scheme. Adding weight is super important
*
* @param int $contactType contact Type
* @param boolean $status status is used to manipulate first title
* @param boolean $showAll if true returns all fields (includes disabled fields)
* @param boolean $isProfile if its profile mode
* @param int|string $contactType contact Type
* @param boolean $status status is used to manipulate first title
* @param boolean $showAll if true returns all fields (includes disabled fields)
* @param boolean $isProfile if its profile mode
* @param boolean $checkPermission if false, do not include permissioning clause (for custom data)
*
* @param bool $withMultiCustomFields
*
* @return array array of importable Fields
* @access public
* @static
......
......@@ -83,10 +83,11 @@ WHERE contact_a.id = %1 AND $permission";
/**
* fill the acl contact cache for this contact id if empty
*
* @param int $id contact id
* @param string $type the type of operation (view|edit)
* @param boolean $force should we force a recompute
* @param $userID
* @param int|string $type the type of operation (view|edit)
* @param boolean $force should we force a recompute
*
* @internal param int $id contact id
* @return void
* @access public
* @static
......
......@@ -68,9 +68,10 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType {
*
*function to retrieve basic contact type information.
*
*@return array of basic contact types information.
*@static
* @param bool $all
*
* @return array of basic contact types information.
* @static
*/
static function &basicTypeInfo($all = FALSE) {
static $_cache = NULL;
......
......@@ -280,9 +280,9 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen
* identified by $groupId; does not delete child group, just the
* association between the two
*
* @param $parentID The id of the group to remove the child from
* @param $childID The id of the child group being removed
*
* @internal param \The $parentID id of the group to remove the child from
* @return void
*
* @access public
......
......@@ -1174,10 +1174,11 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id)
* @param $contactId Int contact id
* @param $params array array of values submitted by POST
* @param $ids array array of ids
* @param $action which action called this function
* @param \const|\which $action which action called this function
*
* @static
* @param bool $active
*
* @static
*/
static function relatedMemberships($contactId, &$params, $ids, $action = CRM_Core_Action::ADD, $active = TRUE) {
// Check the end date and set the status of the relationship
......
......@@ -294,8 +294,12 @@ class CRM_Contact_Form_Edit_Address {
/**
* check for correct state / country mapping.
*
* @param array reference $fields - submitted form values.
* @param array reference $errors - if any errors found add to this array. please.
* @param $fields
* @param $files
* @param $self
*
* @internal param \reference $array $fields - submitted form values.
* @internal param \reference $array $errors - if any errors found add to this array. please.
*
* @return true if no errors
* array of errors if any present.
......
......@@ -66,9 +66,11 @@ class CRM_Contact_Form_Inline_Lock {
/**
* Ensure that oplock_ts hasn't changed in the underlying DB
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
* @param array $options additional user data
* @param array $fields the input form values
* @param array $files the uploaded files if any
* @param null $contactID
*
* @internal param array $options additional user data
*
* @return true if no errors, else array of errors
* @access public
......
......@@ -122,9 +122,11 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task {
/**
* global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
* @param array $options additional user data
* @param array $fields the input form values
* @param array $files the uploaded files if any
* @param $form
*
* @internal param array $options additional user data
*
* @return true if no errors, else array of errors
* @access public
......
......@@ -84,6 +84,8 @@ class CRM_Contact_Form_Task_SMSCommon {
*
* @access public
*
* @param $form
*
* @return void
*/
static function buildQuickForm(&$form) {
......
......@@ -971,6 +971,8 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField {
* format custom field name.
* combine group and field name to avoid conflict.
*
* @param $fields
*
* @return void
* @access public
*/
......
......@@ -220,10 +220,12 @@ SELECT r.payment_processor_id
/**
* Cancel Recurring contribution.
*
* @param integer $recurId recur contribution id.
* @param array $objects an array of objects that is to be cancelled like
* @param integer $recurId recur contribution id.
* @param array $objects an array of objects that is to be cancelled like
* contribution, membership, event. At least contribution object is a must.
*
* @param array $activityParams
*
* @return true / false.
* @access public
* @static
......
......@@ -138,11 +138,13 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
/**
* Function to retrieve soft contributions for contribution record.
* @param array $params an associated array
* @param boolean $all include PCP data
*
* @return array of soft contribution ids, amounts, and associated contact ids
* @static
* @param $contributionID
* @param boolean $all include PCP data
*
* @internal param array $params an associated array
* @return array of soft contribution ids, amounts, and associated contact ids
* @static
*/
static function getSoftContribution($contributionID, $all = FALSE) {
$pcpFields = array(
......@@ -222,10 +224,13 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio
/**
* Function to retrieve the list of soft contributions for given contact.
* @param int $contact_id contact id
*
* @return array
* @static
* @param int $contact_id contact id
*
* @param int $isTest
*
* @return array
* @static
*/
static function getSoftContributionList($contact_id, $isTest = 0) {
$query = '
......
......@@ -66,6 +66,8 @@ class CRM_Contribute_BAO_Query {
/**
* if contributions are involved, add the specific contribute fields
*
* @param $query
*
* @return void
* @access public
*/
......
......@@ -39,6 +39,8 @@ class CRM_Contribute_Form_AdditionalInfo {
*
* @access public
*
* @param $form
*
* @return void
*/
static function buildPremium(&$form) {
......
......@@ -37,6 +37,8 @@ class CRM_Contribute_Form_Contribution_OnBehalfOf {
/**
* Function to set variables up before form is built
*
* @param $form
*
* @return void
* @access public
*/
......
......@@ -233,6 +233,9 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_
*
* @param array $values posted values of the form
*
* @param $files
* @param $self
*
* @return array list of errors to be posted back to the form
* @static
* @access public
......@@ -257,7 +260,7 @@ class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_
if (! CRM_Core_BAO_UFField::checkValidProfileType($id, $required, $optional)
&& ! CRM_Core_BAO_UFGroup::checkValidProfile($id, $requiredProfileFields) ) {
$errors['onbehalf_profile_id'] = ts('Profile does not contain the minimum required fields for an On Behalf Of Organization');
}
}
}
}
......
......@@ -231,6 +231,8 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form {
*
* @param array $params (ref.) an assoc array of name/value pairs
*
* @param $files
*
* @return mixed true or array of errors
* @access public
* @static
......
......@@ -41,6 +41,8 @@ class CRM_Contribute_Form_SoftCredit {
/**
* Function to set variables up before form is built
*
* @param $form
*
* @return void
* @access static
*/
......
......@@ -218,6 +218,8 @@ class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -148,6 +148,12 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
* Get all the financial Accounts
*
* @access public
*
* @param null $id
* @param null $financialAccountTypeId
* @param string $retrieveColumn
* @param string $key
*
* @return array - array reference of all financial accounts if any
* @static
*/
......
......@@ -151,6 +151,8 @@ class CRM_Contribute_Task {
*
* @param int $permission
*
* @param bool $softCreditFiltering
*
* @return array set of tasks that are valid for the user
* @access public
*/
......
......@@ -64,6 +64,8 @@ class CRM_Core_BAO_ConfigSetting {
*
* @params array $params associated array of civicrm variables
*
* @param $params
*
* @return null
* @static
*/
......@@ -145,6 +147,8 @@ class CRM_Core_BAO_ConfigSetting {
*
* @params array $params associated array of civicrm variables
*
* @param $params
*
* @return null
* @static
*/
......
......@@ -296,14 +296,18 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup {
*
* @param string $entityType - of the contact whose contact type is needed
* @param object $form - not used but required
* @param int $entityId - optional - id of entity if we need to populate the tree with custom values.
* @param int $groupId - optional group id (if we need it for a single group only)
* - if groupId is 0 it gets for inline groups only
* - if groupId is -1 we get for all groups
* @param null $entityID
* @param null $groupID
* @param string $subType
* @param string $subName
* @param boolean $fromCache
*
* @param null $onlySubType
*
* @internal param int $entityId - optional - id of entity if we need to populate the tree with custom values.
* @internal param int $groupId - optional group id (if we need it for a single group only)
* - if groupId is 0 it gets for inline groups only
* - if groupId is -1 we get for all groups