From 2a6da8d763922cb3eb4371c9e44616abb7fe649a Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Fri, 9 May 2014 14:06:05 +1200 Subject: [PATCH] bulk comment fixes --- CRM/Activity/Form/Activity.php | 9 ++- CRM/Activity/Selector/Activity.php | 12 +-- CRM/Campaign/BAO/Petition.php | 7 +- CRM/Campaign/BAO/Survey.php | 42 +++++----- CRM/Campaign/Form/Petition/Signature.php | 4 + CRM/Case/BAO/Query.php | 2 + CRM/Case/Form/Search.php | 3 +- CRM/Contact/BAO/Contact.php | 4 +- CRM/Contact/BAO/Contact/Utils.php | 34 +++++--- CRM/Contact/BAO/GroupContact.php | 14 +++- CRM/Contact/BAO/GroupNesting.php | 27 +++---- CRM/Contact/BAO/Query.php | 18 +++-- CRM/Contact/BAO/Relationship.php | 19 ++--- CRM/Contact/Form/Search/Criteria.php | 2 + CRM/Contact/Form/Task/SMSCommon.php | 2 + CRM/Contact/Import/Parser.php | 5 +- CRM/Contact/Import/Parser/Contact.php | 2 + CRM/Contribute/BAO/Contribution.php | 7 +- CRM/Contribute/BAO/ContributionPage.php | 20 +++-- CRM/Contribute/Form/Contribution.php | 8 +- CRM/Contribute/Form/Contribution/Main.php | 8 +- CRM/Contribute/Form/ManagePremiums.php | 5 ++ CRM/Contribute/Import/Form/MapField.php | 3 + CRM/Contribute/Import/Parser.php | 5 +- CRM/Contribute/Page/ContributionPage.php | 2 + CRM/Contribute/PseudoConstant.php | 7 ++ CRM/Core/BAO/Address.php | 7 +- CRM/Core/BAO/Block.php | 5 +- CRM/Core/BAO/CustomField.php | 27 ++++--- CRM/Core/BAO/CustomGroup.php | 2 + CRM/Core/BAO/CustomValueTable.php | 6 ++ CRM/Core/BAO/Dashboard.php | 2 + CRM/Core/BAO/LabelFormat.php | 6 +- CRM/Core/BAO/Note.php | 7 +- CRM/Core/BAO/OptionValue.php | 5 +- CRM/Core/BAO/Setting.php | 8 ++ CRM/Core/BAO/Tag.php | 3 +- CRM/Core/BAO/UFGroup.php | 45 ++++++----- CRM/Core/BAO/UFMatch.php | 6 +- CRM/Core/Controller.php | 8 +- CRM/Core/DAO.php | 15 +++- CRM/Core/Error.php | 22 ++++-- CRM/Core/Form.php | 9 ++- CRM/Core/OptionGroup.php | 9 ++- CRM/Core/OptionValue.php | 2 + CRM/Core/Payment/AuthorizeNet.php | 3 + CRM/Core/Payment/Form.php | 4 + CRM/Core/Payment/GoogleIPN.php | 13 +++- CRM/Core/PseudoConstant.php | 14 ++-- CRM/Core/Resources.php | 5 +- CRM/Core/Selector/Controller.php | 2 + CRM/Event/BAO/Event.php | 9 ++- CRM/Event/Form/EventFees.php | 2 + CRM/Event/Form/ManageEvent/Registration.php | 18 ++++- CRM/Event/Form/Participant.php | 6 +- CRM/Event/Form/Registration.php | 4 + .../Registration/AdditionalParticipant.php | 2 + CRM/Event/Form/Registration/Register.php | 14 ++-- CRM/Event/Import/Parser.php | 3 +- CRM/Extension/Manager.php | 5 +- CRM/Grant/BAO/Grant.php | 4 +- CRM/Mailing/BAO/MailingJob.php | 4 +- CRM/Mailing/Event/BAO/Unsubscribe.php | 21 ++--- CRM/Mailing/Form/Upload.php | 3 + CRM/Member/Form/Membership.php | 4 + CRM/Member/Import/Parser/Membership.php | 8 +- CRM/Member/Page/Tab.php | 8 +- CRM/PCP/BAO/PCP.php | 27 ++++--- CRM/Pledge/BAO/Pledge.php | 4 +- CRM/Pledge/BAO/PledgePayment.php | 2 + CRM/Pledge/Form/Pledge.php | 8 +- CRM/Pledge/Form/Search.php | 3 +- CRM/Price/BAO/PriceField.php | 7 +- CRM/Price/BAO/PriceSet.php | 6 +- CRM/Report/Form.php | 10 ++- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php | 6 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php | 15 ++-- CRM/Utils/Migrate/Export.php | 7 +- Civi/API/Provider/MagicFunctionProvider.php | 4 +- Civi/Core/Container.php | 2 + distmaker/utils/joomlaxml.php | 3 +- .../main.php | 2 + .../CRM/Core/BAO/ActionScheduleTest.php | 4 +- .../CRM/Core/CommunityMessagesTest.php | 2 + tests/phpunit/CRM/Core/ResourcesTest.php | 3 +- .../CRM/Extension/Manager/ModuleTest.php | 1 + .../CRM/Utils/Migrate/ImportExportTest.php | 13 +++- tests/phpunit/Civi/API/KernelTest.php | 5 +- .../phpunit/CiviTest/CiviSeleniumTestCase.php | 51 +++++++++--- tests/phpunit/CiviTest/CiviTestSuite.php | 8 +- tests/phpunit/CiviTest/CiviUnitTestCase.php | 78 ++++++++++++++----- tests/phpunit/CiviTest/Contact.php | 13 +++- tests/phpunit/CiviTest/ContributionPage.php | 4 +- tests/phpunit/CiviTest/Custom.php | 9 ++- tests/phpunit/CiviTest/Event.php | 8 +- tests/phpunit/CiviTest/Participant.php | 8 +- tests/phpunit/CiviTest/PaypalPro.php | 3 +- .../WebTest/Contact/InlineFieldsEditTest.php | 3 +- .../Export/ExportCiviSeleniumTestCase.php | 4 + .../WebTest/Release/ReleaseTestCase.php | 7 +- tools/CRM/Auction/BAO/Auction.php | 3 + tools/CRM/Auction/BAO/Item.php | 5 +- tools/CRM/Auction/Form/Auction.php | 8 +- tools/CRM/Auction/Form/Item.php | 8 +- tools/CRM/Auction/Form/ItemAccount.php | 8 +- tools/CRM/Auction/StateMachine/Item.php | 7 +- tools/CRM/Touchstone/PseudoConstant.php | 2 + .../ccrm_extensionvalidation.version.inc | 9 ++- tools/drupal/modules/extdir/extdir.pages.inc | 3 + .../org.civicrm.multisite/multisite.php | 2 + .../GoogleCheckout.php | 14 ++-- .../GoogleIPN.php | 17 ++-- .../org_civicrm_sms_clickatell.php | 15 +++- tools/sites/latest/stable.php | 11 ++- 114 files changed, 746 insertions(+), 317 deletions(-) diff --git a/CRM/Activity/Form/Activity.php b/CRM/Activity/Form/Activity.php index 2dc5d2ffdf..c46a3e631d 100644 --- a/CRM/Activity/Form/Activity.php +++ b/CRM/Activity/Form/Activity.php @@ -801,9 +801,11 @@ class CRM_Activity_Form_Activity 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 $self + * + * @internal param array $options additional user data * * @return true if no errors, else array of errors * @access public @@ -850,6 +852,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { * * @access public * + * @param null $params * @return void */ public function postProcess($params = NULL) { diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index c110548ea0..2b5c370ca4 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -343,11 +343,13 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C /** * 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) + * + * @param null $case * * @return int the total number of rows for this action */ diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index 481e31c84c..7f2f5dc8de 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -529,8 +529,11 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; * * @param array $params (reference ) an assoc array of name/value pairs * - * @return - * @access public + * @param $sendEmailMode + * + * @throws Exception + * @return void + @access public * @static */ public static function sendEmail($params, $sendEmailMode) { diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index 448ac7ad2a..ae90b07488 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -407,11 +407,11 @@ SELECT survey.id as id, /** * This function retrieve contact information. * - * @param array $voter an array of contact Ids. - * @param array $returnProperties an array of return elements. + * @param $voterIds + * @param array $returnProperties an array of return elements. * - * @return $voterDetails array of contact info. - * @static + * @internal param array $voter an array of contact Ids. + * @return array $voterDetails array of contact info.@static */ static function voterDetails($voterIds, $returnProperties = array( )) { @@ -498,11 +498,13 @@ Group By contact.id"; /** * This function retrieve survey related activities w/ for give voter ids. * - * @param int $surveyId survey id. - * @param array $voterIds voterIds. + * @param int $surveyId survey id. + * @param array $voterIds voterIds. * - * @return $activityDetails array of survey activity. - * @static + * @param null $interviewerId + * @param array $statusIds + * + * @return array $activityDetails array of survey activity.@static */ static function voterActivityDetails($surveyId, $voterIds, $interviewerId = NULL, $statusIds = array()) { @@ -557,10 +559,13 @@ INNER JOIN civicrm_activity_contact activityAssignment /** * This function retrieve survey related activities. * - * @param int $surveyId survey id. + * @param int $surveyId survey id. * - * @return $activities an array of survey activity. - * @static + * @param null $interviewerId + * @param null $statusIds + * @param null $voterIds + * @param bool $onlyCount + * @return array $activities an array of survey activity.@static */ static function getSurveyActivities($surveyId, $interviewerId = NULL, @@ -692,8 +697,8 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a /** * This function retrieve all option groups which are created as a result set * - * @return $resultSets an array of option groups. - * @static + * @param string $valueColumnName + * @return array $resultSets an array of option groups.@static */ static function getResultSets( $valueColumnName = 'title' ) { $resultSets = array(); @@ -712,7 +717,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * This function is to check survey activity. * * @param int $activityId activity id. - * @param int $activityTypeId activity type id. + * @internal param int $activityTypeId activity type id. * @return boolean $isSurveyActivity true/false boolean. * @static */ @@ -741,8 +746,7 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * This function retrive all response options of survey * * @param int $surveyId survey id. - * @return $responseOptions an array of option values - * @static + * @return array $responseOptions an array of option values@static */ static function getResponsesOptions($surveyId) { $responseOptions = array(); @@ -761,8 +765,10 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a /** * This function return all voter links with respecting permissions * - * @return $url array of permissioned links - * @static + * @param $surveyId + * @param bool $enclosedInUL + * @param string $extraULName + * @return array|string $url array of permissioned links@static */ static function buildPermissionLinks($surveyId, $enclosedInUL = FALSE, $extraULName = 'more') { $menuLinks = array(); diff --git a/CRM/Campaign/Form/Petition/Signature.php b/CRM/Campaign/Form/Petition/Signature.php index c706baeab4..4131c44085 100644 --- a/CRM/Campaign/Form/Petition/Signature.php +++ b/CRM/Campaign/Form/Petition/Signature.php @@ -588,6 +588,10 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { /** * Function to build the petition profile form * + * @param $id + * @param $name + * @param bool $viewOnly + * * @return void * @access public */ diff --git a/CRM/Case/BAO/Query.php b/CRM/Case/BAO/Query.php index c92963b4ab..12dc66a566 100644 --- a/CRM/Case/BAO/Query.php +++ b/CRM/Case/BAO/Query.php @@ -670,6 +670,8 @@ case_relation_type.id = case_relationship.relationship_type_id )"; * * @access public * + * @param $form + * * @return void * @static */ diff --git a/CRM/Case/Form/Search.php b/CRM/Case/Form/Search.php index 26f1298b06..7fa31fb8df 100644 --- a/CRM/Case/Form/Search.php +++ b/CRM/Case/Form/Search.php @@ -410,7 +410,8 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { * global validation rules for the form * * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form + * + * @internal param array $errors list of errors to be posted back to the form * * @return void * @static diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index b3762e6b55..4c8ffd72b1 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -854,7 +854,9 @@ WHERE id={$id}; "; * function to return relative path * @todo make this a method of $config->userSystem (i.e. UF classes) rather than a static function * - * @param String $absPath absolute path + * @param $absolutePath + * + * @internal param String $absPath absolute path * * @return String $relativePath Relative url of uploaded image */ diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index 875b1e20e7..0961a02580 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -327,11 +327,14 @@ UNION /** * create related memberships for current employer * - * @param int $contactID contact id of the individual - * @param int $employerID contact id of the organization. - * @param array $relationshipParams relationship params. - * @param boolean $duplicate are we triggered existing relationship. + * @param int $contactID contact id of the individual + * @param int $employerID contact id of the organization. + * @param array $relationshipParams relationship params. + * @param boolean $duplicate are we triggered existing relationship. + * + * @param null $previousEmpID * + * @throws CiviCRM_API3_Exception * @access public * @static */ @@ -444,11 +447,13 @@ WHERE id={$contactId}; "; * * @param $form object invoking Object * @param $contactType string contact type + * @param $countryID + * @param $stateID * @param $title string fieldset title - * @param $maxLocationBlocks int number of location blocks * - * @static + * @internal param int $maxLocationBlocks number of location blocks * + * @static */ static function buildOnBehalfForm(&$form, $contactType, $countryID, $stateID, $title) { @@ -543,6 +548,8 @@ UPDATE civicrm_contact * Given an array of contact ids this function will return array with links to view contact page * * @param array $contactIDs associated contact id's + * @param bool $addViewLink + * @param bool $addEditLink * @param int $originalId associated with the contact which is edited * * @@ -647,11 +654,11 @@ LEFT JOIN civicrm_email ce ON ( ce.contact_id=c.id AND ce.is_primary = 1 ) /** * This function retrieve component related contact information. * - * @param array $componentIds array of component Ids. - * @param array $returnProperties array of return elements. + * @param array $componentIds array of component Ids. + * @param $componentName + * @param array $returnProperties array of return elements. * - * @return $contactDetails array of contact info. - * @static + * @return array $contactDetails array of contact info.@static */ static function contactDetails($componentIds, $componentName, $returnProperties = array( )) { @@ -828,8 +835,7 @@ Group By componentId"; * * @param array $addresses associated array of * - * @return $contactNames associated array of contact names - * @static + * @return array $contactNames associated array of contact names@static */ static function getAddressShareContactNames(&$addresses) { $contactNames = array(); @@ -1060,6 +1066,10 @@ WHERE id IN (" . implode(',', $contactIds) . ")"; * * @param string $templateString the greeting template string with contact tokens + Smarty syntax * + * @param $contactDetails + * @param $contactID + * @param $className + * * @return void * @static */ diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index 468892b97c..5b579a14ab 100644 --- a/CRM/Contact/BAO/GroupContact.php +++ b/CRM/Contact/BAO/GroupContact.php @@ -501,7 +501,10 @@ SELECT * * * * @param array $params (reference ) an assoc array of name/value pairs - * @param array $contactId contact id + * @param array $contactId contact id + * + * @param bool $visibility + * @param string $method * * @return void * @access public @@ -685,8 +688,13 @@ AND group_id IN ( $groupIDString ) /** * Given an array of contact ids, add all the contacts to the group * - * @param array $contactIds (reference ) the array of contact ids to be added - * @param int $groupId the id of the group + * @param $contactIDs + * @param $groupID + * @param string $method + * @param string $status + * @param null $tracking + * @internal param array $contactIds (reference ) the array of contact ids to be added + * @internal param int $groupId the id of the group * * @return array (total, added, notAdded) count of contacts added to group * @access public diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index 47c7e8f0e5..b8e4cb18f0 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -507,9 +507,9 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param $groupIds An array of valid group ids (passed by reference) * - * @return $groupIdArray List of groupIds that represent the requested group and its ancestors + * @param bool $includeSelf * - * @access public + * @return array $groupIdArray List of groupIds that represent the requested group and its ancestors@access public */ static function getAncestorGroupIds($groupIds, $includeSelf = TRUE) { if (!is_array($groupIds)) { @@ -543,9 +543,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param $groupIds An array of valid group ids (passed by reference) * - * @return $groupArray List of ancestor groups - * - * @access public + * @param bool $includeSelf + * @return \An $groupArray List of ancestor groups@access public */ static function getAncestorGroups($groupIds, $includeSelf = TRUE) { $groupIds = self::getAncestorGroupIds($groupIds, $includeSelf); @@ -558,9 +557,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param $groupIds An array of valid group ids (passed by reference) * - * @return $groupIdArray List of groupIds that represent the requested group and its children - * - * @access public + * @return array $groupIdArray List of groupIds that represent the requested group and its children@access public */ static function getChildGroupIds($groupIds) { if (!is_array($groupIds)) { @@ -602,9 +599,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param $groupIds An array of valid group ids (passed by reference) * - * @return $groupIdArray List of groupIds that represent the requested group and its descendents - * - * @access public + * @param bool $includeSelf + * @return array $groupIdArray List of groupIds that represent the requested group and its descendents@access public */ static function getDescendentGroupIds($groupIds, $includeSelf = TRUE) { if (!is_array($groupIds)) { @@ -636,9 +632,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param $groupIds An array of valid group ids (passed by reference) * - * @return $groupArray List of descendent groups - * - * @access public + * @param bool $includeSelf + * @return \An $groupArray List of descendent groups@access public */ static function getDescendentGroups($groupIds, $includeSelf = TRUE) { $groupIds = self::getDescendentGroupIds($groupIds, $includeSelf); @@ -651,9 +646,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param $groupId The group id to get valid potential children for * - * @return $groupIdArray List of groupIds that represent the valid potential children of the group - * - * @access public + * @return array $groupIdArray List of groupIds that represent the valid potential children of the group@access public */ static function getPotentialChildGroupIds($groupId) { $groups = CRM_Contact_BAO_Group::getGroups(); diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index c0ea1bdc1e..c70c0b17ea 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -406,15 +406,21 @@ class CRM_Contact_BAO_Query { /** * class constructor which also does all the work * - * @param array $params - * @param array $returnProperties - * @param array $fields + * @param array $params + * @param array $returnProperties + * @param array $fields * @param boolean $includeContactIds * @param boolean $strict - * @param boolean $mode - mode the search is operating on + * @param bool|int $mode - mode the search is operating on * - * @return Object - * @access public + * @param bool $skipPermission + * @param bool $searchDescendentGroups + * @param bool $smartGroupCache + * @param null $displayRelationshipType + * @param string $operator + * + * @return \CRM_Contact_BAO_Query + @access public */ function __construct( $params = NULL, $returnProperties = NULL, $fields = NULL, diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index 28385c43ed..545115dcfc 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -500,9 +500,10 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * * @param int $id relationship id * + * @param $action + * * @return null * @access public - * @static */ static function disableEnableRelationship($id, $action) { @@ -625,12 +626,12 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * this function does the validtion for valid relationship * - * @param array $params this array contains the values there are subitted by the form - * @param array $ids the array that holds all the db ids - * @param integer $contactId this is contact id for adding relationship + * @param array $params this array contains the values there are subitted by the form + * @param array $ids the array that holds all the db ids + * @param integer $contactId this is contact id for adding relationship * - * @return - * @access public + * @return string + @access public * @static */ static function checkValidRelationship(&$params, &$ids, $contactId) { @@ -763,9 +764,9 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array $params input parameters to find object - * @param array $values output values of the object - * @param array $ids the array that holds all the db ids + * @param array $params input parameters to find object + * @param array $values output values of the object + * @internal param array $ids the array that holds all the db ids * * @return array (reference) the values that could be potentially assigned to smarty * @access public diff --git a/CRM/Contact/Form/Search/Criteria.php b/CRM/Contact/Form/Search/Criteria.php index fa4b01ba40..b9cff19e73 100644 --- a/CRM/Contact/Form/Search/Criteria.php +++ b/CRM/Contact/Form/Search/Criteria.php @@ -520,6 +520,8 @@ class CRM_Contact_Form_Search_Criteria { * * @access private * + * @param $form + * * @return void */ static function custom(&$form) { diff --git a/CRM/Contact/Form/Task/SMSCommon.php b/CRM/Contact/Form/Task/SMSCommon.php index 6632f9ba8d..8d32a98aab 100644 --- a/CRM/Contact/Form/Task/SMSCommon.php +++ b/CRM/Contact/Form/Task/SMSCommon.php @@ -340,6 +340,8 @@ class CRM_Contact_Form_Task_SMSCommon { * * @access public * + * @param $form + * * @return void */ static function postProcess(&$form) { diff --git a/CRM/Contact/Import/Parser.php b/CRM/Contact/Import/Parser.php index 4cdff0bcb7..16de2f4152 100644 --- a/CRM/Contact/Import/Parser.php +++ b/CRM/Contact/Import/Parser.php @@ -608,6 +608,8 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { * * @param CRM_Core_Session $store * + * @param int $mode + * * @return void * @access public */ @@ -669,10 +671,11 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { /** * Export data to a CSV file * - * @param string $filename + * @param $fileName * @param array $header * @param data $data * + * @internal param string $filename * @return void * @access public */ diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index e0cb7580f6..cf4a173f22 100644 --- a/CRM/Contact/Import/Parser/Contact.php +++ b/CRM/Contact/Import/Parser/Contact.php @@ -442,6 +442,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { * @param int $onDuplicate the code for what action to take on duplicates * @param array $values the array of values belonging to this line * + * @param bool $doGeocodeAddress + * * @return boolean the result of this processing * @access public */ diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index b065a71f40..19cf4f3f9b 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -765,9 +765,12 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta /** * Check if there is a contribution with the same trxn_id or invoice_id * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $duplicates (reference ) store ids of duplicate contribs + * @param $input + * @param array $duplicates (reference ) store ids of duplicate contribs + * + * @param null $id * + * @internal param array $params (reference ) an assoc array of name/value pairs * @return boolean true if duplicate, false otherwise * @access public * static diff --git a/CRM/Contribute/BAO/ContributionPage.php b/CRM/Contribute/BAO/ContributionPage.php index a952e1e2b3..893ae5dc4e 100644 --- a/CRM/Contribute/BAO/ContributionPage.php +++ b/CRM/Contribute/BAO/ContributionPage.php @@ -437,11 +437,11 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio /** * Function to send the emails for Recurring Contribution Notication * - * @param string $type txnType - * @param int $contactID contact id for contributor - * @param int $pageID contribution page id - * @param object $recur object of recurring contribution table - * @param object $autoRenewMembership is it a auto renew membership. + * @param string $type txnType + * @param int $contactID contact id for contributor + * @param int $pageID contribution page id + * @param object $recur object of recurring contribution table + * @param bool|object $autoRenewMembership is it a auto renew membership. * * @return void * @access public @@ -535,10 +535,13 @@ class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_Contributio /** * Function to add the custom fields for contribution page (ie profile) * - * @param int $gid uf group id + * @param int $gid uf group id * @param string $name - * @param int $cid contact id - * @param array $params params to build component whereclause + * @param int $cid contact id + * @param $template + * @param array $params params to build component whereclause + * + * @param null $fieldTypes * * @return void * @access public @@ -707,6 +710,7 @@ WHERE entity_table = 'civicrm_contribution_page' /** * Function to get info for all sections enable/disable. * + * @param array $contribPageIds * @return array $info info regarding all sections. * @access public * @static diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php index 1093c2f5c0..dd2dc1fbfe 100644 --- a/CRM/Contribute/Form/Contribution.php +++ b/CRM/Contribute/Form/Contribution.php @@ -852,9 +852,11 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP /** * 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 diff --git a/CRM/Contribute/Form/Contribution/Main.php b/CRM/Contribute/Form/Contribution/Main.php index c9d2ffccdb..38fe6df3bd 100644 --- a/CRM/Contribute/Form/Contribution/Main.php +++ b/CRM/Contribute/Form/Contribution/Main.php @@ -704,9 +704,11 @@ class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_Contribu /** * 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 diff --git a/CRM/Contribute/Form/ManagePremiums.php b/CRM/Contribute/Form/ManagePremiums.php index 7c576cd69f..0787a131b6 100644 --- a/CRM/Contribute/Form/ManagePremiums.php +++ b/CRM/Contribute/Form/ManagePremiums.php @@ -377,6 +377,11 @@ class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form { * * @access private * + * @param $filename + * @param $resizedName + * @param $width + * @param $height + * * @return Path to image */ private function _resizeImage($filename, $resizedName, $width, $height) { diff --git a/CRM/Contribute/Import/Form/MapField.php b/CRM/Contribute/Import/Form/MapField.php index 4185f71f94..1de45cea6b 100644 --- a/CRM/Contribute/Import/Form/MapField.php +++ b/CRM/Contribute/Import/Form/MapField.php @@ -342,6 +342,9 @@ class CRM_Contribute_Import_Form_MapField extends CRM_Import_Form_MapField { * * @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 diff --git a/CRM/Contribute/Import/Parser.php b/CRM/Contribute/Import/Parser.php index a81b4de3c8..3aa687323f 100644 --- a/CRM/Contribute/Import/Parser.php +++ b/CRM/Contribute/Import/Parser.php @@ -477,6 +477,8 @@ pppp * @return void * * @param CRM_Core_Session $store * + * @param int $mode + * * @return void * @access public */ @@ -543,10 +545,11 @@ pppp * @return void /** * Export data to a CSV file * - * @param string $filename + * @param $fileName * @param array $header * @param data $data * + * @internal param string $filename * @return void * @access public */ diff --git a/CRM/Contribute/Page/ContributionPage.php b/CRM/Contribute/Page/ContributionPage.php index d6b8588f94..029f090315 100644 --- a/CRM/Contribute/Page/ContributionPage.php +++ b/CRM/Contribute/Page/ContributionPage.php @@ -386,6 +386,8 @@ AND cp.page_type = 'contribute' /** * Browse all contribution pages * + * @param null $action + * * @return void * @access public * @static diff --git a/CRM/Contribute/PseudoConstant.php b/CRM/Contribute/PseudoConstant.php index 4f03e3abce..e650b3a056 100644 --- a/CRM/Contribute/PseudoConstant.php +++ b/CRM/Contribute/PseudoConstant.php @@ -346,6 +346,9 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $pageType + * @param null $id + * * @return array - array reference of all pcp if any * @static */ @@ -378,6 +381,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * @access public * @static * + * @param string $column * @return array - array reference of all PCP activity statuses */ public static function &pcpStatus($column = 'label') { @@ -402,6 +406,8 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * @access public * @static * + * @param $financialTypeId + * @param null $relationTypeId * @return array - array reference of all financial accounts for a Financial type */ public static function financialAccountType($financialTypeId, $relationTypeId = NULL) { @@ -431,6 +437,7 @@ class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $id * @return array - array reference of all batches if any * @static */ diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php index 5a3b03116d..3b5e46e506 100644 --- a/CRM/Core/BAO/Address.php +++ b/CRM/Core/BAO/Address.php @@ -543,12 +543,13 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address { /** * Add the formatted address to $this-> display * - * @param NULL + * @param bool $microformat + * + * @internal param $NULL * * @return void * * @access public - * */ function addDisplay($microformat = FALSE) { $fields = array( @@ -584,6 +585,8 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address { * * @param int $id the contact id * + * @param bool $updateBlankLocInfo + * * @return array the array of adrress data * @access public * @static diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index c9bb3402d0..f14d4f981e 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -508,7 +508,10 @@ class CRM_Core_BAO_Block { /** * Sort location array so primary element is first - * @param Array $location + * + * @param $locations + * + * @internal param Array $location */ static function sortPrimaryFirst(&$locations){ uasort($locations, 'self::primaryComparison'); diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index d3ff5354b6..546559e23e 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -585,11 +585,13 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * Return the field ids and names (with groups) for import purpose. * - * @param int $contactType Contact type - * @param boolean $showAll If true returns all fields (includes disabled fields) - * @param boolean $onlyParent return fields ONLY related to basic types - * @param boolean $search when called from search and multiple records need to be returned - * @param boolean $checkPermission if false, do not include permissioning clause + * @param int|string $contactType Contact type + * @param boolean $showAll If true returns all fields (includes disabled fields) + * @param boolean $onlyParent return fields ONLY related to basic types + * @param boolean $search when called from search and multiple records need to be returned + * @param boolean $checkPermission if false, do not include permissioning clause + * + * @param bool $withMultiple * * @return array $fields - * @@ -654,8 +656,9 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * Get the field id from an import key * - * @param string $key The key to parse + * @param string $key The key to parse * + * @param bool $all * @return int|null The id (if exists) * @access public * @static @@ -714,13 +717,15 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * This function for building custom fields * - * @param CRM_Core_Form $qf form object (reference) - * @param string $elementName name of the custom field + * @param CRM_Core_Form $qf form object (reference) + * @param string $elementName name of the custom field + * @param $fieldId * @param boolean $inactiveNeeded - * @param boolean $userRequired true if required else false - * @param boolean $search true if used for search else false - * @param string $label label for custom field + * @param bool $useRequired + * @param boolean $search true if used for search else false + * @param string $label label for custom field * + * @internal param bool $userRequired true if required else false * @access public * @static */ diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index 6452076f71..494bb5b03c 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -617,6 +617,8 @@ ORDER BY civicrm_custom_group.weight, * @param integer $entityID id of entity for whom we are checking data for * @param string $table table that we are checking * + * @param bool $getCount + * * @return boolean does this entity have data in this custom table */ static public function customGroupDataExistsForEntity($entityID, $table, $getCount = FALSE){ diff --git a/CRM/Core/BAO/CustomValueTable.php b/CRM/Core/BAO/CustomValueTable.php index 0af5d6ce02..765cc3dd5c 100644 --- a/CRM/Core/BAO/CustomValueTable.php +++ b/CRM/Core/BAO/CustomValueTable.php @@ -473,6 +473,9 @@ AND $cond * * @array $params * + * @param $params + * + * @throws Exception * @return array * @static */ @@ -611,6 +614,9 @@ AND cf.id IN ( $fieldIDList ) * * @array $params * + * @param $params + * + * @throws Exception * @return array * @static */ diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php index 098b61b1b0..82f5794fb5 100644 --- a/CRM/Core/BAO/Dashboard.php +++ b/CRM/Core/BAO/Dashboard.php @@ -517,6 +517,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** * Delete Dashlet * + * @param $dashletID + * * @return void * @static */ diff --git a/CRM/Core/BAO/LabelFormat.php b/CRM/Core/BAO/LabelFormat.php index 5ef6312117..162c48d60c 100644 --- a/CRM/Core/BAO/LabelFormat.php +++ b/CRM/Core/BAO/LabelFormat.php @@ -392,10 +392,12 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Get Label Format field from associative array * - * @param string $field name of a label format field - * @param array (reference) $values associative array of name/value pairs containing + * @param string $field name of a label format field + * @param array (reference) $values associative array of name/value pairs containing * label format field selections * + * @param null $default + * * @return value * @access public * @static diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index 7588525bdf..667a94c2f4 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -388,7 +388,9 @@ ORDER BY modified_date desc"; /** * Function to get log record count for a Contact * - * @param int $contactId Contact ID + * @param $contactID + * + * @internal param int $contactId Contact ID * * @return int $count count of log records * @@ -542,7 +544,8 @@ ORDER BY modified_date desc"; * function to delete all note related to contact when contact is deleted * * @param int $contactID contact id whose notes to be deleted - * @param array $deleteNoteID to store all deleted note ids + * + * @internal param array $deleteNoteID to store all deleted note ids * * @return void * @static diff --git a/CRM/Core/BAO/OptionValue.php b/CRM/Core/BAO/OptionValue.php index dd9a80d726..591f61d1f7 100644 --- a/CRM/Core/BAO/OptionValue.php +++ b/CRM/Core/BAO/OptionValue.php @@ -418,9 +418,10 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { /** * updates options values weights. * - * @param int $opGroupIde option group id. - * @param array $opWeights options value , weight pair + * @param $opGroupId + * @param array $opWeights options value , weight pair * + * @internal param int $opGroupIde option group id. * @return void * @access public * @static diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index f19ab824e4..1937dbb020 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -421,6 +421,9 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * _setItem() is the common logic shared by setItem() and setItems(). * * @param array $params (required) An api formatted array of keys and values + * @param null $domains + * + * @throws api_Exception * @domains array an array of domains to get settings for. Default is the current domain * @return void * @static @@ -622,6 +625,11 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * @params string $name Name of specific setting e.g customCSSURL * @params integer $componentID id of relevant component. * + * @param null $componentID + * @param array $filters + * @param null $domainID + * @param null $profile + * * @return array $result - the following information as appropriate for each setting * - name * - type diff --git a/CRM/Core/BAO/Tag.php b/CRM/Core/BAO/Tag.php index e6da3cc04b..7eb6748025 100644 --- a/CRM/Core/BAO/Tag.php +++ b/CRM/Core/BAO/Tag.php @@ -389,8 +389,7 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { /** * Function to get the tags that are not children of a tagset. * - * @return $tags associated array of tag name and id - * @access public + * @return array $tags associated array of tag name and id@access public * @static */ static function getTagsNotInTagset() { diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index 7395d7366b..93a254b31c 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -679,11 +679,12 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * check the data validity * - * @param int $userID the user id that we are actually editing - * @param string $title the title of the group we are interested in - * @pram boolean $register is this the registrtion form - * @param int $action the action of the form + * @param int $userID the user id that we are actually editing + * @param string $title the title of the group we are interested in + * @param bool $register + * @param int $action the action of the form * + * @pram boolean $register is this the registrtion form * @return boolean true if form is valid * @static * @access public @@ -720,12 +721,15 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * get the html for the form that represents this particular group * - * @param int $userID the user id that we are actually editing - * @param string $title the title of the group we are interested in - * @param int $action the action of the form - * @param boolean $register is this the registration form - * @param boolean $reset should we reset the form? - * @param int $profileID do we have the profile ID? + * @param int $userID the user id that we are actually editing + * @param string $title the title of the group we are interested in + * @param int $action the action of the form + * @param boolean $register is this the registration form + * @param boolean $reset should we reset the form? + * @param int $profileID do we have the profile ID? + * + * @param bool $doNotProcess + * @param null $ctype * * @return string the html for the form on success, otherwise empty string * @static @@ -870,8 +874,10 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * searches for a contact in the db with similar attributes * * @param array $params the list of values to be used in the where clause - * @param int $id the current contact id (hence excluded from matching) - * @param boolean $flatten should we flatten the input params + * @param int $id the current contact id (hence excluded from matching) + * @param string $contactType + * + * @internal param bool $flatten should we flatten the input params * * @return contact_id if found, null otherwise * @access public @@ -893,13 +899,16 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * Given a contact id and a field set, return the values from the db * for this contact * - * @param int $id the contact id - * @param array $fields the profile fields of interest - * @param array $values the values for the above fields - * @param boolean $searchable searchable or not - * @param array $componentWhere component condition - * @param boolean $absolute return urls in absolute form (useful when sending an email) + * @param $cid + * @param array $fields the profile fields of interest + * @param array $values the values for the above fields + * @param boolean $searchable searchable or not + * @param array $componentWhere component condition + * @param boolean $absolute return urls in absolute form (useful when sending an email) + * + * @param null $additionalWhereClause * + * @internal param int $id the contact id * @return void * @access public * @static diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index 45746874b1..5b733dfe10 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -409,7 +409,9 @@ AND domain_id = %4 * Update the email value for the contact and user profile * * @param $contactId Int Contact ID of the user - * @param $email String email to be modified for the user + * @param $emailAddress + * + * @internal param String $email email to be modified for the user * * @return void * @access public @@ -553,6 +555,8 @@ AND domain_id = %4 * see if this user exists, and if so, if they're allowed to login * * + * @param $openId + * * @return bool true if allowed to login, false otherwise * @access public * @static diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php index 4a0f209878..0d0d739db4 100644 --- a/CRM/Core/Controller.php +++ b/CRM/Core/Controller.php @@ -425,13 +425,12 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { * add pages to the controller. Note that the controller does not really care * the order in which the pages are added * - * @param object $stateMachine the state machine object - * @param int $action the mode in which the state machine is operating + * @param object $stateMachine the state machine object + * @param \const|int $action the mode in which the state machine is operating * typicaly this will be add/view/edit * * @return void * @access public - * */ function addPages(&$stateMachine, $action = CRM_Core_Action::NONE) { $pages = $stateMachine->getPages(); @@ -638,7 +637,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { * Returns an array containing template variables * * @param string $name - * @param string $type + * + * @internal param string $type * @return array */ function get_template_vars($name=null) { diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 683657a9f6..c2f18f7d3a 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -521,6 +521,9 @@ LIKE %1 * * @param string $tableName * + * @param int $maxTablesToCheck + * @param string $fieldName + * * @return array * @static */ @@ -599,7 +602,10 @@ LIKE %1 /** * Checks if CONSTRAINT keyword exists for a specified table. * - * @param string $tableName + * @param array $tables + * + * @throws Exception + * @internal param string $tableName * * @return boolean true if CONSTRAINT keyword exists, false otherwise */ @@ -880,6 +886,13 @@ FROM civicrm_domain * * @param string $query query to be executed * + * @param array $params + * @param bool $abort + * @param null $daoName + * @param bool $freeDAO + * @param bool $i18nRewrite + * @param bool $trapException + * * @return Object CRM_Core_DAO object that holds the results of the query * @static * @access public diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index 5522abda16..c65a4f9ea9 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -494,10 +494,15 @@ class CRM_Core_Error extends PEAR_ErrorStack { * Similar to the function debug. Only difference is * in the formatting of the output. * - * @param string variable name - * @param mixed reference to variables that we need a trace of - * @param bool should we use print_r ? (else we use var_dump) - * @param bool should we log or return the output + * @param $variable_name + * @param $variable + * @param bool $print + * @param bool $log + * @param string $comp variable name + * + * @internal param \reference $mixed to variables that we need a trace of + * @internal param \should $bool we use print_r ? (else we use var_dump) + * @internal param \should $bool we log or return the output * * @return string the generated output * @@ -542,9 +547,10 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * display the error message on terminal * - * @param string message to be output - * @param bool should we log or return the output + * @param $message + * @param bool $out should we log or return the output * + * @param string $comp message to be output * @return string format of the backtrace * * @access public @@ -778,8 +784,10 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * Set a status message in the session, then bounce back to the referrer. * - * @param string $status The status message to set + * @param string $status The status message to set * + * @param null $redirect + * @param string $title * @return void * @access public * @static diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index 257230f969..1112f75d75 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -752,9 +752,10 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * assign value to name in template * - * @param array|string $name name of variable + * @param $var * @param mixed $value value of varaible * + * @internal param array|string $name name of variable * @return void * @access public */ @@ -765,9 +766,10 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * assign value to name in template by reference * - * @param array|string $name name of variable + * @param $var * @param mixed $value value of varaible * + * @internal param array|string $name name of variable * @return void * @access public */ @@ -790,7 +792,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * Returns an array containing template variables * * @param string $name - * @param string $type + * + * @internal param string $type * @return array */ function get_template_vars($name=null) { diff --git a/CRM/Core/OptionGroup.php b/CRM/Core/OptionGroup.php index 734fbb5e1a..6049e10b46 100644 --- a/CRM/Core/OptionGroup.php +++ b/CRM/Core/OptionGroup.php @@ -405,7 +405,7 @@ WHERE v.option_group_id = g.id * not messed up. Currently deletes the old group * * @param string $groupName the name of the option group - make sure there is no conflict - * @param array $values the associative array that has information on the option values + * @param array $values the associative array that has information on the option values * the keys of this array are: * string 'title' (required) * string 'value' (required) @@ -414,14 +414,15 @@ WHERE v.option_group_id = g.id * int 'weight' (optional) - the order in which the value are displayed * bool 'is_default' (optional) - is this the default one to display when rendered in form * bool 'is_active' (optional) - should this element be rendered - * @param int $defaultID (reference) - the option value ID of the default element (if set) is returned else 'null' - * @param string $groupLabel - the optional label of the option group else set to group name + * @param int $defaultID (reference) - the option value ID of the default element (if set) is returned else 'null' + * @param null $groupTitle + * + * @internal param string $groupLabel - the optional label of the option group else set to group name * * @access public * @static * * @return int the option group ID - * */ static function createAssoc($groupName, &$values, &$defaultID, $groupTitle = NULL) { self::deleteAssoc($groupName); diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php index ff29d5ae93..0dd7b0986e 100644 --- a/CRM/Core/OptionValue.php +++ b/CRM/Core/OptionValue.php @@ -347,6 +347,8 @@ class CRM_Core_OptionValue { /** * build select query in case of option-values * + * @param $query + * * @return void * @access public */ diff --git a/CRM/Core/Payment/AuthorizeNet.php b/CRM/Core/Payment/AuthorizeNet.php index 1edfe38d8f..dc891f1f67 100644 --- a/CRM/Core/Payment/AuthorizeNet.php +++ b/CRM/Core/Payment/AuthorizeNet.php @@ -434,6 +434,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * @param string $transaction_id Transaction id generated by the gateway * @param string $amount Purchase amount * + * @param bool $ipn + * * @return bool */ function checkMD5($responseMD5, $transaction_id, $amount, $ipn = FALSE) { @@ -550,6 +552,7 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * * @param string $field the field * + * @param bool $xmlSafe * @return mixed value of the field, or empty string if the field is * not set */ diff --git a/CRM/Core/Payment/Form.php b/CRM/Core/Payment/Form.php index e2f67d2c54..9e4b334acf 100644 --- a/CRM/Core/Payment/Form.php +++ b/CRM/Core/Payment/Form.php @@ -426,6 +426,8 @@ class CRM_Core_Payment_Form { * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011) * See CRM-9017 * + * @param $src + * * @return int * @static */ @@ -442,6 +444,8 @@ class CRM_Core_Payment_Form { * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011) * This function exists only to make it consistant with getCreditCardExpirationMonth * + * @param $src + * * @return int * @static */ diff --git a/CRM/Core/Payment/GoogleIPN.php b/CRM/Core/Payment/GoogleIPN.php index 267f45c344..4a8e762cd9 100644 --- a/CRM/Core/Payment/GoogleIPN.php +++ b/CRM/Core/Payment/GoogleIPN.php @@ -381,6 +381,9 @@ WHERE contribution_recur_id = {$ids['contributionRecur']} * * @param string $mode the mode of operation: live or test * + * @param $component + * @param $paymentProcessor + * * @return object * @static */ @@ -413,11 +416,13 @@ WHERE contribution_recur_id = {$ids['contributionRecur']} /** * The function returns the component(Event/Contribute..), given the google-order-no and merchant-private-data * - * @param xml $xml_response response send by google in xml format - * @param array $privateData contains the name value pair of - * @param int $orderNo send by google - * @param string $root root of xml-response + * @param array $privateData contains the name value pair of + * @param int $orderNo send by google + * @param string $root root of xml-response * + * @param $response + * @param $serial + * @internal param \xml $xml_response response send by google in xml format * @return array context of this call (test, module, payment processor id) * @static */ diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index 1e6b47526e..7d333fa87f 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -599,8 +599,7 @@ class 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)) { @@ -618,7 +617,7 @@ class CRM_Core_PseudoConstant { * * The static array activityType is returned * - * @param boolean $all - get All Activity types - default is to get only active ones. + * @internal param bool $all - get All Activity types - default is to get only active ones. * * @access public * @static @@ -698,10 +697,11 @@ class CRM_Core_PseudoConstant { * @access public * @static * - * @param int $id - Optional id to return + * @param bool|int $id - Optional id to return * - * @return array - array reference of all State/Provinces. + * @param bool $limit * + * @return array - array reference of all State/Provinces. */ public static function &stateProvince($id = FALSE, $limit = TRUE) { if (($id && !CRM_Utils_Array::value($id, self::$stateProvince)) || !self::$stateProvince || !$id) { @@ -753,7 +753,9 @@ class CRM_Core_PseudoConstant { * @access public * @static * - * @param int $id - Optional id to return + * @param bool|int $id - Optional id to return + * + * @param bool $limit * * @return array - array reference of all State/Province abbreviations. */ diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php index 7343de9249..7b0430ef9e 100644 --- a/CRM/Core/Resources.php +++ b/CRM/Core/Resources.php @@ -386,7 +386,7 @@ class CRM_Core_Resources { * @param $ext string, extension name; use 'civicrm' for core * @param $file string, file path -- relative to the extension base dir * - * @return (string|bool), full file path or FALSE if not found + * @return bool|string (string|bool), full file path or FALSE if not found */ public function getPath($ext, $file) { // TODO consider caching results @@ -402,6 +402,8 @@ class CRM_Core_Resources { * * @param $ext string, extension name; use 'civicrm' for core * @param $file string, file path -- relative to the extension base dir + * @param bool $addCacheCode + * * @return string, URL */ public function getUrl($ext, $file = NULL, $addCacheCode = FALSE) { @@ -437,6 +439,7 @@ class CRM_Core_Resources { * TODO: Separate the functional code (like addStyle/addScript) from the policy code * (like addCoreResources/addCoreStyles). * + * @param string $region * @return CRM_Core_Resources * @access public */ diff --git a/CRM/Core/Selector/Controller.php b/CRM/Core/Selector/Controller.php index 09c7ff4ed1..2f00bb4c4d 100644 --- a/CRM/Core/Selector/Controller.php +++ b/CRM/Core/Selector/Controller.php @@ -392,6 +392,8 @@ class CRM_Core_Selector_Controller { /** * function to retrieve rows. * + * @param $form + * * @return array of rows * @access public */ diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index 76c886b071..72b569fec7 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -625,7 +625,9 @@ LIMIT 0, 10 /** * function to get the information to map a event * - * @param array $ids the list of ids for which we want map info + * @param $id + * + * @internal param array $ids the list of ids for which we want map info * * @return null|string title of the event * @static @@ -871,9 +873,12 @@ WHERE civicrm_event.is_active = 1 * This function is to make a copy of a Event, including * all the fields in the event Wizard * - * @param int $id the event id to copy + * @param int $id the event id to copy * obj $newEvent object of CRM_Event_DAO_Event * boolean $afterCreate call to copy after the create function + * @param null $newEvent + * @param bool $afterCreate + * * @return void * @access public */ diff --git a/CRM/Event/Form/EventFees.php b/CRM/Event/Form/EventFees.php index 046fe4e8a1..753417c809 100644 --- a/CRM/Event/Form/EventFees.php +++ b/CRM/Event/Form/EventFees.php @@ -344,6 +344,8 @@ SELECT id, html_type /** * Function to build the form * + * @param $form + * * @return void * @access public */ diff --git a/CRM/Event/Form/ManageEvent/Registration.php b/CRM/Event/Form/ManageEvent/Registration.php index ef56b06b77..0f64759f46 100644 --- a/CRM/Event/Form/ManageEvent/Registration.php +++ b/CRM/Event/Form/ManageEvent/Registration.php @@ -383,7 +383,9 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Function to build Confirmation Block * - * @param int $pageId + * @param $form + * + * @internal param int $pageId * @static */ function buildConfirmationBlock(&$form) { @@ -405,7 +407,9 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Function to build Email Block * - * @param int $pageId + * @param $form + * + * @internal param int $pageId * @static */ function buildMailBlock(&$form) { @@ -448,7 +452,11 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * global validation rules for the form * - * @param array $fields posted values of the form + * @param $values + * @param $files + * @param $form + * + * @internal param array $fields posted values of the form * * @return array list of errors to be posted back to the form * @static @@ -638,6 +646,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Collect all email fields for an array of profile ids * + * @param $profileIds * @return boolean */ static function getEmailFields($profileIds) { @@ -658,6 +667,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Check if a profile contains required fields * + * @param $profileIds * @return boolean */ static function isProfileComplete($profileIds) { @@ -691,6 +701,8 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Check if the profiles collect enough information to dedupe * + * @param $profileIds + * @param int $rgId * @return boolean */ diff --git a/CRM/Event/Form/Participant.php b/CRM/Event/Form/Participant.php index 8ecbe28f56..13b1101061 100644 --- a/CRM/Event/Form/Participant.php +++ b/CRM/Event/Form/Participant.php @@ -867,7 +867,11 @@ class CRM_Event_Form_Participant extends CRM_Contact_Form_Task { /** * global validation rules for the form * - * @param array $fields posted values of the form + * @param $values + * @param $files + * @param $self + * + * @internal param array $fields posted values of the form * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Event/Form/Registration.php b/CRM/Event/Form/Registration.php index 50fe65fba4..5a234b24e5 100644 --- a/CRM/Event/Form/Registration.php +++ b/CRM/Event/Form/Registration.php @@ -733,6 +733,10 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { /** * Function to handle process after the confirmation of payment by User * + * @param null $contactID + * @param null $contribution + * @param null $payment + * * @return void * @access public */ diff --git a/CRM/Event/Form/Registration/AdditionalParticipant.php b/CRM/Event/Form/Registration/AdditionalParticipant.php index 9340542365..68dab3a399 100644 --- a/CRM/Event/Form/Registration/AdditionalParticipant.php +++ b/CRM/Event/Form/Registration/AdditionalParticipant.php @@ -739,6 +739,8 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R /** * check whether call current participant is last one * + * @param bool $isButtonJs + * * @return boolean ture on success. * @access public */ diff --git a/CRM/Event/Form/Registration/Register.php b/CRM/Event/Form/Registration/Register.php index e97b05344c..2210e7a653 100644 --- a/CRM/Event/Form/Registration/Register.php +++ b/CRM/Event/Form/Registration/Register.php @@ -508,7 +508,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { if (empty($this->_values['event']['is_monetary'])) { $js = array('onclick' => "return submitOnce(this,'" . $this->_name . "','" . ts('Processing') . "');"); } - + // CRM-11182 - Optional confirmation screen // Change button label depending on whether the next action is confirm or register if ( @@ -520,7 +520,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { } else { $buttonLabel = ts('Continue >>'); } - + $this->addButtons(array( array( 'type' => 'upload', @@ -611,7 +611,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions $adminFieldVisible = false; if (CRM_Core_Permission::check('administer CiviCRM')) { - $adminFieldVisible = true; + $adminFieldVisible = true; } foreach ($form->_feeBlock as $field) { @@ -781,9 +781,11 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { /** * 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 diff --git a/CRM/Event/Import/Parser.php b/CRM/Event/Import/Parser.php index 3d74af6548..904ed039d5 100644 --- a/CRM/Event/Import/Parser.php +++ b/CRM/Event/Import/Parser.php @@ -396,10 +396,11 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser { /** * Export data to a CSV file * - * @param string $filename + * @param $fileName * @param array $header * @param data $data * + * @internal param string $filename * @return void * @access public */ diff --git a/CRM/Extension/Manager.php b/CRM/Extension/Manager.php index 6d7f172334..2b5f48a93e 100644 --- a/CRM/Extension/Manager.php +++ b/CRM/Extension/Manager.php @@ -437,8 +437,10 @@ class CRM_Extension_Manager { /** * Find the $info and $typeManager for a $key * - * @return array (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface) + * @param $key + * * @throws CRM_Extension_Exception + * @return array (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface) */ private function _getMissingInfoTypeHandler($key) { $info = $this->createInfoFromDB($key); @@ -503,6 +505,7 @@ class CRM_Extension_Manager { * Auto-generate a place-holder for a missing extension using info from * database. * + * @param $key * @return CRM_Extension_Info|NULL */ public function createInfoFromDB($key) { diff --git a/CRM/Grant/BAO/Grant.php b/CRM/Grant/BAO/Grant.php index ec11bac78c..c4ae493175 100644 --- a/CRM/Grant/BAO/Grant.php +++ b/CRM/Grant/BAO/Grant.php @@ -420,7 +420,9 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** * Function to get grant record count for a Contact * - * @param int $contactId Contact ID + * @param $contactID + * + * @internal param int $contactId Contact ID * * @return int count of grant records * @access public diff --git a/CRM/Mailing/BAO/MailingJob.php b/CRM/Mailing/BAO/MailingJob.php index 09ba631d58..960889b693 100644 --- a/CRM/Mailing/BAO/MailingJob.php +++ b/CRM/Mailing/BAO/MailingJob.php @@ -455,7 +455,9 @@ VALUES (%1, %2, %3, %4, %5, %6, %7) /** * Send the mailing * - * @param object $mailer A Mail object to send the messages + * @param object $mailer A Mail object to send the messages + * + * @param null $testParams * * @return void * @access public diff --git a/CRM/Mailing/Event/BAO/Unsubscribe.php b/CRM/Mailing/Event/BAO/Unsubscribe.php index 7ae4eb2d19..d4b54042c5 100644 --- a/CRM/Mailing/Event/BAO/Unsubscribe.php +++ b/CRM/Mailing/Event/BAO/Unsubscribe.php @@ -403,9 +403,11 @@ WHERE email = %2 /** * Get row count for the event selector * - * @param int $mailing_id ID of the mailing - * @param int $job_id Optional ID of a job to filter on - * @param boolean $is_distinct Group by queue ID? + * @param int $mailing_id ID of the mailing + * @param int $job_id Optional ID of a job to filter on + * @param boolean $is_distinct Group by queue ID? + * + * @param null $org_unsubscribe * * @return int Number of rows in result set * @access public @@ -461,13 +463,14 @@ WHERE email = %2 /** * Get rows for the event browser * - * @param int $mailing_id ID of the mailing - * @param int $job_id optional ID of the job - * @param boolean $is_distinct Group by queue id? - * @param int $offset Offset - * @param int $rowCount Number of rows - * @param array $sort sort array + * @param int $mailing_id ID of the mailing + * @param int $job_id optional ID of the job + * @param boolean $is_distinct Group by queue id? + * @param int $offset Offset + * @param int $rowCount Number of rows + * @param array $sort sort array * + * @param null $org_unsubscribe * @return array Result set * @access public * @static diff --git a/CRM/Mailing/Form/Upload.php b/CRM/Mailing/Form/Upload.php index 507b794cf1..6e780c1b14 100644 --- a/CRM/Mailing/Form/Upload.php +++ b/CRM/Mailing/Form/Upload.php @@ -505,6 +505,9 @@ class CRM_Mailing_Form_Upload extends CRM_Core_Form { * * @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 diff --git a/CRM/Member/Form/Membership.php b/CRM/Member/Form/Membership.php index 0f7f31dd17..98ecd10985 100644 --- a/CRM/Member/Form/Membership.php +++ b/CRM/Member/Form/Membership.php @@ -838,6 +838,10 @@ WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )'; * * @param array $params (ref.) an assoc array of name/value pairs * + * @param $files + * @param $self + * + * @throws CiviCRM_API3_Exception * @return mixed true or array of errors * @access public * @static diff --git a/CRM/Member/Import/Parser/Membership.php b/CRM/Member/Import/Parser/Membership.php index 8c9d6a4c5f..01c82f5104 100644 --- a/CRM/Member/Import/Parser/Membership.php +++ b/CRM/Member/Import/Parser/Membership.php @@ -583,11 +583,13 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { /** * to calculate join, start and end dates * - * @param Array $calcDates array of dates returned by getDatesForMembershipType() + * @param Array $calcDates array of dates returned by getDatesForMembershipType() * - * @return Array formatted containing date values + * @param $formatted * - * @access public + * @return Array formatted containing date values + * + * @access public */ function formattedDates($calcDates, &$formatted) { $dates = array( diff --git a/CRM/Member/Page/Tab.php b/CRM/Member/Page/Tab.php index 028ff5fca7..d39d3b660e 100644 --- a/CRM/Member/Page/Tab.php +++ b/CRM/Member/Page/Tab.php @@ -376,7 +376,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { $urlParams .= "&qfKey=$qfKey"; } $form->assign('searchKey', $qfKey); - + if ($searchContext) { $url = CRM_Utils_System::url("civicrm/$searchContext/search", $urlParams); } @@ -435,6 +435,12 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { /** * Get action links * + * @param string $status + * @param null $isPaymentProcessor + * @param null $accessContribution + * @param bool $isCancelSupported + * @param bool $isUpdateBilling + * * @return array (reference) of action links * @static */ diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index 1258616e2d..8a5fe29772 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -613,14 +613,16 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; * 1. when their PCP status is changed by site admin. * 2. when supporter initially creates a Personal Campaign Page ($isInitial set to true). * - * @param int $pcpId campaign page id - * @param int $newStatus pcp status id - * @param int $isInitial is it the first time, campaign page has been created by the user + * @param int $pcpId campaign page id + * @param int $newStatus pcp status id + * @param bool|int $isInitial is it the first time, campaign page has been created by the user * + * @param string $component + * + * @throws Exception * @return null * @access public * @static - * */ static function sendStatusUpdate($pcpId, $newStatus, $isInitial = FALSE, $component = 'contribute') { $pcpStatus = CRM_Core_OptionGroup::values("pcp_status"); @@ -709,10 +711,10 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; * * @param int $id campaign page id * + * @param $is_active * @return null * @access public * @static - * */ static function setDisable($id, $is_active) { return CRM_Core_DAO::setFieldValue('CRM_PCP_DAO_PCP', $id, 'is_active', $is_active); @@ -721,12 +723,13 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Function to get pcp block is active * - * @param int $id campaign page id + * @param $pcpId + * @param $component + * @internal param int $id campaign page id * * @return int * @access public * @static - * */ static function getStatus($pcpId, $component) { $query = " @@ -745,12 +748,13 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Function to get pcp block is enabled for component page * - * @param int $id contribution page id + * @param $pageId + * @param $component + * @internal param int $id contribution page id * * @return String * @access public * @static - * */ static function getPcpBlockStatus($pageId, $component) { $query = " @@ -877,12 +881,13 @@ WHERE pcp.id = %1"; /** * Function to get pcp entity table given a component. * - * @param int $id campaign page id + * @param $component + * + * @internal param int $id campaign page id * * @return String * @access public * @static - * */ static function getPcpEntityTable($component) { $entity_table_map = array( diff --git a/CRM/Pledge/BAO/Pledge.php b/CRM/Pledge/BAO/Pledge.php index 0ca89e6768..0ee929177f 100644 --- a/CRM/Pledge/BAO/Pledge.php +++ b/CRM/Pledge/BAO/Pledge.php @@ -786,7 +786,9 @@ GROUP BY currency /** * Function to get pledge record count for a Contact * - * @param int $contactId Contact ID + * @param $contactID + * + * @internal param int $contactId Contact ID * * @return int count of pledge records * @access public diff --git a/CRM/Pledge/BAO/PledgePayment.php b/CRM/Pledge/BAO/PledgePayment.php index ba70845266..2dfe2dfecd 100644 --- a/CRM/Pledge/BAO/PledgePayment.php +++ b/CRM/Pledge/BAO/PledgePayment.php @@ -673,6 +673,8 @@ WHERE civicrm_pledge_payment.id = {$paymentId} * * @param int $pledgeID pledge id * + * @param int $limit + * * @return array associated array of pledge details * @static */ diff --git a/CRM/Pledge/Form/Pledge.php b/CRM/Pledge/Form/Pledge.php index cafb67983f..97ba708dbf 100644 --- a/CRM/Pledge/Form/Pledge.php +++ b/CRM/Pledge/Form/Pledge.php @@ -481,9 +481,11 @@ class CRM_Pledge_Form_Pledge 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 * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Pledge/Form/Search.php b/CRM/Pledge/Form/Search.php index c96a51b5e0..f080b20b60 100644 --- a/CRM/Pledge/Form/Search.php +++ b/CRM/Pledge/Form/Search.php @@ -377,7 +377,8 @@ class CRM_Pledge_Form_Search extends CRM_Core_Form_Search { * global validation rules for the form * * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form + * + * @internal param array $errors list of errors to be posted back to the form * * @return void * @static diff --git a/CRM/Price/BAO/PriceField.php b/CRM/Price/BAO/PriceField.php index fc3aa872aa..a029dd1494 100644 --- a/CRM/Price/BAO/PriceField.php +++ b/CRM/Price/BAO/PriceField.php @@ -583,13 +583,16 @@ WHERE /** * Validate the priceset * - * @param int $priceSetId, array $fields + * @param int $priceSetId , array $fields * * retrun the error string * + * @param $fields + * @param $error + * @param bool $allowNoneSelection + * * @access public * @static - * */ public static function priceSetValidation($priceSetId, $fields, &$error, $allowNoneSelection = FALSE) { diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index 91379a00f5..3457fc57da 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -463,7 +463,11 @@ WHERE ct.id = cp.financial_type_id AND * * An array containing price set details (including price fields) is returned * - * @param int $setId - price set id whose details are needed + * @param $setID + * @param bool $required + * @param bool $validOnly + * + * @internal param int $setId - price set id whose details are needed * * @return array $setTree - array consisting of field details */ diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index bb1559e861..28509d5b05 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -782,7 +782,10 @@ class CRM_Report_Form extends CRM_Core_Form { /** * Setter for $_id - * @param integer $id + * + * @param $instanceid + * + * @internal param int $id */ function setID($instanceid) { $this->_id = $instanceid; @@ -790,8 +793,9 @@ class CRM_Report_Form extends CRM_Core_Form { /** * Setter for $_force - * @param boolean $force - */ + * @param $isForce + * @internal param bool $force +*/ function setForce($isForce) { $this->_force = $isForce; } diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php index 802dcbc0b3..a59152e560 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php @@ -547,13 +547,15 @@ WHERE /** * Validate the priceset * - * @param int $priceSetId, array $fields + * @param int $priceSetId , array $fields * * retrun the error string * + * @param $fields + * @param $error + * * @access public * @static - * */ public static function priceSetValidation($priceSetId, $fields, &$error) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php index 215526c7cd..50c950a3d7 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php @@ -858,12 +858,15 @@ return FALSE; } } -/** - * Function to set daefult the price set fields. - * - * @return array $defaults - * @access public - */ + /** + * Function to set daefult the price set fields. + * + * @param $form + * @param $defaults + * + * @return array $defaults + * @access public + */ static function setDefaultPriceSet(&$form, &$defaults) { if (!isset($form->_priceSet) || empty($form->_priceSet['fields'])) { return $defaults; diff --git a/CRM/Utils/Migrate/Export.php b/CRM/Utils/Migrate/Export.php index 54c06fbd70..f37714c16e 100644 --- a/CRM/Utils/Migrate/Export.php +++ b/CRM/Utils/Migrate/Export.php @@ -444,8 +444,10 @@ class CRM_Utils_Migrate_Export { } /** - * @param CRM_Core_DAO $object * @param string $objectName business-entity/xml-tag name + * @param CRM_Core_DAO $object + * @param $mappedFields + * * @return array */ function exportDAO($objectName, $object, $mappedFields) { @@ -525,7 +527,8 @@ class CRM_Utils_Migrate_Export { /** * @param string $tagName * @param array $keyValues - * @param string $additional XML + * @throws Exception + * @internal param string $additional XML * @return string XML */ public function renderKeyValueXML($tagName, $keyValues) { diff --git a/Civi/API/Provider/MagicFunctionProvider.php b/Civi/API/Provider/MagicFunctionProvider.php index ce14050bad..f3162041b5 100644 --- a/Civi/API/Provider/MagicFunctionProvider.php +++ b/Civi/API/Provider/MagicFunctionProvider.php @@ -215,6 +215,8 @@ class MagicFunctionProvider implements EventSubscriberInterface, ProviderInterfa /** * @param string $entity * @param string $action + * @param $version + * * @return string */ protected function getFunctionName($entity, $action, $version) { @@ -267,4 +269,4 @@ class MagicFunctionProvider implements EventSubscriberInterface, ProviderInterfa } } -} \ No newline at end of file +} diff --git a/Civi/Core/Container.php b/Civi/Core/Container.php index 38b9fbbb5d..eb0b13f11d 100644 --- a/Civi/Core/Container.php +++ b/Civi/Core/Container.php @@ -89,6 +89,8 @@ class Container { /** * @param \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher + * @param $magicFunctionProvider + * * @return \Civi\API\Kernel */ public function createApiKernel($dispatcher, $magicFunctionProvider) { diff --git a/distmaker/utils/joomlaxml.php b/distmaker/utils/joomlaxml.php index 13f3ff2643..9bbf93fa05 100644 --- a/distmaker/utils/joomlaxml.php +++ b/distmaker/utils/joomlaxml.php @@ -42,8 +42,9 @@ generateJoomlaConfig($version); * This function creates destination directory * * @param $dir directory name to be created - * @param $peram mode for that directory + * @param int $perm * + * @internal param \mode $peram for that directory */ function createDir($dir, $perm = 0755) { if (!is_dir($dir)) { diff --git a/tests/extensions/test.extension.manager.searchtest/main.php b/tests/extensions/test.extension.manager.searchtest/main.php index 6a4ffad47c..e7b7104ab1 100644 --- a/tests/extensions/test.extension.manager.searchtest/main.php +++ b/tests/extensions/test.extension.manager.searchtest/main.php @@ -116,6 +116,8 @@ class test_extension_manager_searchtest extends CRM_Contact_Form_Search_Custom_B /** * Construct a SQL WHERE clause * + * @param bool $includeContactIDs + * * @return string, sql fragment with conditional expressions */ function where($includeContactIDs = FALSE) { diff --git a/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php b/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php index 9220c7555e..e484a7dd7f 100644 --- a/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php +++ b/tests/phpunit/CRM/Core/BAO/ActionScheduleTest.php @@ -473,7 +473,9 @@ class CRM_Core_BAO_ActionScheduleTest extends CiviUnitTestCase { /** * Run a series of cron jobs and make an assertion about email deliveries * - * @param $jobSchedule array specifying when to run cron and what messages to expect; each item is an array with keys: + * @param $cronRuns + * + * @internal param array $jobSchedule specifying when to run cron and what messages to expect; each item is an array with keys: * - time: string, e.g. '2012-06-15 21:00:01' * - recipients: array(array(string)), list of email addresses which should receive messages */ diff --git a/tests/phpunit/CRM/Core/CommunityMessagesTest.php b/tests/phpunit/CRM/Core/CommunityMessagesTest.php index c2058041f3..e25a27c093 100644 --- a/tests/phpunit/CRM/Core/CommunityMessagesTest.php +++ b/tests/phpunit/CRM/Core/CommunityMessagesTest.php @@ -373,6 +373,8 @@ class CRM_Core_CommunityMessagesTest extends CiviUnitTestCase { /** * Generate a mock HTTP client with the expectation that it is called once. * + * @param $response + * * @return CRM_Utils_HttpClient|PHPUnit_Framework_MockObject_MockObject */ protected function expectOneHttpRequest($response) { diff --git a/tests/phpunit/CRM/Core/ResourcesTest.php b/tests/phpunit/CRM/Core/ResourcesTest.php index 857a7d1547..5c8aa6c4b4 100644 --- a/tests/phpunit/CRM/Core/ResourcesTest.php +++ b/tests/phpunit/CRM/Core/ResourcesTest.php @@ -286,7 +286,8 @@ class CRM_Core_ResourcesTest extends CiviUnitTestCase { /** * @param CRM_Utils_Cache_Interface $cache * @param null $cacheKey - * @param string $appendPathGarbage + * + * @internal param string $appendPathGarbage * @return array(string $basedir, CRM_Extension_Container_Interface, CRM_Extension_Mapper) */ function _createMapper(CRM_Utils_Cache_Interface $cache = NULL, $cacheKey = NULL) { diff --git a/tests/phpunit/CRM/Extension/Manager/ModuleTest.php b/tests/phpunit/CRM/Extension/Manager/ModuleTest.php index 09cff7b835..902b0b97e2 100644 --- a/tests/phpunit/CRM/Extension/Manager/ModuleTest.php +++ b/tests/phpunit/CRM/Extension/Manager/ModuleTest.php @@ -215,6 +215,7 @@ class CRM_Extension_Manager_ModuleTest extends CiviUnitTestCase { } /** + * @param $module * @param array $counts expected hook invocation counts ($hookName => $count) */ function assertHookCounts($module, $counts) { diff --git a/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php b/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php index cda5561b46..4424aec7fa 100644 --- a/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php +++ b/tests/phpunit/CRM/Utils/Migrate/ImportExportTest.php @@ -172,9 +172,14 @@ class CRM_Utils_Migrate_ImportExportTest extends CiviUnitTestCase { } /** - * @param $customGroupParams - * @param $fieldParams - * @param $expectedXmlFilePath + * @param $expectCustomGroup + * @param $expectCustomField + * @param $inputXmlFilePath + * + * @throws CRM_Core_Exception + * @internal param $customGroupParams + * @internal param $fieldParams + * @internal param $expectedXmlFilePath * @dataProvider basicXmlTestCases */ function testBasicXMLImports($expectCustomGroup, $expectCustomField, $inputXmlFilePath) { @@ -199,4 +204,4 @@ class CRM_Utils_Migrate_ImportExportTest extends CiviUnitTestCase { $this->assertEquals($expectValue, $customField[$expectKey]); } } -} \ No newline at end of file +} diff --git a/tests/phpunit/Civi/API/KernelTest.php b/tests/phpunit/Civi/API/KernelTest.php index 945655b800..512c08cd82 100644 --- a/tests/phpunit/Civi/API/KernelTest.php +++ b/tests/phpunit/Civi/API/KernelTest.php @@ -91,8 +91,9 @@ class KernelTest extends \CiviUnitTestCase { * Add listeners to $this->dispatcher which record each invocation of $monitoredEvents * in $this->actualEventSequence. * - * @param EventDispatcher $this->dispatcher * @param array $monitoredEvents list of event names + * + * @internal param \Symfony\Component\EventDispatcher\EventDispatcher $this ->dispatcher */ public function monitorEvents($monitoredEvents) { foreach ($monitoredEvents as $monitoredEvent) { @@ -105,4 +106,4 @@ class KernelTest extends \CiviUnitTestCase { }, 2 * Events::W_EARLY); } } -} \ No newline at end of file +} diff --git a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php index b208bd1e8d..007eb22da4 100644 --- a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php +++ b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php @@ -60,8 +60,9 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * of that class to decide how to set up the test. * * @param string $name - * @param array $data + * @param array $data * @param string $dataName + * @param array $browser */ function __construct($name = NULL, array$data = array(), $dataName = '', array$browser = array()) { parent::__construct($name, $data, $dataName, $browser); @@ -298,7 +299,9 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * * @param string $fname contact’s first name * @param string $lname contact’s last name - * @param mixed $email contact’s email (when string) or random email (when true) or no email (when null) + * @param mixed $email contact’s email (when string) or random email (when true) or no email (when null) + * + * @param null $contactSubtype * * @return mixed either a string with the (either generated or provided) email or null (if no email) */ @@ -544,6 +547,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * * @strings array array of strings or a single string * + * @param $strings * @return void */ function assertStringsPresent($strings) { @@ -557,10 +561,10 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * * @url string url to parse or retrieve current url if null * + * @param null $url * @return array returns an associative array containing any of the various components * of the URL that are present. Querystring elements are returned in sub-array (elements.queryString) * http://php.net/manual/en/function.parse-url.php - * */ function parseURL($url = NULL) { if (!$url) { @@ -589,8 +593,10 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * * @param string $processorName Name assigned to new processor * @param string $processorType Name for processor type (e.g. PayPal, Dummy, etc.) - * @param array $processorSettings Array of fieldname => value for required settings for the processor + * @param array $processorSettings Array of fieldname => value for required settings for the processor * + * @param string $financialAccount + * @throws PHPUnit_Framework_AssertionFailedError * @return void */ @@ -789,9 +795,35 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * Create new online contribution page w/ user specified params or defaults. * FIXME: this function take an absurd number of params - very unwieldy :( * - * @param User can define pageTitle, hash and rand values for later data verification + * @param null $hash + * @param null $rand + * @param null $pageTitle + * @param array $processor + * @param bool $amountSection + * @param bool $payLater + * @param bool $onBehalf + * @param bool $pledges + * @param bool $recurring + * @param bool $membershipTypes + * @param null $memPriceSetId + * @param bool $friend + * @param int $profilePreId + * @param int $profilePostId + * @param bool $premiums + * @param bool $widget + * @param bool $pcp + * @param bool $isAddPaymentProcessor + * @param bool $isPcpApprovalNeeded + * @param bool $isSeparatePayment + * @param bool $honoreeSection + * @param bool $allowOtherAmmount + * @param bool $isConfirmEnabled + * @param string $financialType + * @param bool $fixedAmount + * @param bool $membershipsRequired + * @internal param \can $User define pageTitle, hash and rand values for later data verification * - * @return $pageId of newly created online contribution page. + * @return null $pageId of newly created online contribution page. */ function webtestAddContributionPage($hash = NULL, $rand = NULL, @@ -1110,8 +1142,9 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * Function to update default strict rule. * * @params string $contactType Contact type - * @param array $fields Fields to be set for strict rule - * @param Integer $threshold Rule's threshold value + * @param string $contactType + * @param array $fields Fields to be set for strict rule + * @param Integer $threshold Rule's threshold value */ function webtestStrictDedupeRuleDefault($contactType = 'Individual', $fields = array(), $threshold = 10) { // set default strict rule. @@ -1874,7 +1907,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { $this->clickAt("//*[@class='select2-results']/li[1]/div"); } else { - if ($xpath) + if ($xpath) $this->clickAt($fieldName); else $this->clickAt("//*[@id='$fieldName']/../div/a"); diff --git a/tests/phpunit/CiviTest/CiviTestSuite.php b/tests/phpunit/CiviTest/CiviTestSuite.php index e6ad143302..8cfc8a1c0e 100644 --- a/tests/phpunit/CiviTest/CiviTestSuite.php +++ b/tests/phpunit/CiviTest/CiviTestSuite.php @@ -101,8 +101,12 @@ class CiviTestSuite extends PHPUnit_Framework_TestSuite { /** * Add all test classes *Test and all test suites *Tests in subdirectories * - * @param &object Test suite object to add tests to - * @param object Directory to scan + * @param PHPUnit_Framework_TestSuite $suite + * @param $myfile + * @param SplFileInfo $dirInfo + * + * @internal param $ &object Test suite object to add tests to + * @internal param \Directory $object to scan * @return Test suite has been updated */ protected function addAllTests(PHPUnit_Framework_TestSuite & $suite, diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index a93f34f8f2..1dbec53565 100644 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -667,8 +667,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * check that api returned 'is_error' => 1 * else provide full message + * * @param array $apiResult api result * @param string $prefix extra test to add to message + * @param null $expectedError */ function assertAPIFailure($apiResult, $prefix = '', $expectedError = NULL) { if (!empty($prefix)) { @@ -696,8 +698,11 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * check that api returned 'is_error' => 1 * else provide full message - * @param array $apiResult api result + * @param $result + * @param $expected + * @param array $valuesToExclude * @param string $prefix extra test to add to message + * @internal param array $apiResult api result */ function assertAPIArrayComparison($result, $expected, $valuesToExclude = array(), $prefix = '') { $valuesToExclude = array_merge($valuesToExclude, array('debug', 'xdebug', 'sequential')); @@ -821,13 +826,17 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } return $result; } + /** * This function exists to wrap api getValue function & check the result * so we can ensure they succeed & throw exceptions without litterering the test with checks * There is a type check in this * @param string $entity * @param array $params - * @param string $type - per http://php.net/manual/en/function.gettype.php possible types + * @param null $count + * @throws Exception + * @return array|int + * @internal param string $type - per http://php.net/manual/en/function.gettype.php possible types * - boolean * - integer * - double @@ -878,6 +887,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * @param string $action * @param array $params * @param string $expectedErrorMessage error + * @param null $extraOutput + * @return array|int */ function callAPIFailure($entity, $action, $params, $expectedErrorMessage = NULL, $extraOutput = NULL) { if (is_array($params)) { @@ -1045,7 +1056,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to delete Membership Type * - * @param int $membershipTypeID + * @param $params + * @internal param int $membershipTypeID */ function membershipTypeDelete($params) { $result = $this->callAPISuccess('MembershipType', 'Delete', $params); @@ -1178,6 +1190,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create contribution page * + * @param $params * @return object of contribution page */ function contributionPageCreate($params) { @@ -1199,6 +1212,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create Tag * + * @param array $params * @return array result of created tag */ function tagCreate($params = array()) { @@ -1270,7 +1284,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to delete contribution * - * @param int $contributionId + * @param $pledgeId + * @internal param int $contributionId */ function pledgeDelete($pledgeId) { $params = array( @@ -1282,9 +1297,13 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create contribution * - * @param int $cID contact_id - * @param int $cTypeID id of financial type + * @param int $cID contact_id + * @param int $cTypeID id of financial type * + * @param int $invoiceID + * @param int $trxnID + * @param int $paymentInstrumentID + * @param bool $isFee * @return int id of created contribution */ function contributionCreate($cID, $cTypeID = 1, $invoiceID = 67890, $trxnID = 12345, $paymentInstrumentID = 1, $isFee = TRUE) { @@ -1315,8 +1334,11 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create online contribution * - * @param int $financialType id of financial type + * @param $params + * @param int $financialType id of financial type * + * @param int $invoiceID + * @param int $trxnID * @return int id of created contribution */ function onlineContributionCreate($params, $financialType, $invoiceID = 67890, $trxnID = 12345) { @@ -1415,6 +1437,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create participant payment * + * @param $participantID + * @param null $contributionID * @return int $id of created payment */ function participantPaymentCreate($participantID, $contributionID = NULL) { @@ -1443,6 +1467,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to add a Location * + * @param $contactID * @return int location id of created location */ function locationAdd($contactID) { @@ -1482,6 +1507,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to add a Location Type * + * @param null $params * @return int location id of created location */ function locationTypeCreate($params = NULL) { @@ -1519,8 +1545,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * * @params array to add group * + * @param array $params * @return int groupId of created group - * */ function groupCreate($params = array()) { $params = array_merge(array( @@ -1543,7 +1569,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to delete a Group * - * @param int $id + * @param $gid + * @internal param int $id */ function groupDelete($gid) { @@ -1572,9 +1599,11 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { ), $params); $this->callAPISuccess('uf_field', 'create', $params); } + /** * Function to add a UF Join Entry * + * @param null $params * @return int $id of created UF Join */ function ufjoinCreate($params = NULL) { @@ -1629,7 +1658,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to delete Group for a contact * - * @param array $params + * @param $contactId + * @internal param array $params */ function contactGroupDelete($contactId) { $params = array( @@ -1642,7 +1672,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create Activity * - * @param int $contactId + * @param null $params + * @return array|int + * @internal param int $contactId */ function activityCreate($params = NULL) { @@ -1705,8 +1737,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create custom group * - * @param string $className - * @param string $title name of custom group + * @param array $params + * @return array|int + * @internal param string $className + * @internal param string $title name of custom group */ function customGroupCreate($params = array()) { $defaults = array( @@ -1784,10 +1818,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * participant:testCreateWithCustom for how to use this * * @param string $function __FUNCTION__ - * @param string $file __FILE__ + * @param $filename + * @internal param string $file __FILE__ * * @return array $ids ids of created objects - * */ function entityCustomGroupWithSingleFieldCreate($function, $filename) { $params = array('title' => $function); @@ -1814,8 +1848,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * Function to create custom field * * @param array $params (custom_group_id) is required - * @param string $name name of custom field - * @param int $apiversion API version to use + * @return array|int + * @internal param string $name name of custom field + * @internal param int $apiversion API version to use */ function customFieldCreate($params) { $params = array_merge(array( @@ -1853,6 +1888,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * * @params array $params name-value pair for an event * + * @param $cId * @return array $note */ function noteCreate($cId) { @@ -1995,7 +2031,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Tidy up examples array so that fields that change often ..don't * and debug related fields are unset - * @param array $params + * + * @param $result + * + * @internal param array $params */ function tidyExampleResult(&$result){ if(!is_array($result)) { @@ -2330,7 +2369,8 @@ AND ( TABLE_NAME LIKE 'civicrm_value_%' ) /** * Generate a temporary folder * - * @return $string + * @param string $prefix + * @return string $string */ function createTempDir($prefix = 'test-') { $tempDir = CRM_Utils_File::tempdir($prefix); diff --git a/tests/phpunit/CiviTest/Contact.php b/tests/phpunit/CiviTest/Contact.php index 40b26c9250..3ace84dd97 100644 --- a/tests/phpunit/CiviTest/Contact.php +++ b/tests/phpunit/CiviTest/Contact.php @@ -4,7 +4,9 @@ class Contact extends CiviUnitTestCase { * Helper function to create * a contact * - * @return $contactID id of created contact + * @param $params + * + * @return int $contactID id of created contact */ static function create($params) { require_once "CRM/Contact/BAO/Contact.php"; @@ -16,7 +18,8 @@ class Contact extends CiviUnitTestCase { * Helper function to create * a contact of type Individual * - * @return $contactID id of created Individual + * @param null $params + * @return int $contactID id of created Individual */ static function createIndividual($params = NULL) { //compose the params, when not passed @@ -37,7 +40,8 @@ class Contact extends CiviUnitTestCase { * Helper function to create * a contact of type Household * - * @return $contactID id of created Household + * @param null $params + * @return mixed $contactID id of created Household */ static function createHousehold($params = NULL) { //compose the params, when not passed @@ -57,7 +61,8 @@ class Contact extends CiviUnitTestCase { * Helper function to create * a contact of type Organisation * - * @return $contactID id of created Organisation + * @param null $params + * @return mixed $contactID id of created Organisation */ static function createOrganisation($params = NULL) { //compose the params, when not passed diff --git a/tests/phpunit/CiviTest/ContributionPage.php b/tests/phpunit/CiviTest/ContributionPage.php index 54335ff8e3..cb9c0fee6a 100644 --- a/tests/phpunit/CiviTest/ContributionPage.php +++ b/tests/phpunit/CiviTest/ContributionPage.php @@ -4,7 +4,9 @@ class ContributionPage extends PHPUnit_Framework_Testcase { * Helper function to create * a Contribution Page * - * @return $contributionPage id of created Contribution Page + * @param null $id + * + * @return mixed $contributionPage id of created Contribution Page */ static function create($id = NULL) { require_once "CRM/Contribute/BAO/ContributionPage.php"; diff --git a/tests/phpunit/CiviTest/Custom.php b/tests/phpunit/CiviTest/Custom.php index cd5da954f2..2d9dbc4dab 100644 --- a/tests/phpunit/CiviTest/Custom.php +++ b/tests/phpunit/CiviTest/Custom.php @@ -4,6 +4,11 @@ class Custom extends CiviUnitTestCase { * Helper function to create Custom Group * * @deprecated - use functions on test case parent class + * + * @param $group + * @param null $extends + * @param bool $isMultiple + * * @return object of created group */ static function createGroup($group, $extends = NULL, $isMultiple = FALSE) { @@ -52,8 +57,10 @@ class Custom extends CiviUnitTestCase { /** * Helper function to create Custom Field * @deprecated use parent object create fn + * @param $params + * @param null $fields * @return object of created field - */ +*/ static function createField($params, $fields = NULL) { if (empty($params)) { $params = array( diff --git a/tests/phpunit/CiviTest/Event.php b/tests/phpunit/CiviTest/Event.php index 66f5f00dca..26631d8713 100644 --- a/tests/phpunit/CiviTest/Event.php +++ b/tests/phpunit/CiviTest/Event.php @@ -4,7 +4,9 @@ class Event extends PHPUnit_Framework_Testcase { * Helper function to create * an Event * - * @return $event id of created Event + * @param $contactId + * + * @return mixed $event id of created Event */ static function create($contactId) { require_once "CRM/Event/BAO/Event.php"; @@ -30,9 +32,9 @@ class Event extends PHPUnit_Framework_Testcase { /** * Helper function to delete an Event * - * @param int $eventID id of the event to delete + * @param $eventId + * @internal param int $eventID id of the event to delete * @return boolean true if event deleted, false otherwise - * */ static function delete($eventId) { return CRM_Event_BAO_Event::del($eventId); diff --git a/tests/phpunit/CiviTest/Participant.php b/tests/phpunit/CiviTest/Participant.php index f5f4b3a006..31bd0c6804 100644 --- a/tests/phpunit/CiviTest/Participant.php +++ b/tests/phpunit/CiviTest/Participant.php @@ -3,7 +3,10 @@ class Participant extends PHPUnit_Framework_Testcase { /** * Helper function to create a Participant * - * @return $participant id of created Participant + * @param $contactId + * @param $eventId + * + * @return mixed $participant id of created Participant */ static function create($contactId, $eventId) { $params = array( @@ -26,7 +29,8 @@ class Participant extends PHPUnit_Framework_Testcase { /** * Helper function to delete a participant * - * @param int $participantID id of the participant to delete + * @param $participantId + * @internal param int $participantID id of the participant to delete * @return boolean true if participant deleted, false otherwise */ static function delete($participantId) { diff --git a/tests/phpunit/CiviTest/PaypalPro.php b/tests/phpunit/CiviTest/PaypalPro.php index eeb2fd71f8..0721bb9891 100644 --- a/tests/phpunit/CiviTest/PaypalPro.php +++ b/tests/phpunit/CiviTest/PaypalPro.php @@ -5,8 +5,7 @@ class PaypalPro extends PHPUnit_Framework_Testcase { * Helper function to create * a payment processor of type Paypal Pro * - * @return $paymentProcessor id of created payment processor - * @todo this appears not to be working but because it doesn't extend the test class + * @return int $paymentProcessor id of created payment processor@todo this appears not to be working but because it doesn't extend the test class * callAPISuccess won't work * I have duplicated this on the main test class as a work around */ diff --git a/tests/phpunit/WebTest/Contact/InlineFieldsEditTest.php b/tests/phpunit/WebTest/Contact/InlineFieldsEditTest.php index 63565660a1..4207b4703e 100644 --- a/tests/phpunit/WebTest/Contact/InlineFieldsEditTest.php +++ b/tests/phpunit/WebTest/Contact/InlineFieldsEditTest.php @@ -218,6 +218,7 @@ class WebTest_Contact_InlineFieldsEditTest extends CiviSeleniumTestCase { * Click on an inline-edit block and wait for it to open * * @param $block string selector + * @param bool $wait */ private function openInlineForm($block, $wait = TRUE) { $this->mouseDown($block); @@ -232,7 +233,7 @@ class WebTest_Contact_InlineFieldsEditTest extends CiviSeleniumTestCase { * * @param $block string selector * @param $params array - * @param $valid str: submit behavior + * @param \str|string $valid str: submit behavior * 'error' if we are expecting a form validation error, * 're_open' (default) after saving, opens the form and validate inputs * 'keep_open' same as 're_open' but doesn't automatically cancel at the end diff --git a/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php b/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php index 777a619495..acc8a12275 100644 --- a/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php +++ b/tests/phpunit/WebTest/Export/ExportCiviSeleniumTestCase.php @@ -34,6 +34,10 @@ class ExportCiviSeleniumTestCase extends CiviSeleniumTestCase { * @params sting $fileName file name to be download. * @params string $downloadDir download dir. * + * @param $selector + * @param string $fileName + * @param string $downloadDir + * * @return string downloaded file path. */ function downloadCSV($selector, $fileName = 'CiviCRM_Contact_Search.csv', $downloadDir = '/tmp') { diff --git a/tests/phpunit/WebTest/Release/ReleaseTestCase.php b/tests/phpunit/WebTest/Release/ReleaseTestCase.php index 666c45a15f..3d83d5c5d6 100644 --- a/tests/phpunit/WebTest/Release/ReleaseTestCase.php +++ b/tests/phpunit/WebTest/Release/ReleaseTestCase.php @@ -42,9 +42,10 @@ class WebTest_Release_ReleaseTestCase extends CiviSeleniumTestCase { * ReflectionClass of the Test class and checks the constructor * of that class to decide how to set up the test. * - * @param string $name - * @param array $data - * @param string $dataName + * @param string $name + * @param array $data + * @param string $dataName + * @param array $browser */ function __construct($name = NULL, array$data = array( ), $dataName = '', array$browser = array()) { diff --git a/tools/CRM/Auction/BAO/Auction.php b/tools/CRM/Auction/BAO/Auction.php index 9a73fe7022..bf4e027176 100644 --- a/tools/CRM/Auction/BAO/Auction.php +++ b/tools/CRM/Auction/BAO/Auction.php @@ -167,6 +167,9 @@ class CRM_Auction_BAO_Auction extends CRM_Auction_DAO_Auction { * * @param $all boolean true if auctions all are required else returns current and future auctions * + * @param bool $id + * + * @return array * @static */ static diff --git a/tools/CRM/Auction/BAO/Item.php b/tools/CRM/Auction/BAO/Item.php index 742a08be5f..c02b403d5e 100644 --- a/tools/CRM/Auction/BAO/Item.php +++ b/tools/CRM/Auction/BAO/Item.php @@ -177,12 +177,13 @@ class CRM_Auction_BAO_Item extends CRM_Auction_DAO_Auction { /** * Function to check if email is enabled for a given profile * - * @param int $id profile id + * @param $profileId + * + * @internal param int $id profile id * * @return boolean * @access public * @static - * */ static function isEmailInProfile($profileId) { diff --git a/tools/CRM/Auction/Form/Auction.php b/tools/CRM/Auction/Form/Auction.php index 00d19e93a6..3bc9a202a1 100644 --- a/tools/CRM/Auction/Form/Auction.php +++ b/tools/CRM/Auction/Form/Auction.php @@ -208,9 +208,11 @@ class CRM_Auction_Form_Auction 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 * * @return true if no errors, else array of errors * @access public diff --git a/tools/CRM/Auction/Form/Item.php b/tools/CRM/Auction/Form/Item.php index 6ea156a64a..32011820e8 100644 --- a/tools/CRM/Auction/Form/Item.php +++ b/tools/CRM/Auction/Form/Item.php @@ -263,9 +263,11 @@ class CRM_Auction_Form_Item 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 * * @return true if no errors, else array of errors * @access public diff --git a/tools/CRM/Auction/Form/ItemAccount.php b/tools/CRM/Auction/Form/ItemAccount.php index 4ba0c81031..14a38394eb 100644 --- a/tools/CRM/Auction/Form/ItemAccount.php +++ b/tools/CRM/Auction/Form/ItemAccount.php @@ -172,9 +172,11 @@ class CRM_Auction_Form_ItemAccount 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 * * @return true if no errors, else array of errors * @access public diff --git a/tools/CRM/Auction/StateMachine/Item.php b/tools/CRM/Auction/StateMachine/Item.php index 7be869d4ae..923e07474f 100644 --- a/tools/CRM/Auction/StateMachine/Item.php +++ b/tools/CRM/Auction/StateMachine/Item.php @@ -44,10 +44,11 @@ class CRM_Auction_StateMachine_Item extends CRM_Core_StateMachine { /** * class constructor * - * @param object CRM_Auction_Controller - * @param int $action + * @param object $controller + * @param \const|int $action * - * @return object CRM_Contact_Import_StateMachine + * @internal param \CRM_Auction_Controller $object + * @return \CRM_Auction_StateMachine_Item CRM_Contact_Import_StateMachine */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/tools/CRM/Touchstone/PseudoConstant.php b/tools/CRM/Touchstone/PseudoConstant.php index a5f004321f..7496a51367 100644 --- a/tools/CRM/Touchstone/PseudoConstant.php +++ b/tools/CRM/Touchstone/PseudoConstant.php @@ -50,6 +50,8 @@ class CRM_Touchstone_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $id + * * @return array - array reference of all $pseudoConst values */ public static function &pseudoConst($id = NULL) { diff --git a/tools/drupal/modules/ccrm_extensionvalidation/ccrm_extensionvalidation/ccrm_extensionvalidation.version.inc b/tools/drupal/modules/ccrm_extensionvalidation/ccrm_extensionvalidation/ccrm_extensionvalidation.version.inc index a9f9fdab9b..ccc8e843d6 100644 --- a/tools/drupal/modules/ccrm_extensionvalidation/ccrm_extensionvalidation/ccrm_extensionvalidation.version.inc +++ b/tools/drupal/modules/ccrm_extensionvalidation/ccrm_extensionvalidation/ccrm_extensionvalidation.version.inc @@ -5,6 +5,8 @@ define(CCRM_EXTENSIONVALIDATION_PAD, 7); /** * Determine if a version is valid * + * @param $ver + * * @return bool */ function ccrm_extensionvalidation_version_isValid($ver) { @@ -21,6 +23,7 @@ function ccrm_extensionvalidation_version_isValid($ver) { * Normalize version, producing a code that can be correclty * sorted in SQL. * + * @param $ver * @return string */ function ccrm_extensionvalidation_version_normalize($ver) { @@ -35,6 +38,8 @@ function ccrm_extensionvalidation_version_normalize($ver) { * - Explode into numeric and alphabetic parts * - Make numerals higher than alphas (1.2.0 > 1.2.alpha) * + * @param $ver + * @param $pad * @return array of version parts */ function ccrm_extensionvalidation_version_split($ver, $pad = CCRM_EXTENSIONVALIDATION_PAD) { @@ -55,7 +60,7 @@ function ccrm_extensionvalidation_version_split($ver, $pad = CCRM_EXTENSIONVALID } else { $newCharType = 'ALPHA'; } - + // printf("ver=[%s] state=%-5s newCharType=%-5s char=[%s] parts=[%-12s] buf=[%s]\n", $ver, $state, $newCharType, $ver{$i}, implode('/', $parts), $buf); switch ($state) { case 'NEW': @@ -83,7 +88,7 @@ function ccrm_extensionvalidation_version_split($ver, $pad = CCRM_EXTENSIONVALID break; } } - + $codes = array( 'alpha' => 'pre010', 'beta' => 'pre020', diff --git a/tools/drupal/modules/extdir/extdir.pages.inc b/tools/drupal/modules/extdir/extdir.pages.inc index 05f7d00dfe..c1f3859a4a 100644 --- a/tools/drupal/modules/extdir/extdir.pages.inc +++ b/tools/drupal/modules/extdir/extdir.pages.inc @@ -230,6 +230,9 @@ class ExtdirQueryHelper { * @parm $entityAliases array($niceName => $sqlIdExpression) list of entities * which are (mentally) part of the query -- and the SQL expressions which * identify them + * @param $entityAliases + * + * @return \ExtdirQueryHelper */ function create($query, $entityAliases) { return new ExtdirQueryHelper($query, $entityAliases); diff --git a/tools/extensions/org.civicrm.multisite/multisite.php b/tools/extensions/org.civicrm.multisite/multisite.php index edae49da50..11df5c4f86 100644 --- a/tools/extensions/org.civicrm.multisite/multisite.php +++ b/tools/extensions/org.civicrm.multisite/multisite.php @@ -239,6 +239,8 @@ AND id IN "; } /** + * + * @param int $permission * * @return NULL|integer $groupID */ diff --git a/tools/extensions/org.civicrm.payment.googlecheckout/GoogleCheckout.php b/tools/extensions/org.civicrm.payment.googlecheckout/GoogleCheckout.php index d687a8c263..5dc1f62e60 100644 --- a/tools/extensions/org.civicrm.payment.googlecheckout/GoogleCheckout.php +++ b/tools/extensions/org.civicrm.payment.googlecheckout/GoogleCheckout.php @@ -60,8 +60,11 @@ class org_civicrm_payment_googlecheckout extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void - */ function __construct($mode, &$paymentProcessor) { + * @param $paymentProcessor + * + * @return \org_civicrm_payment_googlecheckout + */ + function __construct($mode, &$paymentProcessor) { $this->_mode = $mode; $this->_paymentProcessor = $paymentProcessor; $this->_processorName = ts('Google Checkout'); @@ -72,9 +75,9 @@ class org_civicrm_payment_googlecheckout extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor * @return object * @static - * */ static function &singleton($mode, &$paymentProcessor) { @@ -119,11 +122,12 @@ class org_civicrm_payment_googlecheckout extends CRM_Core_Payment { /** * Sets appropriate parameters for checking out to google * - * @param array $params name value pair of contribution datat + * @param array $params name value pair of contribution datat * + * @param $component + * @throws Exception * @return void * @access public - * */ function doTransferCheckout(&$params, $component) { $component = strtolower($component); diff --git a/tools/extensions/org.civicrm.payment.googlecheckout/GoogleIPN.php b/tools/extensions/org.civicrm.payment.googlecheckout/GoogleIPN.php index 4199e15eb0..6d67110092 100644 --- a/tools/extensions/org.civicrm.payment.googlecheckout/GoogleIPN.php +++ b/tools/extensions/org.civicrm.payment.googlecheckout/GoogleIPN.php @@ -80,7 +80,9 @@ class org_civicrm_payment_googlecheckout_GoogleIPN extends CRM_Core_Payment_Base * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \org_civicrm_payment_googlecheckout_GoogleIPN */ function __construct($mode, &$paymentProcessor) { parent::__construct(); @@ -92,11 +94,11 @@ class org_civicrm_payment_googlecheckout_GoogleIPN extends CRM_Core_Payment_Base /** * The function gets called when a new order takes place. * - * @param xml $dataRoot response send by google in xml format + * @param xml $dataRoot response send by google in xml format * @param array $privateData contains the name value pair of * + * @param $component * @return void - * */ function newOrderNotify($dataRoot, $privateData, $component) { $ids = $input = $params = array(); @@ -179,11 +181,12 @@ class org_civicrm_payment_googlecheckout_GoogleIPN extends CRM_Core_Payment_Base /** * The function gets called when the state(CHARGED, CANCELLED..) changes for an order * - * @param string $status status of the transaction send by google - * @param array $privateData contains the name value pair of + * @param string $status status of the transaction send by google + * @param $dataRoot + * @param $component + * @internal param array $privateData contains the name value pair of * * @return void - * */ function orderStateChange($status, $dataRoot, $component) { $input = $objects = $ids = array(); @@ -260,6 +263,8 @@ class org_civicrm_payment_googlecheckout_GoogleIPN extends CRM_Core_Payment_Base * * @param string $mode the mode of operation: live or test * + * @param $component + * @param $paymentProcessor * @return object * @static */ diff --git a/tools/extensions/org.civicrm.sms.clickatell/org_civicrm_sms_clickatell.php b/tools/extensions/org.civicrm.sms.clickatell/org_civicrm_sms_clickatell.php index b794c69c67..947b0f64d4 100644 --- a/tools/extensions/org.civicrm.sms.clickatell/org_civicrm_sms_clickatell.php +++ b/tools/extensions/org.civicrm.sms.clickatell/org_civicrm_sms_clickatell.php @@ -109,7 +109,10 @@ class org_civicrm_sms_clickatell extends CRM_SMS_Provider { * * Create and auth a Clickatell session. * - * @return void + * @param array $provider + * @param bool $skipAuth + * + * @return \org_civicrm_sms_clickatell */ function __construct($provider = array( ), $skipAuth = FALSE) { // initialize vars @@ -146,9 +149,10 @@ class org_civicrm_sms_clickatell extends CRM_SMS_Provider { /** * singleton function used to manage this object * + * @param array $providerParams + * @param bool $force * @return object * @static - * */ static function &singleton($providerParams = array( ), $force = FALSE) { @@ -219,7 +223,12 @@ class org_civicrm_sms_clickatell extends CRM_SMS_Provider { /** * Send an SMS Message via the Clickatell API Server * - * @param array the message with a to/from/text + * @param $recipients + * @param $header + * @param $message + * @param null $jobID + * @param null $userID + * @internal param \the $array message with a to/from/text * * @return mixed true on sucess or PEAR_Error object * @access public diff --git a/tools/sites/latest/stable.php b/tools/sites/latest/stable.php index 4c8384e1c9..67517ebfa5 100644 --- a/tools/sites/latest/stable.php +++ b/tools/sites/latest/stable.php @@ -63,7 +63,7 @@ function process_get_request() { // Save to entities table $entities = array( 'Activity', 'Case', 'Contact', 'Contribution', 'ContributionPage', - 'ContributionProduct', 'Discount', 'Event', 'Friend', 'Grant', 'Mailing', 'Membership', + 'ContributionProduct', 'Discount', 'Event', 'Friend', 'Grant', 'Mailing', 'Membership', 'MembershipBlock', 'Participant', 'Pledge', 'PledgeBlock', 'PriceSetEntity', 'Relationship', 'UFGroup', 'Widget', ); @@ -98,8 +98,13 @@ function insert_stats() { /** * Insert the child records - * @param table: table name - * @param id: primary record id + * + * @param $table + * @param $data + * @param $id + * + * @internal param $table : table name + * @internal param $id : primary record id */ function insert_children($table, $data, $id) { global $link; -- 2.25.1