Commit da6b46f4 authored by Eileen McNaughton's avatar Eileen McNaughton

bulk comment fix

parent fd31fa4c
......@@ -171,7 +171,13 @@ class CRM_ACL_API {
* check if the user has access to this group for operation $type
*
* @param int $type the type of permission needed
* @param int $contactID the contactID for whom the check is made
* @param $groupID
* @param int $contactID the contactID for whom the check is made
*
* @param string $tableName
* @param null $allGroups
* @param null $includedGroups
* @param bool $flush
*
* @return array the ids of the groups for which the user has permissions
* @access public
......
......@@ -158,6 +158,8 @@ class CRM_Activity_BAO_Query {
* Given a list of conditions in query generate the required
* where clause
*
* @param $query
*
* @return void
* @access public
*/
......@@ -177,6 +179,8 @@ class CRM_Activity_BAO_Query {
/**
* where clause for a single field
*
* @param $values
* @param $query
* @return void
* @access public
*/
......
......@@ -276,7 +276,10 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C
/**
* getter for array of the parameters required for creating pager.
*
* @param
* @param $action
* @param $params
*
* @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
......
......@@ -195,7 +195,10 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM
/**
* getter for array of the parameters required for creating pager.
*
* @param
* @param $action
* @param $params
*
* @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
......
......@@ -155,6 +155,8 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -162,6 +162,8 @@ class CRM_Admin_Page_EventTemplate extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -285,6 +285,8 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic {
*
* The result format resembles the old CRM_Core_Extensions_Extension.
*
* @param CRM_Extension_Info $obj
*
* @return array
*/
public static function createExtendedInfo(CRM_Extension_Info $obj) {
......
......@@ -142,6 +142,8 @@ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic {
/**
* Browse all jobs.
*
* @param null $action
*
* @return void
* @access public
* @static
......
......@@ -154,6 +154,8 @@ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -39,7 +39,7 @@
class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic {
public $useLivePageJS = TRUE;
/**
* The action links that we need to display for the browse screen
*
......@@ -151,6 +151,8 @@ class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -183,6 +183,8 @@ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -322,6 +322,10 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form {
* This function is used to add the rules (mainly global rules) for form.
* All local rules are added near the element
*
* @param $fields
* @param $files
* @param $errors
*
* @return void
* @access public
* @see valid_date
......
......@@ -136,7 +136,11 @@ class CRM_Campaign_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
......
......@@ -205,6 +205,9 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task {
*
* @param array $fields posted values of the form
*
* @param $files
* @param $self
*
* @return array list of errors to be posted back to the form
* @static
* @access public
......
......@@ -198,6 +198,8 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic {
/**
* Get user context.
*
* @param null $mode
*
* @return string user context.
*/
function userContext($mode = NULL) {
......
......@@ -159,8 +159,7 @@ class CRM_Campaign_PseudoConstant extends CRM_Core_PseudoConstant {
* @access public
* @static
*
* @param boolean $name pseudoconstant to be flushed
*
* @param bool|string $name pseudoconstant to be flushed
*/
public static function flush($name = 'cache') {
if (isset(self::$$name)) {
......
......@@ -198,7 +198,10 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM
/**
* getter for array of the parameters required for creating pager.
*
* @param
* @param $action
* @param $params
*
* @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
......
......@@ -138,10 +138,11 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType {
* full featured over a period of time. This is the inverse function of
* create. It also stores all the retrieved values in the default array
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $defaults (reference ) an assoc array to hold the name / value pairs
* in a hierarchical manner
* @param array $ids (reference) the array that holds all the db ids
*
* @internal param array $ids (reference) the array that holds all the db ids
*
* @return object CRM_Case_BAO_CaseType object
* @access public
......
......@@ -271,6 +271,9 @@ class CRM_Case_Form_Activity_OpenCase {
*
* @access public
*
* @param $form
* @param $params
*
* @return void
*/
static function endPostProcess(&$form, &$params) {
......
......@@ -316,6 +316,9 @@ class CRM_Case_Form_Case extends CRM_Core_Form {
*
* @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
......
......@@ -185,9 +185,11 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base {
* - View
* - Edit
*
* @param bool $isDeleted
* @param null $key
*
* @return array
* @access public
*
*/
static
function &links($isDeleted = FALSE, $key = NULL) {
......
......@@ -116,9 +116,12 @@ LEFT JOIN civicrm_phone ON ( civicrm_phone.contact_id = civicrm_contact.id )
/**
* function to get the information to map a contact
*
* @param array $ids the list of ids for which we want map info
* @param array $ids the list of ids for which we want map info
* $param int $locationTypeID
*
* @param null $locationTypeID
* @param bool $imageUrlOnly
*
* @return null|string display name of the contact if found
* @static
* @access public
......
......@@ -152,8 +152,8 @@ ON DUPLICATE KEY UPDATE
/**
* Function to check if there are any contacts in cache table
*
* @param string $type the type of operation (view|edit)
* @param int $contactID contact id
* @param int|string $type the type of operation (view|edit)
* @param int $contactID contact id
*
* @return boolean
* @access public
......
......@@ -275,8 +275,11 @@ UNION
/**
* Create Current employer relationship for a individual
*
* @param int $contactID contact id of the individual
* @param string $organization it can be name or id of organization
* @param int $contactID contact id of the individual
* @param $organizationId
* @param null $previousEmployerID
*
* @internal param string $organization it can be name or id of organization
*
* @access public
* @static
......
......@@ -115,9 +115,10 @@ WHERE parent_id IS NULL
*
*function to retrieve all basic contact types.
*
*@return array of basic contact types
*@static
* @param bool $all
*
* @return array of basic contact types
* @static
*/
static function basicTypes($all = FALSE) {
return array_keys(self::basicTypeInfo($all));
......
......@@ -272,6 +272,8 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact {
*
* @param int $contactId contact id
*
* @param bool $visibility
*
* @access public
*
* @return array $values this array has key-> group id and value group title
......
......@@ -146,6 +146,9 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form {
*
* @param array $fields posted values of the form
*
* @param $files
* @param $self
*
* @return array list of errors to be posted back to the form
* @static
* @access public
......
......@@ -182,7 +182,9 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task {
/**
* global validation rules for the form
*
* @param array $fields posted values of the form
* @param $params
*
* @internal param array $fields posted values of the form
*
* @return array list of errors to be posted back to the form
* @static
......
......@@ -178,12 +178,12 @@ class CRM_Contact_Form_Task_AddToHousehold extends CRM_Contact_Form_Task {
/**
* This function is to get the result of the search for Add to * forms
*
* @param array $params This contains elements for search criteria
* @param $form
* @param array $params This contains elements for search criteria
*
* @access public
*
* @return void
*
*/
function search(&$form, &$params) {
//max records that will be listed
......
......@@ -120,6 +120,8 @@ class CRM_Contact_Form_Task_EmailCommon {
*
* @access public
*
* @param $form
*
* @return void
*/
static function buildQuickForm(&$form) {
......
......@@ -157,6 +157,8 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task {
*
* @access protected
*
* @param $form
*
* @return array the default array reference
*/
function setDefaultValues($form) {
......
......@@ -192,6 +192,9 @@ class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview {
*
* @param array $fields posted values of the form
*
* @param $files
* @param $self
*
* @return array list of errors to be posted back to the form
* @static
* @access public
......
......@@ -202,6 +202,8 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic {
/**
* Get user context
*
* @param null $mode
*
* @return string user context
*/
function userContext($mode = NULL) {
......
......@@ -204,7 +204,10 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
/**
* getter for array of the parameters required for creating pager.
*
* @param
* @param $action
* @param $params
*
* @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
......
......@@ -201,6 +201,8 @@ SELECT r.payment_processor_id
/**
* Delete Recurring contribution.
*
* @param $recurId
*
* @return true / false.
* @access public
* @static
......
......@@ -165,8 +165,9 @@ class CRM_Contribute_Form_AdditionalInfo {
*
* @access public
*
* @return void
* @param $form
*
* @return void
*/
static function buildPaymentReminders(&$form) {
//PaymentReminders section
......@@ -184,6 +185,10 @@ class CRM_Contribute_Form_AdditionalInfo {
*
* @access public
*
* @param $params
* @param $contributionID
* @param null $premiumID
* @param null $options
* @return void
*/
static function processPremium(&$params, $contributionID, $premiumID = NULL, &$options = NULL) {
......@@ -268,6 +273,9 @@ class CRM_Contribute_Form_AdditionalInfo {
*
* @access public
*
* @param $params
* @param $formatted
* @param $form
* @return void
*/
static function postProcessCommon(&$params, &$formatted, &$form) {
......@@ -316,8 +324,10 @@ class CRM_Contribute_Form_AdditionalInfo {
*
* @form object of Contribution form.
*
* @param array $params (reference ) an assoc array of name/value pairs.
* @param $form
* @param array $params (reference ) an assoc array of name/value pairs.
* @$ccContribution boolen, is it credit card contribution.
* @param bool $ccContribution
* @access public.
*
* @return void.
......
......@@ -119,8 +119,9 @@ class CRM_Contribute_Form_Contribution_OnBehalfOf {
* Function to build form for related contacts / on behalf of organization.
*
* @param $form object invoking Object
* @param $contactType string contact type
* @param $title string fieldset title
*
* @internal param string $contactType contact type
* @internal param string $title fieldset title
*
* @static
*/
......
......@@ -244,7 +244,7 @@ SELECT id
if (empty($defaults['amount_label'])) {
$defaults['amount_label'] = ts('Contribution Amount');
}
if (!empty($defaults['value']) && is_array($defaults['value'])) {
// CRM-4038: fix value display
......@@ -273,9 +273,11 @@ SELECT id
/**
* 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 $self
*
* @internal param array $options additional user data
*
* @return true if no errors, else array of errors
* @access public
......@@ -378,11 +380,11 @@ SELECT id
}
}
}
if (!empty($fields['payment_processor']) && $financialType = CRM_Contribute_BAO_Contribution::validateFinancialType($self->_defaultValues['financial_type_id'])) {
$errors['payment_processor'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
$errors['payment_processor'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
}
if (!empty($fields['is_recur_interval'])) {
foreach(array_keys($fields['payment_processor']) as $paymentProcessorID) {
$paymentProcessorTypeId = CRM_Core_DAO::getFieldValue(
......@@ -621,7 +623,7 @@ SELECT id
$editedResults = array();
CRM_Price_BAO_PriceField::retrieve($editedFieldParams, $editedResults);
if (!$priceFieldID = CRM_Utils_Array::value('id', $editedResults)) {
$fieldParams = array(
'name' => 'other_amount',
......@@ -637,14 +639,14 @@ SELECT id
if (!$noContriAmount) {
$fieldParams['is_required'] = 1;
$fieldParams['option_label'][1] = $fieldParams['label'] = $params['amount_label'];
}
}
else {
$fieldParams['is_required'] = 0;
$fieldParams['option_label'][1] = $fieldParams['label'] = 'Other Amount';
}
$priceField = CRM_Price_BAO_PriceField::create($fieldParams);
}
}
else {
if (empty($editedResults['is_active'])) {
if (!$noContriAmount) {
......@@ -660,10 +662,10 @@ SELECT id
$priceField = CRM_Price_BAO_PriceField::add($fieldParams);
}
}
}
}
elseif (empty($params['is_allow_other_amount']) && !empty($params['price_field_other'])) {
CRM_Price_BAO_PriceField::setIsActive($params['price_field_other'], '0');
}
}
elseif ($priceFieldID = CRM_Utils_Array::value('price_field_other', $params)) {
$priceFieldValueID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldID, 'id', 'price_field_id');
if (!$noContriAmount) {
......@@ -674,7 +676,7 @@ SELECT id
);
CRM_Price_BAO_PriceField::add($fieldParams);
CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldValueID, 'label', $params['amount_label']);
}
}
else {
CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceField', $priceFieldID, 'is_required', 0 );
CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldValueID, 'label', 'Other Amount');
......
......@@ -162,7 +162,10 @@ class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_Co
/**
* global form rule
*
* @param array $fields the input form values
* @param array $fields the input form values
*
* @param $files
* @param $contributionPageId
*
* @return true if no errors, else array of errors
* @access public
......
......@@ -199,6 +199,9 @@ class CRM_Contribute_Form_ContributionPage_Widget extends CRM_Contribute_Form_Co
*
* @param array $params (ref.) an assoc array of name/value pairs
*
* @param $files
* @param $self
*
* @return mixed true or array of errors
* @access public
* @static
......
......@@ -192,7 +192,10 @@ class CRM_Contribute_Form_SoftCredit {
/**
* global form rule
*
* @param array $fields the input form values
* @param array $fields the input form values
*
* @param $errors
* @param $self
*
* @return true if no errors, else array of errors
* @access public
......
......@@ -197,7 +197,11 @@ class CRM_Contribute_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
......
......@@ -205,9 +205,11 @@ class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form {
/**
* 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 $self
*
* @internal param array $options additional user data