From 5495710842acf6635053a9ec6269d11de54efb03 Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Fri, 23 Oct 2015 14:23:01 +1300 Subject: [PATCH] comment fixes --- CRM/Campaign/Selector/Search.php | 2 +- CRM/Case/XMLRepository.php | 15 +++++++++-- CRM/Contact/BAO/SavedSearch.php | 27 ++++++++++++++++--- .../Form/Search/Custom/ActivitySearch.php | 8 ++++++ .../Form/Search/Custom/TagContributions.php | 8 ++++++ CRM/Contact/Import/Parser/Contact.php | 24 ++++++++++++++++- CRM/Contact/Page/DedupeMerge.php | 10 +++++++ CRM/Contact/Selector.php | 2 +- CRM/Core/BAO/ActionSchedule.php | 7 +++-- CRM/Core/BAO/EntityTag.php | 5 ++++ CRM/Core/BAO/UFGroup.php | 5 +++- CRM/Core/Config.php | 4 +++ CRM/Core/Form.php | 12 +++++++++ CRM/Core/Form/RecurringEntity.php | 6 +++++ CRM/Core/Menu.php | 2 +- CRM/Core/Payment/AuthorizeNet.php | 6 +++++ CRM/Core/Payment/FirstData.php | 15 +++++++++-- CRM/Core/Payment/Form.php | 10 +++++-- CRM/Core/Payment/PayJunction.php | 3 ++- CRM/Core/Payment/PaymentExpressIPN.php | 13 +++++++-- CRM/Core/Permission/Base.php | 2 ++ CRM/Core/State.php | 2 ++ CRM/Dedupe/Merger.php | 10 +++++++ CRM/Event/BAO/Event.php | 4 +++ CRM/Event/BAO/Participant.php | 11 ++++++-- CRM/Event/Badge.php | 5 ++-- CRM/Event/Form/Registration/Register.php | 2 +- CRM/Event/Import/Parser/Participant.php | 8 +++--- CRM/Export/BAO/Export.php | 8 ++++++ CRM/Financial/BAO/FinancialItem.php | 8 +++--- CRM/Grant/Selector/Search.php | 2 +- CRM/Import/DataSource.php | 15 ++++++----- CRM/Import/DataSource/CSV.php | 4 +++ CRM/Import/DataSource/SQL.php | 4 +++ CRM/Mailing/BAO/Mailing.php | 17 +++++++++--- CRM/Mailing/Event/BAO/Queue.php | 6 +++-- CRM/PCP/BAO/PCP.php | 8 ++---- CRM/Profile/Selector/Listings.php | 2 +- CRM/Report/Interface.php | 20 ++++++++++++-- CRM/SMS/Provider.php | 5 ++++ CRM/Upgrade/Incremental/Base.php | 14 +++++++--- CRM/Upgrade/Incremental/php/FourThree.php | 17 +++++++++++- CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php | 4 ++- CRM/Utils/Array.php | 18 +++++++++---- CRM/Utils/Hook.php | 9 +++++++ CRM/Utils/Migrate/ExportJSON.php | 7 +++++ CRM/Utils/Number.php | 5 ++++ CRM/Utils/Pager.php | 5 ++++ CRM/Utils/ReCAPTCHA.php | 2 ++ CRM/Utils/Token.php | 6 +++++ Civi/ActionSchedule/RecipientBuilder.php | 8 +++--- Civi/Core/Resolver.php | 2 ++ Civi/Core/SettingsManager.php | 2 ++ Civi/Core/SettingsMetadata.php | 4 +++ Civi/Token/AbstractTokenSubscriber.php | 2 ++ Civi/Token/TokenRow.php | 4 +++ sql/GenerateData.php | 6 ++++- tests/phpunit/CiviTest/CiviUnitTestCase.php | 4 ++- .../phpunit/api/v3/JobProcessMailingTest.php | 3 +++ 59 files changed, 381 insertions(+), 68 deletions(-) diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php index bc9dc5e176..888ebd96e8 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -199,7 +199,7 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * Returns total number of rows for the query. * - * @param + * @param string $action * * @return int * Total number of rows diff --git a/CRM/Case/XMLRepository.php b/CRM/Case/XMLRepository.php index d8169b7359..7e3af8c479 100644 --- a/CRM/Case/XMLRepository.php +++ b/CRM/Case/XMLRepository.php @@ -64,7 +64,10 @@ class CRM_Case_XMLRepository { } /** - * @param array $xml + * Class constructor. + * + * @param array $allCaseTypes + * @param array $xml */ public function __construct($allCaseTypes = NULL, $xml = array()) { $this->allCaseTypes = $allCaseTypes; @@ -72,8 +75,12 @@ class CRM_Case_XMLRepository { } /** + * Retrieve case. + * * @param string $caseType - * @return SimpleXMLElement|FALSE + * + * @return FALSE|\SimpleXMLElement + * @throws \CRM_Core_Exception */ public function retrieve($caseType) { // check if xml definition is defined in db @@ -106,6 +113,8 @@ class CRM_Case_XMLRepository { } /** + * Retrieve file. + * * @param string $caseType * @return SimpleXMLElement|FALSE */ @@ -136,6 +145,8 @@ class CRM_Case_XMLRepository { } /** + * Find xml file. + * * @param string $caseType * @return null|string * file path diff --git a/CRM/Contact/BAO/SavedSearch.php b/CRM/Contact/BAO/SavedSearch.php index 2b910db03b..e01b41c734 100644 --- a/CRM/Contact/BAO/SavedSearch.php +++ b/CRM/Contact/BAO/SavedSearch.php @@ -83,7 +83,7 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { } /** - * Given an id, extract the formValues of the saved search + * Given an id, extract the formValues of the saved search. * * @param int $id * The id of the saved search. @@ -165,6 +165,8 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { } /** + * Get search parameters. + * * @param int $id * * @return array @@ -210,6 +212,8 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { } /** + * Contact IDS Sql (whatever that means!). + * * @param int $id * * @return string @@ -234,6 +238,8 @@ WHERE $where"; } /** + * Get from where email (whatever that means!). + * * @param int $id * * @return array @@ -266,8 +272,7 @@ LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_ } /** - * Given a saved search compute the clause and the tables - * and store it for future use + * Given a saved search compute the clause and the tables and store it for future use. */ public function buildClause() { $fv = unserialize($this->form_values); @@ -291,6 +296,11 @@ LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_ } } + /** + * Save the search. + * + * @param bool $hook + */ public function save($hook = TRUE) { // first build the computed fields $this->buildClause(); @@ -321,6 +331,10 @@ LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_ /** * Given a label and a set of normalized POST * formValues, create a smart group with that + * + * @param array $params + * + * @return \CRM_Contact_DAO_SavedSearch */ public static function create(&$params) { $savedSearch = new CRM_Contact_DAO_SavedSearch(); @@ -343,6 +357,13 @@ LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_ return $savedSearch; } + /** + * Assign test value. + * + * @param string $fieldName + * @param array $fieldDef + * @param int $counter + */ protected function assignTestValue($fieldName, &$fieldDef, $counter) { if ($fieldName == 'form_values') { // A dummy value for form_values. diff --git a/CRM/Contact/Form/Search/Custom/ActivitySearch.php b/CRM/Contact/Form/Search/Custom/ActivitySearch.php index 8bb4e81062..340c76bb46 100644 --- a/CRM/Contact/Form/Search/Custom/ActivitySearch.php +++ b/CRM/Contact/Form/Search/Custom/ActivitySearch.php @@ -156,6 +156,14 @@ class CRM_Contact_Form_Search_Custom_ActivitySearch extends CRM_Contact_Form_Sea /** * Construct the search query. + * + * @param int $offset + * @param int $rowcount + * @param null $sort + * @param bool $includeContactIDs + * @param bool $justIDs + * + * @return string */ public function all( $offset = 0, $rowcount = 0, $sort = NULL, diff --git a/CRM/Contact/Form/Search/Custom/TagContributions.php b/CRM/Contact/Form/Search/Custom/TagContributions.php index 193774f065..8263773cdf 100644 --- a/CRM/Contact/Form/Search/Custom/TagContributions.php +++ b/CRM/Contact/Form/Search/Custom/TagContributions.php @@ -94,6 +94,14 @@ class CRM_Contact_Form_Search_Custom_TagContributions extends CRM_Contact_Form_S /** * Construct the search query. + * + * @param int $offset + * @param int $rowcount + * @param string $sort + * @param bool $includeContactIDs + * @param bool $onlyIDs + * + * @return string */ public function all( $offset = 0, $rowcount = 0, $sort = NULL, diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index b3f3b8ef59..37fe638b39 100644 --- a/CRM/Contact/Import/Parser/Contact.php +++ b/CRM/Contact/Import/Parser/Contact.php @@ -99,6 +99,19 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Class constructor. + * + * @param array $mapperKeys + * @param int $mapperLocType + * @param int $mapperPhoneType + * @param int $mapperImProvider + * @param int $mapperRelated + * @param int $mapperRelatedContactType + * @param array $mapperRelatedContactDetails + * @param int $mapperRelatedContactLocType + * @param int $mapperRelatedContactPhoneType + * @param int $mapperRelatedContactImProvider + * @param int $mapperWebsiteType + * @param int $mapperRelatedContactWebsiteType */ public function __construct( &$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL, $mapperImProvider = NULL, $mapperRelated = NULL, $mapperRelatedContactType = NULL, $mapperRelatedContactDetails = NULL, $mapperRelatedContactLocType = NULL, $mapperRelatedContactPhoneType = NULL, $mapperRelatedContactImProvider = NULL, @@ -122,7 +135,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * The initializer code, called before the processing + * The initializer code, called before the processing. */ public function init() { $contactFields = CRM_Contact_BAO_Contact::importableFields($this->_contactType); @@ -1640,6 +1653,15 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Method for creating contact. + * + * @param array $formatted + * @param array $contactFields + * @param int $onDuplicate + * @param int $contactId + * @param bool $requiredCheck + * @param int $dedupeRuleGroupID + * + * @return array|bool|\CRM_Contact_BAO_Contact|\CRM_Core_Error|null */ public function createContact(&$formatted, &$contactFields, $onDuplicate, $contactId = NULL, $requiredCheck = TRUE, $dedupeRuleGroupID = NULL) { $dupeCheck = FALSE; diff --git a/CRM/Contact/Page/DedupeMerge.php b/CRM/Contact/Page/DedupeMerge.php index 27c3f5c0d1..eb0213eb12 100644 --- a/CRM/Contact/Page/DedupeMerge.php +++ b/CRM/Contact/Page/DedupeMerge.php @@ -123,6 +123,16 @@ class CRM_Contact_Page_DedupeMerge extends CRM_Core_Page { /** * Carry out batch merges. + * + * @param \CRM_Queue_TaskContext $ctx + * @param int $rgid + * @param int $gid + * @param string $mode + * @param bool $autoFlip + * @param int $batchLimit + * @param int $isSelected + * + * @return int */ public static function callBatchMerge(CRM_Queue_TaskContext $ctx, $rgid, $gid = NULL, $mode = 'safe', $autoFlip = TRUE, $batchLimit = 1, $isSelected = 2) { $result = CRM_Dedupe_Merger::batchMerge($rgid, $gid, $mode, $autoFlip, $batchLimit, $isSelected); diff --git a/CRM/Contact/Selector.php b/CRM/Contact/Selector.php index 629de94560..36d4a94f15 100644 --- a/CRM/Contact/Selector.php +++ b/CRM/Contact/Selector.php @@ -491,7 +491,7 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se /** * Returns total number of rows for the query. * - * @param + * @param int $action * * @return int * Total number of rows diff --git a/CRM/Core/BAO/ActionSchedule.php b/CRM/Core/BAO/ActionSchedule.php index 6d7c3c880d..88cf6f61a9 100755 --- a/CRM/Core/BAO/ActionSchedule.php +++ b/CRM/Core/BAO/ActionSchedule.php @@ -662,8 +662,11 @@ FROM civicrm_action_schedule cas } /** - * @param $dao - * @return string|NULL + * Pick SMS phone number. + * + * @param int $smsToContactId + * + * @return NULL|string */ protected static function pickSmsPhoneNumber($smsToContactId) { $toPhoneNumbers = CRM_Core_BAO_Phone::allPhones($smsToContactId, FALSE, 'Mobile', array( diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index 9745cb3778..f66afd0fdf 100644 --- a/CRM/Core/BAO/EntityTag.php +++ b/CRM/Core/BAO/EntityTag.php @@ -274,6 +274,11 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * Get contact tags. + * + * @param int $contactID + * @param bool $count + * + * @return array */ public static function getContactTags($contactID, $count = FALSE) { $contactTags = array(); diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index 97951229a7..016f192bd1 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -273,8 +273,11 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param string $orderBy * @param null $orderProfiles * + * @param bool $eventProfile + * * @return array - * the fields that belong to this ufgroup(s) + * The fields that belong to this ufgroup(s) + * @throws \Exception */ public static function getFields( $id, diff --git a/CRM/Core/Config.php b/CRM/Core/Config.php index e4313de4b7..f6aaf031d1 100644 --- a/CRM/Core/Config.php +++ b/CRM/Core/Config.php @@ -358,6 +358,10 @@ class CRM_Core_Config extends CRM_Core_Config_MagicMerge { /** * Check if running in upgrade mode. + * + * @param string $path + * + * @return bool */ public static function isUpgradeMode($path = NULL) { if (defined('CIVICRM_UPGRADE_ACTIVE')) { diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index 62daf32187..d36c6f1ca3 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -1550,6 +1550,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * @param array $entities * @param bool $default * //CRM-15427. + * @param string $usedFor */ public function addProfileSelector($name, $label, $allowCoreTypes, $allowSubTypes, $entities, $default = FALSE, $usedFor = NULL) { // Output widget @@ -1777,6 +1778,11 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Function that will add date and time. + * + * @param string $name + * @param string $label + * @param bool $required + * @param null $attributes */ public function addDateTime($name, $label, $required = FALSE, $attributes = NULL) { $addTime = array('addTime' => TRUE); @@ -1826,6 +1832,12 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Add currency element to the form. + * + * @param string $name + * @param null $label + * @param bool $required + * @param string $defaultCurrency + * @param bool $freezeCurrency */ public function addCurrency( $name = 'currency', diff --git a/CRM/Core/Form/RecurringEntity.php b/CRM/Core/Form/RecurringEntity.php index 45a35bb0be..7ef0ea19a7 100644 --- a/CRM/Core/Form/RecurringEntity.php +++ b/CRM/Core/Form/RecurringEntity.php @@ -326,6 +326,12 @@ class CRM_Core_Form_RecurringEntity { /** * Process the form submission. + * + * @param array $params + * @param string $type + * @param array $linkedEntities + * + * @throws \CiviCRM_API3_Exception */ public static function postProcess($params = array(), $type, $linkedEntities = array()) { //Check entity_id not present in params take it from class variable diff --git a/CRM/Core/Menu.php b/CRM/Core/Menu.php index 36641585b1..14f6185280 100644 --- a/CRM/Core/Menu.php +++ b/CRM/Core/Menu.php @@ -69,7 +69,7 @@ class CRM_Core_Menu { /** * This function fetches the menu items from xml and xmlMenu hooks. * - * @param boolen $fetchFromXML + * @param boolean $fetchFromXML * Fetch the menu items from xml and not from cache. * * @return array diff --git a/CRM/Core/Payment/AuthorizeNet.php b/CRM/Core/Payment/AuthorizeNet.php index 8336d954b6..a112cd5066 100644 --- a/CRM/Core/Payment/AuthorizeNet.php +++ b/CRM/Core/Payment/AuthorizeNet.php @@ -538,6 +538,12 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * * Function is from Authorize.Net sample code, and used to avoid using * PHP5 XML functions + * + * @param string $haystack + * @param string $start + * @param string $end + * + * @return bool|string */ public function _substring_between(&$haystack, $start, $end) { if (strpos($haystack, $start) === FALSE || strpos($haystack, $end) === FALSE) { diff --git a/CRM/Core/Payment/FirstData.php b/CRM/Core/Payment/FirstData.php index f59889a6da..b4fea7aa53 100644 --- a/CRM/Core/Payment/FirstData.php +++ b/CRM/Core/Payment/FirstData.php @@ -80,10 +80,16 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { } /** + * Map fields from params array. + * * This function is set up and put here to make the mapping of fields - * from the params object as visually clear as possible for easy editing + * as visually clear as possible for easy editing * * Comment out irrelevant fields + * + * @param array $params + * + * @return array */ public function mapProcessorFieldstoParams($params) { /*concatenate full customer name first - code from EWAY gateway @@ -142,10 +148,15 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { /** * This function sends request and receives response from * the processor + * + * @param array $params + * + * @return array|object + * @throws \Exception */ public function doDirectPayment(&$params) { if ($params['is_recur'] == TRUE) { - CRM_Core_Error::fatal(ts('%1 - recurring payments not implemented', array(1 => $paymentProcessor))); + CRM_Core_Error::fatal(ts('First Data - recurring payments not implemented')); } if (!defined('CURLOPT_SSLCERT')) { diff --git a/CRM/Core/Payment/Form.php b/CRM/Core/Payment/Form.php index 07a1e44657..410e820b6f 100644 --- a/CRM/Core/Payment/Form.php +++ b/CRM/Core/Payment/Form.php @@ -261,9 +261,15 @@ class CRM_Core_Payment_Form { } /** - * Validate the payment instrument values before passing it to the payment processor - * We want this to be overrideable by the payment processor, and default to using + * Validate the payment instrument values before passing it to the payment processor. + * + * We want this to be able to be overridden by the payment processor, and default to using * this object's validCreditCard for credit cards (implemented as the default in the Payment class). + * + * @param int $payment_processor_id + * @param array $values + * @param array $errors + * @param int $billing_profile_id */ public static function validatePaymentInstrument($payment_processor_id, $values, &$errors, $billing_profile_id) { $payment = Civi\Payment\System::singleton()->getById($payment_processor_id); diff --git a/CRM/Core/Payment/PayJunction.php b/CRM/Core/Payment/PayJunction.php index 5901fb6001..2b14306c6d 100644 --- a/CRM/Core/Payment/PayJunction.php +++ b/CRM/Core/Payment/PayJunction.php @@ -172,10 +172,11 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { } // end function doDirectPayment - /** * This function checks the PayJunction response code. * + * @param array $response + * * @return bool */ public function isError(&$response) { diff --git a/CRM/Core/Payment/PaymentExpressIPN.php b/CRM/Core/Payment/PaymentExpressIPN.php index dc6c681d05..fcac1ca7d5 100644 --- a/CRM/Core/Payment/PaymentExpressIPN.php +++ b/CRM/Core/Payment/PaymentExpressIPN.php @@ -259,11 +259,20 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { } /** - * This method is handles the response that will be invoked by the - * notification or request sent by the payment processor. + * Main notification processing method. + * * hex string from paymentexpress is passed to this function as hex string. Code based on googleIPN * mac_key is only passed if the processor is pxaccess as it is used for decryption * $dps_method is either pxaccess or pxpay + * + * @param string $dps_method + * @param array $rawPostData + * @param string $dps_url + * @param string $dps_user + * @param string $dps_key + * @param string $mac_key + * + * @throws \Exception */ public static function main($dps_method, $rawPostData, $dps_url, $dps_user, $dps_key, $mac_key) { diff --git a/CRM/Core/Permission/Base.php b/CRM/Core/Permission/Base.php index 2eb2ee258d..c687962f2e 100644 --- a/CRM/Core/Permission/Base.php +++ b/CRM/Core/Permission/Base.php @@ -253,6 +253,8 @@ class CRM_Core_Permission_Base { * Get the permissions defined in the hook_civicrm_permission implementation * in all enabled CiviCRM module extensions. * + * @param bool $descriptions + * * @return array * Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). */ diff --git a/CRM/Core/State.php b/CRM/Core/State.php index 0b385e3ffb..6b01490281 100644 --- a/CRM/Core/State.php +++ b/CRM/Core/State.php @@ -176,6 +176,8 @@ class CRM_Core_State { /** * Setter for name. + * + * @param string $name */ public function setName($name) { $this->_name = $name; diff --git a/CRM/Dedupe/Merger.php b/CRM/Dedupe/Merger.php index a138102bd3..3b127bf8c6 100644 --- a/CRM/Dedupe/Merger.php +++ b/CRM/Dedupe/Merger.php @@ -319,6 +319,12 @@ WHERE /** * Return payment update Query. + * + * @param string $tableName + * @param int $mainContactId + * @param int $otherContactId + * + * @return array */ public static function paymentSql($tableName, $mainContactId, $otherContactId) { $sqls = array(); @@ -415,6 +421,10 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m * Based on the provided two contact_ids and a set of tables, move the * belongings of the other contact to the main one. * + * @param int $mainId + * @param int $otherId + * @param bool $tables + * @param array $tableOperations */ public static function moveContactBelongings($mainId, $otherId, $tables = FALSE, $tableOperations = array()) { $cidRefs = self::cidRefs(); diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index 0e1feb7ff2..15a2869043 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -1048,6 +1048,10 @@ WHERE civicrm_event.is_active = 1 * This is sometimes called in a loop (during event search). * * We cache the values to prevent repeated calls to the db. + * + * @param int $id + * + * @return bool */ public static function usesPriceSet($id) { static $usesPriceSet = array(); diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php index ebc1ff95a8..0ed1ba4f90 100644 --- a/CRM/Event/BAO/Participant.php +++ b/CRM/Event/BAO/Participant.php @@ -2065,9 +2065,16 @@ WHERE (entity_table = 'civicrm_participant' AND entity_id = {$participantId} AND } /** - * @param $updatedAmount - * @param $paidAmount + * Record adjusted amount. + * + * @param int $updatedAmount + * @param int $paidAmount * @param int $contributionId + * + * @param int $taxAmount + * @param bool $updateAmountLevel + * + * @return bool|\CRM_Core_BAO_FinancialTrxn */ public static function recordAdjustedAmt($updatedAmount, $paidAmount, $contributionId, $taxAmount = NULL, $updateAmountLevel = NULL) { $pendingAmount = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId); diff --git a/CRM/Event/Badge.php b/CRM/Event/Badge.php index 8f5dd088ef..f9aa530148 100644 --- a/CRM/Event/Badge.php +++ b/CRM/Event/Badge.php @@ -75,12 +75,11 @@ class CRM_Event_Badge { } /** - * Create the labels (pdf) + * Create the labels (pdf). + * * It assumes the participants are from the same event * * @param array $participants - * - * @return; */ public function run(&$participants) { // fetch the 1st participant, and take her event to retrieve its attributes diff --git a/CRM/Event/Form/Registration/Register.php b/CRM/Event/Form/Registration/Register.php index 988190f01c..7dc007f0b9 100644 --- a/CRM/Event/Form/Registration/Register.php +++ b/CRM/Event/Form/Registration/Register.php @@ -1358,7 +1358,7 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { * @param bool $useDedupeRules * Force usage of dedupe rules. * - * @return void + * @return int */ public static function checkRegistration($fields, &$self, $isAdditional = FALSE, $returnContactId = FALSE, $useDedupeRules = FALSE) { // CRM-3907, skip check for preview registrations diff --git a/CRM/Event/Import/Parser/Participant.php b/CRM/Event/Import/Parser/Participant.php index 1fb233a4a6..6ce58cadb3 100644 --- a/CRM/Event/Import/Parser/Participant.php +++ b/CRM/Event/Import/Parser/Participant.php @@ -59,6 +59,10 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { /** * Class constructor. + * + * @param array $mapperKeys + * @param null $mapperLocType + * @param null $mapperPhoneType */ public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) { parent::__construct(); @@ -66,9 +70,7 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { } /** - * The initializer code, called before the processing - * - * @return void + * The initializer code, called before the processing. */ public function init() { $fields = CRM_Event_BAO_Participant::importableFields($this->_contactType, FALSE); diff --git a/CRM/Export/BAO/Export.php b/CRM/Export/BAO/Export.php index adc47cadee..44e150f172 100644 --- a/CRM/Export/BAO/Export.php +++ b/CRM/Export/BAO/Export.php @@ -1718,8 +1718,16 @@ WHERE id IN ( $deleteIDString ) /** * The function unsets static part of the string, if token is the dynamic part. + * * Example: 'Hello {contact.first_name}' => converted to => '{contact.first_name}' * i.e 'Hello Alan' => converted to => 'Alan' + * + * @param string $parsedString + * @param string $defaultGreeting + * @param bool $addressMergeGreetings + * @param string $greetingType + * + * @return mixed */ public static function _trimNonTokens( &$parsedString, $defaultGreeting, diff --git a/CRM/Financial/BAO/FinancialItem.php b/CRM/Financial/BAO/FinancialItem.php index daed659329..cf14e860d9 100644 --- a/CRM/Financial/BAO/FinancialItem.php +++ b/CRM/Financial/BAO/FinancialItem.php @@ -68,7 +68,9 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { * Contribution object. * @param bool $taxTrxnID * - * @return void + * @param int $trxnId + * + * @return CRM_Financial_DAO_FinancialItem */ public static function add($lineItem, $contribution, $taxTrxnID = FALSE, $trxnId = NULL) { $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); @@ -128,7 +130,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { } /** - * Create the financial Items and financial enity trxn. + * Create the financial Items and financial entity trxn. * * @param array $params * Associated array to create financial items. @@ -137,7 +139,7 @@ class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem { * @param array $trxnIds * Financial item ids. * - * @return object + * @return CRM_Financial_DAO_FinancialItem */ public static function create(&$params, $ids = NULL, $trxnIds = NULL) { $financialItem = new CRM_Financial_DAO_FinancialItem(); diff --git a/CRM/Grant/Selector/Search.php b/CRM/Grant/Selector/Search.php index 3546de9f06..c973e061d2 100644 --- a/CRM/Grant/Selector/Search.php +++ b/CRM/Grant/Selector/Search.php @@ -239,7 +239,7 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * Returns total number of rows for the query. * - * @param + * @param int $action * * @return int * Total number of rows diff --git a/CRM/Import/DataSource.php b/CRM/Import/DataSource.php index 3e8258b91c..4fc206855f 100644 --- a/CRM/Import/DataSource.php +++ b/CRM/Import/DataSource.php @@ -49,23 +49,26 @@ abstract class CRM_Import_DataSource { /** * Set variables up before form is built. + * + * @param CRM_Core_Form $form */ abstract public function preProcess(&$form); /** - * This is function is called by the form object to get the DataSource's - * form snippet. It should add all fields necesarry to get the data - * uploaded to the temporary table in the DB. + * This is function is called by the form object to get the DataSource's form snippet. * - * @param CRM_Core_Form $form + * It should add all fields necessary to get the data uploaded to the temporary table in the DB. * - * @return void - * (operates directly on form argument) + * @param CRM_Core_Form $form */ abstract public function buildQuickForm(&$form); /** * Process the form submission. + * + * @param array $params + * @param string $db + * @param CRM_Core_Form $form */ abstract public function postProcess(&$params, &$db, &$form); diff --git a/CRM/Import/DataSource/CSV.php b/CRM/Import/DataSource/CSV.php index 3960d1fc63..3bb3deacb9 100644 --- a/CRM/Import/DataSource/CSV.php +++ b/CRM/Import/DataSource/CSV.php @@ -82,6 +82,10 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { /** * Process the form submission. + * + * @param array $params + * @param string $db + * @param \CRM_Core_Form $form */ public function postProcess(&$params, &$db, &$form) { $file = $params['uploadFile']['name']; diff --git a/CRM/Import/DataSource/SQL.php b/CRM/Import/DataSource/SQL.php index e6b8b55880..9b91bac7ff 100644 --- a/CRM/Import/DataSource/SQL.php +++ b/CRM/Import/DataSource/SQL.php @@ -91,6 +91,10 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource { /** * Process the form submission. + * + * @param array $params + * @param string $db + * @param \CRM_Core_Form $form */ public function postProcess(&$params, &$db, &$form) { $importJob = new CRM_Contact_Import_ImportJob( diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index 4c15b92130..aeff5dd80f 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -1393,9 +1393,11 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** + * Replace tokens. * - * get mailing object and replaces subscribeInvite, - * domain and mailing tokens + * Get mailing object and replaces subscribeInvite, domain and mailing tokens. + * + * @param array $mailing */ public static function tokenReplace(&$mailing) { $domain = CRM_Core_BAO_Domain::getDomain(); @@ -1416,9 +1418,16 @@ ORDER BY civicrm_email.is_bulkmail DESC } /** + * Get data to resolve tokens. + * + * @param array $token_a + * @param bool $html + * @param array $contact + * @param string $verp + * @param array $urls + * @param int $event_queue_id * - * getTokenData receives a token from an email - * and returns the appropriate data for the token + * @return bool|mixed|null|string */ private function getTokenData(&$token_a, $html = FALSE, &$contact, &$verp, &$urls, $event_queue_id) { $type = $token_a['type']; diff --git a/CRM/Mailing/Event/BAO/Queue.php b/CRM/Mailing/Event/BAO/Queue.php index 0d356a2c71..7e0a6db2c0 100644 --- a/CRM/Mailing/Event/BAO/Queue.php +++ b/CRM/Mailing/Event/BAO/Queue.php @@ -59,7 +59,9 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { } /** - * Create a security hash from the job, email and contact ids + * Create a security hash from the job, email and contact ids. + * + * @param array $params * * @return int * The hash @@ -75,7 +77,7 @@ class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue { } /** - * Verify that a queue event exists with the specified id/job id/hash + * Verify that a queue event exists with the specified id/job id/hash. * * @param int $job_id * The job ID of the event to find. diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index 638994babe..4c387888fc 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -348,10 +348,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Delete the campaign page. * - * @param int $id + * @param int * Campaign page id. - * - * @return; */ public static function deleteById($id) { CRM_Utils_Hook::pre('delete', 'Campaign', $id, CRM_Core_DAO::$_nullArray); @@ -580,14 +578,12 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Approve / Reject the campaign page + * Approve / Reject the campaign page. * * @param int $id * Campaign page id. * * @param $is_active - * - * @return; */ public static function setIsActive($id, $is_active) { switch ($is_active) { diff --git a/CRM/Profile/Selector/Listings.php b/CRM/Profile/Selector/Listings.php index 4927be34ac..6d222c3a2c 100644 --- a/CRM/Profile/Selector/Listings.php +++ b/CRM/Profile/Selector/Listings.php @@ -384,7 +384,7 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR /** * Returns total number of rows for the query. * - * @param + * @param int $action * * @return int * Total number of rows diff --git a/CRM/Report/Interface.php b/CRM/Report/Interface.php index b1dc8523a9..eb3532de10 100644 --- a/CRM/Report/Interface.php +++ b/CRM/Report/Interface.php @@ -67,15 +67,29 @@ interface CRM_Report_Interface { public function summary(); /** + * Get contact IDs. + * * List of contact ids that match the current input parameters * Used by different tasks. Will be also used to optimize the * 'all' query below to avoid excessive LEFT JOIN blowup + * + * @param int $offset + * @param int $rowcount + * @param string $sort + * + * @return */ public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL); /** - * Retrieve all the values that match the current input parameters - * Used by the selector + * Retrieve all the values that match the current input parameters used by the selector. + * + * @param int $offset + * @param int $rowcount + * @param string $sort + * @param bool $includeContactIDs + * + * @return */ public function all( $offset = 0, $rowcount = 0, $sort = NULL, @@ -98,6 +112,8 @@ interface CRM_Report_Interface { /** * The where clause for the query. + * + * @param bool $includeContactIDs */ public function where($includeContactIDs = FALSE); diff --git a/CRM/SMS/Provider.php b/CRM/SMS/Provider.php index ce9d2788fc..4476aac705 100644 --- a/CRM/SMS/Provider.php +++ b/CRM/SMS/Provider.php @@ -88,6 +88,11 @@ abstract class CRM_SMS_Provider { /** * Send an SMS Message via the API Server. + * + * @param array $recipients + * @param string $header + * @param string $message + * @param int $dncID */ abstract public function send($recipients, $header, $message, $dncID = NULL); diff --git a/CRM/Upgrade/Incremental/Base.php b/CRM/Upgrade/Incremental/Base.php index 5b19b3b20c..858e1a5adc 100644 --- a/CRM/Upgrade/Incremental/Base.php +++ b/CRM/Upgrade/Incremental/Base.php @@ -67,9 +67,13 @@ class CRM_Upgrade_Incremental_Base { public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) { } - /** * (Queue Task Callback) + * + * @param \CRM_Queue_TaskContext $ctx + * @param string $rev + * + * @return bool */ public static function runSql(CRM_Queue_TaskContext $ctx, $rev) { $upgrade = new CRM_Upgrade_Form(); @@ -79,11 +83,15 @@ class CRM_Upgrade_Incremental_Base { } /** - * Syntactic sugar for adding a task which (a) is in this class and (b) has - * a high priority. + * Syntactic sugar for adding a task. + * + * Task is (a) in this class and (b) has a high priority. * * After passing the $funcName, you can also pass parameters that will go to * the function. Note that all params must be serializable. + * + * @param string $title + * @param string $funcName */ protected function addTask($title, $funcName) { $queue = CRM_Queue_Service::singleton()->load(array( diff --git a/CRM/Upgrade/Incremental/php/FourThree.php b/CRM/Upgrade/Incremental/php/FourThree.php index 30e5379f49..f506978967 100644 --- a/CRM/Upgrade/Incremental/php/FourThree.php +++ b/CRM/Upgrade/Incremental/php/FourThree.php @@ -971,6 +971,10 @@ ALTER TABLE civicrm_financial_account /** * Change index and add missing constraints for civicrm_contribution_recur. + * + * @param \CRM_Queue_TaskContext $ctx + * + * @return bool */ public function addMissingConstraints(CRM_Queue_TaskContext $ctx) { $query = "SHOW KEYS FROM `civicrm_contribution_recur` WHERE key_name = 'UI_contrib_payment_instrument_id'"; @@ -1002,6 +1006,10 @@ ALTER TABLE civicrm_financial_account /** * Update financial_account_id for bad data in financial_trxn table. * CRM-12844 + * + * @param \CRM_Queue_TaskContext $ctx + * + * @return bool */ public function updateFinancialTrxnData(CRM_Queue_TaskContext $ctx) { $upgrade = new CRM_Upgrade_Form(); @@ -1127,7 +1135,14 @@ AND cli.entity_table = 'civicrm_contribution' AND cli.id IN (" . implode(',', $v /** * Replace contribution_type to financial_type in table. - * civicrm_saved_search and Structure civicrm_report_instance + * + * Civicrm_saved_search and Structure civicrm_report_instance + * + * @param \CRM_Queue_TaskContext $ctx + * @param string $query + * @param string $table + * + * @return bool */ public function replaceContributionTypeId(CRM_Queue_TaskContext $ctx, $query, $table) { $dao = CRM_Core_DAO::executeQuery($query); diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php index ffcd7cdcfe..cc8167006a 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php @@ -361,7 +361,9 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { } /** - * returns the list of fields that can be exported. + * Returns the list of fields that can be exported. + * + * @param bool $prefix * * @return array */ diff --git a/CRM/Utils/Array.php b/CRM/Utils/Array.php index 57c03e1391..6ea8b5780b 100644 --- a/CRM/Utils/Array.php +++ b/CRM/Utils/Array.php @@ -132,7 +132,6 @@ class CRM_Utils_Array { * @param string $seperator * (optional) String to be appended after open/close tags. * - * * @return string * XML fragment representing $list. */ @@ -345,8 +344,11 @@ class CRM_Utils_Array { } /** - * @param $subset - * @param $superset + * Is array A a subset of array B. + * + * @param array $subset + * @param array $superset + * * @return bool * TRUE if $subset is a subset of $superset */ @@ -388,12 +390,18 @@ class CRM_Utils_Array { } /** - * convert associative array names to values. - * and vice-versa. + * Convert associative array names to values and vice-versa. * * This function is used by both the web form layer and the api. Note that * the api needs the name => value conversion, also the view layer typically * requires value => name conversion + * + * @param array $defaults + * @param string $property + * @param $lookup + * @param $reverse + * + * @return bool */ public static function lookupValue(&$defaults, $property, $lookup, $reverse) { $id = $property . '_id'; diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php index 950ec296e9..15bc0bf93b 100644 --- a/CRM/Utils/Hook.php +++ b/CRM/Utils/Hook.php @@ -1966,6 +1966,10 @@ abstract class CRM_Utils_Hook { /** * This hook is called when a query string of the CSV Batch export is generated. + * + * @param string $query + * + * @return mixed */ public static function batchQuery(&$query) { return self::singleton()->invoke(1, $query, self::$_nullObject, @@ -1976,6 +1980,11 @@ abstract class CRM_Utils_Hook { /** * This hook is called when the entries of the CSV Batch export are mapped. + * + * @param array $results + * @param array $items + * + * @return mixed */ public static function batchItems(&$results, &$items) { return self::singleton()->invoke(2, $results, $items, diff --git a/CRM/Utils/Migrate/ExportJSON.php b/CRM/Utils/Migrate/ExportJSON.php index e205cd1a57..9f07954514 100644 --- a/CRM/Utils/Migrate/ExportJSON.php +++ b/CRM/Utils/Migrate/ExportJSON.php @@ -59,6 +59,10 @@ class CRM_Utils_Migrate_ExportJSON { /** * Split a large array of contactIDs into more manageable smaller chunks. + * + * @param array $contactIDs + * + * @return array */ public function &splitContactIDs(&$contactIDs) { // contactIDs could be a real large array, so we split it up into @@ -88,6 +92,9 @@ class CRM_Utils_Migrate_ExportJSON { /** * Given a set of contact IDs get the values. + * + * @param array $contactIDs + * @param array $additionalContactIDs */ public function getValues(&$contactIDs, &$additionalContactIDs) { diff --git a/CRM/Utils/Number.php b/CRM/Utils/Number.php index d1858b3857..7eecb8cd01 100644 --- a/CRM/Utils/Number.php +++ b/CRM/Utils/Number.php @@ -79,6 +79,11 @@ class CRM_Utils_Number { /** * Some kind of numbery-looky-printy thing. + * + * @param string $size + * @param bool $checkForPostMax + * + * @return int */ public static function formatUnitSize($size, $checkForPostMax = FALSE) { if ($size) { diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php index 222222f675..7b6d3c7133 100644 --- a/CRM/Utils/Pager.php +++ b/CRM/Utils/Pager.php @@ -309,6 +309,11 @@ class CRM_Utils_Pager extends Pager_Sliding { /** * Build a url for pager links. + * + * @param string $key + * @param string $value + * + * @return string */ public function makeURL($key, $value) { $href = CRM_Utils_System::makeURL($key, TRUE); diff --git a/CRM/Utils/ReCAPTCHA.php b/CRM/Utils/ReCAPTCHA.php index 8d53f596ad..8b211d0252 100644 --- a/CRM/Utils/ReCAPTCHA.php +++ b/CRM/Utils/ReCAPTCHA.php @@ -67,6 +67,8 @@ class CRM_Utils_ReCAPTCHA { /** * Add element to form. + * + * @param CRM_Core_Form $form */ public static function add(&$form) { $error = NULL; diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php index e4eeb41fa1..2b4269e205 100644 --- a/CRM/Utils/Token.php +++ b/CRM/Utils/Token.php @@ -1412,6 +1412,12 @@ class CRM_Utils_Token { /** * Replace existing greeting tokens in message/subject. + * + * @param string $tokenString + * @param array $contactDetails + * @param int $contactId + * @param string $className + * @param bool $escapeSmarty */ public static function replaceGreetingTokens(&$tokenString, $contactDetails = NULL, $contactId = NULL, $className = NULL, $escapeSmarty = FALSE) { diff --git a/Civi/ActionSchedule/RecipientBuilder.php b/Civi/ActionSchedule/RecipientBuilder.php index d20dee60d1..fb0ade6ace 100644 --- a/Civi/ActionSchedule/RecipientBuilder.php +++ b/Civi/ActionSchedule/RecipientBuilder.php @@ -356,7 +356,8 @@ class RecipientBuilder { } /** - * @param $actionSchedule + * Parse repetition interval. + * * @return int|string */ protected function parseRepetitionInterval() { @@ -411,8 +412,9 @@ class RecipientBuilder { } /** - * @param $actionSchedule - * @param $contactTableAlias + * Prepare language filter. + * + * @param string $contactTableAlias * @return string */ protected function prepareLanguageFilter($contactTableAlias) { diff --git a/Civi/Core/Resolver.php b/Civi/Core/Resolver.php index 6bb47fab61..70654bac29 100644 --- a/Civi/Core/Resolver.php +++ b/Civi/Core/Resolver.php @@ -267,6 +267,8 @@ class ResolverGlobalCallback { /** * Invoke function. * + * @param mixed $arg1 + * * @return mixed */ public function __invoke($arg1 = NULL) { diff --git a/Civi/Core/SettingsManager.php b/Civi/Core/SettingsManager.php index fe47d5e41d..84bb6c632d 100644 --- a/Civi/Core/SettingsManager.php +++ b/Civi/Core/SettingsManager.php @@ -325,6 +325,8 @@ class SettingsManager { * during bootstrap -- in particular, defaults cannot be loaded. For a very small number of settings, * we must define defaults before the system bootstraps. * + * @param string $entity + * * @return array */ private static function getSystemDefaults($entity) { diff --git a/Civi/Core/SettingsMetadata.php b/Civi/Core/SettingsMetadata.php index 1fe89496b3..c0b3806705 100644 --- a/Civi/Core/SettingsMetadata.php +++ b/Civi/Core/SettingsMetadata.php @@ -120,6 +120,10 @@ class SettingsMetadata { /** * Load up settings metadata from files. + * + * @param array $metaDataFolder + * + * @return array */ protected static function loadSettingsMetadata($metaDataFolder) { $settingMetaData = array(); diff --git a/Civi/Token/AbstractTokenSubscriber.php b/Civi/Token/AbstractTokenSubscriber.php index 5e5472ba65..3566fdf453 100644 --- a/Civi/Token/AbstractTokenSubscriber.php +++ b/Civi/Token/AbstractTokenSubscriber.php @@ -154,6 +154,8 @@ abstract class AbstractTokenSubscriber implements EventSubscriberInterface { * To perform a bulk lookup before rendering tokens, override this * function and return the prefetched data. * + * @param \Civi\Token\Event\TokenValueEvent $e + * * @return mixed */ public function prefetch(TokenValueEvent $e) { diff --git a/Civi/Token/TokenRow.php b/Civi/Token/TokenRow.php index 4409d68a6a..d9347d0f6d 100644 --- a/Civi/Token/TokenRow.php +++ b/Civi/Token/TokenRow.php @@ -169,6 +169,10 @@ class TokenRow { /** * Auto-convert between different formats + * + * @param string $format + * + * @return $this */ public function fill($format = NULL) { if ($format === NULL) { diff --git a/sql/GenerateData.php b/sql/GenerateData.php index a11faae369..f58da8f5ce 100644 --- a/sql/GenerateData.php +++ b/sql/GenerateData.php @@ -267,7 +267,11 @@ class CRM_GCD { */ /** - * get a randomly generated string + * Get a randomly generated string. + * + * @param int $size + * + * @return string */ private function randomString($size = 32) { $string = ""; diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index 352d6d68fe..dd95ae263e 100755 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -3316,7 +3316,9 @@ AND ( TABLE_NAME LIKE 'civicrm_value_%' ) } /** - * @param $exists + * Assert the attachment exists. + * + * @param bool $exists * @param array $apiResult */ protected function assertAttachmentExistence($exists, $apiResult) { diff --git a/tests/phpunit/api/v3/JobProcessMailingTest.php b/tests/phpunit/api/v3/JobProcessMailingTest.php index 6a914d08cd..de91bcb1eb 100644 --- a/tests/phpunit/api/v3/JobProcessMailingTest.php +++ b/tests/phpunit/api/v3/JobProcessMailingTest.php @@ -273,8 +273,11 @@ class api_v3_JobProcessMailingTest extends CiviUnitTestCase { } /** + * Create contacts in group. + * * @param int $count * @param int $groupID + * @param string $domain */ public function createContactsInGroup($count, $groupID, $domain = 'nul.example.com') { for ($i = 1; $i <= $count; $i++) { -- 2.25.1