From ad37ac8ed3992e075cddfef34d562f4dc8c22247 Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Fri, 23 Oct 2015 15:16:36 +1300 Subject: [PATCH] comment fixes --- CRM/Activity/ActionMapping.php | 4 +- CRM/Activity/Tokens.php | 2 + CRM/Campaign/BAO/Survey.php | 8 +++ CRM/Case/BAO/Query.php | 4 ++ CRM/Case/ManagedEntities.php | 6 ++- CRM/Contact/ActionMapping.php | 4 +- CRM/Contact/BAO/Group.php | 2 + CRM/Contact/BAO/ProximityQuery.php | 2 +- .../Form/Search/Custom/EventAggregate.php | 8 +++ .../Custom/FullText/AbstractPartialQuery.php | 9 +++- CRM/Contact/Form/Task/Useradd.php | 4 ++ CRM/Contribute/BAO/Contribution.php | 11 ++-- CRM/Contribute/Form/AbstractEditPayment.php | 2 + CRM/Contribute/Form/Task/Invoice.php | 2 + CRM/Contribute/Info.php | 5 -- CRM/Contribute/Tokens.php | 3 ++ CRM/Core/Action.php | 4 +- CRM/Core/BAO/Address.php | 4 ++ CRM/Core/BAO/Country.php | 2 + CRM/Core/BAO/CustomField.php | 2 + CRM/Core/BAO/Dashboard.php | 5 +- CRM/Core/BAO/Email.php | 4 ++ CRM/Core/BAO/File.php | 29 ++++++++--- CRM/Core/BAO/IM.php | 4 ++ CRM/Core/BAO/Job.php | 3 ++ CRM/Core/BAO/Location.php | 23 ++++++--- CRM/Core/BAO/MessageTemplate.php | 2 + CRM/Core/BAO/OpenID.php | 4 ++ CRM/Core/BAO/PrevNextCache.php | 16 +++--- CRM/Core/BAO/RecurringEntity.php | 8 ++- CRM/Core/BAO/UFField.php | 6 ++- CRM/Core/BAO/WordReplacement.php | 25 ++++++++-- CRM/Core/Config.php | 5 ++ CRM/Core/Error.php | 4 ++ CRM/Core/Form/Search.php | 7 ++- CRM/Core/Lock.php | 5 ++ CRM/Core/Menu.php | 43 ++++++++++------ CRM/Core/Payment/PayPalImpl.php | 22 +++++--- CRM/Core/Payment/eWAY.php | 18 ++++--- CRM/Core/State.php | 19 +++++-- CRM/Core/TemporaryErrorScope.php | 2 + .../QueryBuilder/IndividualUnsupervised.php | 4 ++ CRM/Dedupe/BAO/RuleGroup.php | 5 ++ CRM/Dedupe/Merger.php | 6 +++ CRM/Event/ActionMapping.php | 2 + CRM/Event/BAO/Participant.php | 7 +++ CRM/Event/Badge.php | 4 +- CRM/Event/Form/ManageEvent/Registration.php | 4 ++ CRM/Event/Import/Field.php | 5 +- CRM/Event/Selector/Search.php | 2 +- CRM/Event/Tokens.php | 2 + CRM/Financial/BAO/FinancialType.php | 11 ++-- CRM/Logging/Schema.php | 2 + CRM/Mailing/BAO/Mailing.php | 4 ++ CRM/Mailing/Event/BAO/Bounce.php | 2 + CRM/Mailing/Event/BAO/Delivered.php | 3 ++ CRM/Mailing/Event/BAO/Opened.php | 2 + CRM/Mailing/Event/BAO/TrackableURLOpen.php | 12 +++-- CRM/Mailing/Event/BAO/Unsubscribe.php | 4 +- CRM/Member/ActionMapping.php | 2 + CRM/Member/PseudoConstant.php | 4 +- CRM/Member/Tokens.php | 2 + CRM/PCP/BAO/PCP.php | 29 +++++------ CRM/Pledge/BAO/Query.php | 11 +++- CRM/Price/BAO/PriceField.php | 5 +- CRM/Price/Form/Set.php | 15 ++---- CRM/Queue/ErrorPolicy.php | 10 +++- CRM/Queue/Page/AJAX.php | 3 ++ CRM/Report/Interface.php | 17 +++---- CRM/Upgrade/Incremental/php/FourFour.php | 6 ++- CRM/Upgrade/Incremental/php/FourSix.php | 5 ++ CRM/Upgrade/Incremental/php/FourThree.php | 13 ++++- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php | 50 ++++++++++--------- CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php | 2 + .../Snapshot/V4p2/Price/DAO/SetEntity.php | 2 + CRM/Utils/SQL/Select.php | 4 +- CRM/Utils/SoapServer.php | 19 +++++-- CRM/Utils/System.php | 11 ++++ CRM/Utils/System/Base.php | 2 +- CRM/Utils/System/DrupalBase.php | 4 ++ CRM/Utils/System/Joomla.php | 2 + CRM/Utils/System/WordPress.php | 8 ++- .../phpunit/WebTest/Campaign/MailingTest.php | 7 ++- 83 files changed, 479 insertions(+), 177 deletions(-) diff --git a/CRM/Activity/ActionMapping.php b/CRM/Activity/ActionMapping.php index d3d4afc077..f095b71c9d 100644 --- a/CRM/Activity/ActionMapping.php +++ b/CRM/Activity/ActionMapping.php @@ -90,9 +90,11 @@ class CRM_Activity_ActionMapping extends \Civi\ActionSchedule\Mapping { * The schedule as configured by the administrator. * @param string $phase * See, e.g., RecipientBuilder::PHASE_RELATION_FIRST. + * + * @param array $defaultParams + * * @return \CRM_Utils_SQL_Select * @see RecipientBuilder - * @throws \CRM_Core_Exception */ public function createQuery($schedule, $phase, $defaultParams) { $selectedValues = (array) \CRM_Utils_Array::explodePadded($schedule->entity_value); diff --git a/CRM/Activity/Tokens.php b/CRM/Activity/Tokens.php index f925223529..1e7207ea61 100644 --- a/CRM/Activity/Tokens.php +++ b/CRM/Activity/Tokens.php @@ -91,10 +91,12 @@ class CRM_Activity_Tokens extends \Civi\Token\AbstractTokenSubscriber { * * @param \Civi\Token\TokenRow $row * The record for which we want token values. + * @param string $entity * @param string $field * The name of the token field. * @param mixed $prefetch * Any data that was returned by the prefetch(). + * * @return mixed */ public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) { diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index a7097e7041..0ec174d5df 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -107,6 +107,10 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { /** * Retrieve surveys for dashboard. * + * @param array $params + * @param bool $onlyCount + * + * @return array|int */ public static function getSurveySummary($params = array(), $onlyCount = FALSE) { //build the limit and order clause. @@ -860,6 +864,10 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a /** * Retrieve survey associated profile id. + * + * @param int $surveyId + * + * @return mixed|null */ public static function getSurveyProfileId($surveyId) { if (!$surveyId) { diff --git a/CRM/Case/BAO/Query.php b/CRM/Case/BAO/Query.php index c1cf3599f9..64a592d27b 100644 --- a/CRM/Case/BAO/Query.php +++ b/CRM/Case/BAO/Query.php @@ -625,6 +625,10 @@ case_relation_type.id = case_relationship.relationship_type_id )"; /** * This includes any extra fields that might need for export etc. + * + * @param string $mode + * + * @return array|null */ public static function extraReturnProperties($mode) { $properties = NULL; diff --git a/CRM/Case/ManagedEntities.php b/CRM/Case/ManagedEntities.php index e89ab51bfa..daeebe989b 100644 --- a/CRM/Case/ManagedEntities.php +++ b/CRM/Case/ManagedEntities.php @@ -99,11 +99,13 @@ class CRM_Case_ManagedEntities { } /** - * Get a list of managed relationship-types by searching CiviCase XML files + * Get a list of managed relationship-types by searching CiviCase XML files. + * + * @param \CRM_Case_XMLRepository $xmlRepo + * @param \CRM_Core_ManagedEntities $me * * @return array * @see CRM_Utils_Hook::managed - * @throws CRM_Core_Exception */ public static function createManagedRelationshipTypes(CRM_Case_XMLRepository $xmlRepo, CRM_Core_ManagedEntities $me) { $result = array(); diff --git a/CRM/Contact/ActionMapping.php b/CRM/Contact/ActionMapping.php index 0fd090d310..3ba1fda819 100644 --- a/CRM/Contact/ActionMapping.php +++ b/CRM/Contact/ActionMapping.php @@ -101,9 +101,11 @@ class CRM_Contact_ActionMapping extends \Civi\ActionSchedule\Mapping { * The schedule as configured by the administrator. * @param string $phase * See, e.g., RecipientBuilder::PHASE_RELATION_FIRST. + * @param array $defaultParams + * * @return \CRM_Utils_SQL_Select - * @see RecipientBuilder * @throws \CRM_Core_Exception + * @see RecipientBuilder */ public function createQuery($schedule, $phase, $defaultParams) { $selectedValues = (array) \CRM_Utils_Array::explodePadded($schedule->entity_value); diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php index 8ee1f1cd69..1cf5d77dad 100644 --- a/CRM/Contact/BAO/Group.php +++ b/CRM/Contact/BAO/Group.php @@ -136,6 +136,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * Returns an array of the contacts in the given group. + * + * @param int $id */ public static function getGroupContacts($id) { $params = array(array('group', 'IN', array($id => 1), 0, 0)); diff --git a/CRM/Contact/BAO/ProximityQuery.php b/CRM/Contact/BAO/ProximityQuery.php index 2c146e448a..46ce6ff90d 100644 --- a/CRM/Contact/BAO/ProximityQuery.php +++ b/CRM/Contact/BAO/ProximityQuery.php @@ -95,7 +95,7 @@ class CRM_Contact_BAO_ProximityQuery { * * @param float $longitude * @param float $latitude - * @param float $height + * @param float|int $height * * @return array */ diff --git a/CRM/Contact/Form/Search/Custom/EventAggregate.php b/CRM/Contact/Form/Search/Custom/EventAggregate.php index 5a65d9ec78..cdf031766e 100644 --- a/CRM/Contact/Form/Search/Custom/EventAggregate.php +++ b/CRM/Contact/Form/Search/Custom/EventAggregate.php @@ -111,6 +111,14 @@ class CRM_Contact_Form_Search_Custom_EventAggregate 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/FullText/AbstractPartialQuery.php b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php index 5d8ac48661..c1a277149f 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php +++ b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php @@ -130,18 +130,23 @@ AND cf.html_type IN ( 'Text', 'TextArea', 'RichTextEditor' ) } } - /** + * Run queries. + * * @param string $queryText * @param array $tables * A list of places to query. Keys may be:. * - sql: an array of SQL queries to execute * - final: an array of SQL queries to execute at the end * - *: All other keys are treated as table names + * @param string $entityIDTableName + * @param int $limit + * * @return array - * keys: match-descriptor + * Keys: match-descriptor * - count: int * - files: NULL | array + * @throws \CRM_Core_Exception */ public function runQueries($queryText, &$tables, $entityIDTableName, $limit) { $sql = "TRUNCATE {$entityIDTableName}"; diff --git a/CRM/Contact/Form/Task/Useradd.php b/CRM/Contact/Form/Task/Useradd.php index 60e71357f7..88f3141735 100755 --- a/CRM/Contact/Form/Task/Useradd.php +++ b/CRM/Contact/Form/Task/Useradd.php @@ -123,6 +123,10 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form { /** * Validation Rule. + * + * @param array $params + * + * @return array|bool */ public static function usernameRule($params) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index d6e68f17e2..d50b3285bf 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -943,7 +943,10 @@ LEFT JOIN civicrm_line_item i ON ( i.contribution_id = c.id AND i.entity_table * payments is important for forensic and outreach reasons. * * @param int $contributionID + * @param int $contactID * @param string $message + * + * @throws \CiviCRM_API3_Exception */ public static function failPayment($contributionID, $contactID, $message) { civicrm_api3('activity', 'create', array( @@ -1246,7 +1249,7 @@ WHERE civicrm_contribution.contact_id = civicrm_contact.id AND b.is_test = 0 AND b.receive_date >= $startDate AND b.receive_date < $endDate - $additionalWhere + $additionalWhere GROUP BY currency "; $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray); @@ -1947,9 +1950,9 @@ LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_ $contactContributionsSQL = " SELECT contribution.id AS id FROM civicrm_contribution contribution - LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere - WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId} - $additionalWhere + LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere + WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId} + $additionalWhere AND i.id IS NULL"; $contactSoftCreditContributionsSQL = " diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php index 6c373e3271..d8bc3999c0 100644 --- a/CRM/Contribute/Form/AbstractEditPayment.php +++ b/CRM/Contribute/Form/AbstractEditPayment.php @@ -307,6 +307,8 @@ WHERE contribution_id = {$id} * @param int $statusId * @param int|null $previousStatusId * + * @param string $receiveDate + * * @return null|string */ protected function updateRelatedComponent($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) { diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php index 651286e3e5..73cb045f7d 100644 --- a/CRM/Contribute/Form/Task/Invoice.php +++ b/CRM/Contribute/Form/Task/Invoice.php @@ -634,6 +634,8 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { * @param string $html * Content for pdf in html format. * + * @param string $name + * * @return string * Name of file which is in pdf format */ diff --git a/CRM/Contribute/Info.php b/CRM/Contribute/Info.php index af448dcaa5..f479887f8e 100644 --- a/CRM/Contribute/Info.php +++ b/CRM/Contribute/Info.php @@ -79,11 +79,6 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { * @return array|null * collection of permissions, null if none */ - /** - * @param bool $getAllUnconditionally - * - * @return array|null - */ public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) { $permissions = array( 'access CiviContribute' => array( diff --git a/CRM/Contribute/Tokens.php b/CRM/Contribute/Tokens.php index 2077271635..2679f7a403 100644 --- a/CRM/Contribute/Tokens.php +++ b/CRM/Contribute/Tokens.php @@ -105,11 +105,14 @@ class CRM_Contribute_Tokens extends \Civi\Token\AbstractTokenSubscriber { * * @param \Civi\Token\TokenRow $row * The record for which we want token values. + * @param string $entity * @param string $field * The name of the token field. * @param mixed $prefetch * Any data that was returned by the prefetch(). + * * @return mixed + * @throws \CRM_Core_Exception */ public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) { $actionSearchResult = $row->context['actionSearchResult']; diff --git a/CRM/Core/Action.php b/CRM/Core/Action.php index 32e2ec4334..ab1979db14 100644 --- a/CRM/Core/Action.php +++ b/CRM/Core/Action.php @@ -321,8 +321,10 @@ class CRM_Core_Action { /** * Get the mask for a permission (view, edit or null) * + * @param array $permissions + * * @return int - * the mask for the above permission + * The mask for the above permission */ public static function mask($permissions) { $mask = NULL; diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php index ff2d4cf3e6..5beb1e53ed 100644 --- a/CRM/Core/BAO/Address.php +++ b/CRM/Core/BAO/Address.php @@ -1223,6 +1223,10 @@ SELECT is_primary, /** * Call common delete function. + * + * @param int $id + * + * @return bool */ public static function del($id) { return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('Address', $id); diff --git a/CRM/Core/BAO/Country.php b/CRM/Core/BAO/Country.php index b375dd190c..0b0bc21de0 100644 --- a/CRM/Core/BAO/Country.php +++ b/CRM/Core/BAO/Country.php @@ -130,6 +130,8 @@ class CRM_Core_BAO_Country extends CRM_Core_DAO_Country { /** * Provide cached default currency symbol. * + * @param string $defaultCurrency + * * @return string */ public static function defaultCurrencySymbol($defaultCurrency = NULL) { diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index 419c829a5e..ef356a9b7e 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -1436,6 +1436,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param int $fileID * @param bool $absolute * + * @param string $multiRecordWhereClause + * * @return array */ public static function getFileURL($contactID, $cfID, $fileID = NULL, $absolute = FALSE, $multiRecordWhereClause = NULL) { diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php index 353ac87e21..e42bf80bfa 100644 --- a/CRM/Core/BAO/Dashboard.php +++ b/CRM/Core/BAO/Dashboard.php @@ -150,8 +150,11 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * When a user accesses their dashboard for the first time, set up * the default dashlets. * + * @param bool $flatFormat + * * @return array - * Array of dashboard_id's + * Array of dashboard_id's + * @throws \CiviCRM_API3_Exception */ public static function initializeDashlets($flatFormat = FALSE) { $dashlets = array(); diff --git a/CRM/Core/BAO/Email.php b/CRM/Core/BAO/Email.php index c0ff7949b3..0226f588ed 100644 --- a/CRM/Core/BAO/Email.php +++ b/CRM/Core/BAO/Email.php @@ -325,6 +325,10 @@ AND reset_date IS NULL /** * Call common delete function. + * + * @param int $id + * + * @return bool */ public static function del($id) { return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('Email', $id); diff --git a/CRM/Core/BAO/File.php b/CRM/Core/BAO/File.php index d467cf0c0c..c9456b3231 100644 --- a/CRM/Core/BAO/File.php +++ b/CRM/Core/BAO/File.php @@ -173,8 +173,15 @@ class CRM_Core_BAO_File extends CRM_Core_DAO_File { } /** - * A static function wrapper that deletes the various objects that are - * connected to a file object (i.e. file, entityFile and customValue + * A static function wrapper that deletes the various objects. + * + * Objects are those hat are connected to a file object (i.e. file, entityFile and customValue. + * + * @param int $fileID + * @param int $entityID + * @param int $fieldID + * + * @throws \Exception */ public static function deleteFileReferences($fileID, $entityID, $fieldID) { $fileDAO = new CRM_Core_DAO_File(); @@ -218,8 +225,13 @@ class CRM_Core_BAO_File extends CRM_Core_DAO_File { * } */ /** - * Delete all the files and associated object associated with this - * combination + * Delete all the files and associated object associated with this combination. + * + * @param string $entityTable + * @param int $entityID + * @param int $fileTypeID + * @param int $fileID + * * @return bool * Was file deleted? */ @@ -277,8 +289,13 @@ class CRM_Core_BAO_File extends CRM_Core_DAO_File { } /** - * Get all the files and associated object associated with this - * combination + * Get all the files and associated object associated with this combination. + * + * @param string $entityTable + * @param int $entityID + * @param bool $addDeleteArgs + * + * @return array|null */ public static function getEntityFile($entityTable, $entityID, $addDeleteArgs = FALSE) { if (empty($entityTable) || !$entityID) { diff --git a/CRM/Core/BAO/IM.php b/CRM/Core/BAO/IM.php index 55c51f2c16..30e8a58b97 100644 --- a/CRM/Core/BAO/IM.php +++ b/CRM/Core/BAO/IM.php @@ -165,6 +165,10 @@ ORDER BY cim.is_primary DESC, im_id ASC "; /** * Call common delete function. + * + * @param int $id + * + * @return bool */ public static function del($id) { return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('IM', $id); diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php index 5888854db6..cf3583b5b3 100644 --- a/CRM/Core/BAO/Job.php +++ b/CRM/Core/BAO/Job.php @@ -126,6 +126,9 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { * Trim job table on a regular basis to keep it at a good size. * * CRM-10513 + * + * @param int $maxEntriesToKeep + * @param int $minDaysToKeep */ public static function cleanup($maxEntriesToKeep = 1000, $minDaysToKeep = 30) { // Prevent the job log from getting too big diff --git a/CRM/Core/BAO/Location.php b/CRM/Core/BAO/Location.php index 9451db3e40..f527f9b6b4 100644 --- a/CRM/Core/BAO/Location.php +++ b/CRM/Core/BAO/Location.php @@ -94,6 +94,11 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO { /** * Creates the entry in the civicrm_loc_block. + * + * @param string $location + * @param array $entityElements + * + * @return int */ public static function createLocBlock(&$location, &$entityElements) { $locId = self::findExisting($entityElements); @@ -132,6 +137,10 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO { /** * Takes an entity array and finds the existing location block. + * + * @param array $entityElements + * + * @return int */ public static function findExisting($entityElements) { $eid = $entityElements['entity_id']; @@ -155,8 +164,8 @@ WHERE e.id = %1"; * @param array $params * (reference ) an assoc array of name/value pairs. * - * @return object - * CRM_Core_BAO_locBlock object on success, null otherwise + * @return CRM_Core_BAO_locBlock + * Object on success, null otherwise */ public static function addLocBlock(&$params) { $locBlock = new CRM_Core_DAO_LocBlock(); @@ -228,7 +237,9 @@ WHERE e.id = %1"; } /** - * @param $entityBlock + * Get values. + * + * @param array $entityBlock * @param bool $microformat * * @return array @@ -341,12 +352,10 @@ WHERE e.id = %1"; } /** - * If contact has data for any location block, make sure - * contact should have only one primary block, CRM-5051 + * Make sure contact should have only one primary block, CRM-5051. * * @param int $contactId * Contact id. - * */ public static function checkPrimaryBlocks($contactId) { if (!$contactId) { @@ -388,6 +397,8 @@ WHERE e.id = %1"; } /** + * Get chain select values (whatever that means!). + * * @param mixed $values * @param string $valueType * @param bool $flatten diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php index 95d7d73047..ee6b7a9c99 100644 --- a/CRM/Core/BAO/MessageTemplate.php +++ b/CRM/Core/BAO/MessageTemplate.php @@ -125,6 +125,8 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { * * @param bool $all * + * @param bool $isSMS + * * @return object */ public static function getMessageTemplates($all = TRUE, $isSMS = FALSE) { diff --git a/CRM/Core/BAO/OpenID.php b/CRM/Core/BAO/OpenID.php index bfd6d4f065..a3f4abb688 100644 --- a/CRM/Core/BAO/OpenID.php +++ b/CRM/Core/BAO/OpenID.php @@ -143,6 +143,10 @@ ORDER BY /** * Call common delete function. + * + * @param int $id + * + * @return bool */ public static function del($id) { return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('OpenID', $id); diff --git a/CRM/Core/BAO/PrevNextCache.php b/CRM/Core/BAO/PrevNextCache.php index 2c4077cc6c..17d42affdf 100644 --- a/CRM/Core/BAO/PrevNextCache.php +++ b/CRM/Core/BAO/PrevNextCache.php @@ -164,10 +164,10 @@ WHERE cacheKey = %3 AND return FALSE; } - $sql = "SELECT pn.* + $sql = "SELECT pn.* FROM civicrm_prevnext_cache pn - WHERE - ((pn.entity_id1 = %1 AND pn.entity_id2 = %2) OR (pn.entity_id1 = %2 AND pn.entity_id2 = %1)) AND + WHERE + ((pn.entity_id1 = %1 AND pn.entity_id2 = %2) OR (pn.entity_id1 = %2 AND pn.entity_id2 = %1)) AND (cacheKey = %3 OR cacheKey = %4)"; $params = array( 1 => array($id1, 'Integer'), @@ -196,12 +196,16 @@ WHERE cacheKey = %3 AND } /** - * @param $cacheKey - * @param NULL $join - * @param NULL $where + * Retrieve from prev-next cache. + * + * @param string $cacheKey + * @param string $join + * @param string $where * @param int $offset * @param int $rowCount * + * @param array $select + * * @return array */ public static function retrieve($cacheKey, $join = NULL, $where = NULL, $offset = 0, $rowCount = 0, $select = array()) { diff --git a/CRM/Core/BAO/RecurringEntity.php b/CRM/Core/BAO/RecurringEntity.php index 0b43da189c..3c51e3d332 100644 --- a/CRM/Core/BAO/RecurringEntity.php +++ b/CRM/Core/BAO/RecurringEntity.php @@ -812,15 +812,17 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { } /** - * This function deletes main entity and related linked entities from recurring-entity table + * This function deletes main entity and related linked entities from recurring-entity table. * * @param int $entityId * Entity id * @param string $entityTable * Name of the entity table * + * @param bool $isDelLinkedEntities * - * @return bool|CRM_Core_DAO_RecurringEntity + * @return bool|\CRM_Core_DAO_RecurringEntity + * @throws \Exception */ static public function delEntity($entityId, $entityTable, $isDelLinkedEntities = FALSE) { if (empty($entityId) || empty($entityTable)) { @@ -1143,6 +1145,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * Event id . * @param string $linkedEntityTable * Linked entity table name for this event . + * @param string $mainEntityTable + * * @return array */ public static function updateModeLinkedEntity($entityId, $linkedEntityTable, $mainEntityTable) { diff --git a/CRM/Core/BAO/UFField.php b/CRM/Core/BAO/UFField.php index 11fc22453b..d8190c4d17 100644 --- a/CRM/Core/BAO/UFField.php +++ b/CRM/Core/BAO/UFField.php @@ -146,7 +146,11 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { } /** - * Does profile consists of a multi-record custom field + * Does profile consists of a multi-record custom field. + * + * @param int $gId + * + * @return bool */ public static function checkMultiRecordFieldExists($gId) { $queryString = "SELECT f.field_name diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index cddb1c78c0..bbe3da3d88 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ /** @@ -56,7 +55,7 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { * @param array $defaults * (reference ) an assoc array to hold the flattened values. * - * @return CRM_Core_DAO_WordRepalcement + * @return CRM_Core_DAO_WordReplacement */ public static function retrieve(&$params, &$defaults) { return CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_WordRepalcement', $params, $defaults); @@ -283,6 +282,8 @@ WHERE domain_id = %1 * Get WordReplacements for a locale. * * @param string $locale + * @param int $domainId + * * @return array * List of word replacements (enabled/disabled) for the given locale. */ @@ -294,6 +295,13 @@ WHERE domain_id = %1 return CRM_Utils_Array::value($locale, self::_getLocaleCustomStrings($domainId)); } + /** + * Get custom locale strings. + * + * @param int $domainId + * + * @return array|mixed + */ private static function _getLocaleCustomStrings($domainId) { // TODO: Would it be worthwhile using memcache here? $domain = CRM_Core_DAO::executeQuery('SELECT locale_custom_strings FROM civicrm_domain WHERE id = %1', array( @@ -304,6 +312,13 @@ WHERE domain_id = %1 } } + /** + * Set locale strings. + * + * @param string $locale + * @param array $values + * @param int $domainId + */ public static function setLocaleCustomStrings($locale, $values, $domainId = NULL) { if ($domainId === NULL) { $domainId = CRM_Core_Config::domainID(); @@ -316,8 +331,10 @@ WHERE domain_id = %1 } /** - * @param $domainId - * @param $lcs + * Set locale strings. + * + * @param int $domainId + * @param string $lcs */ private static function _setLocaleCustomStrings($domainId, $lcs) { CRM_Core_DAO::executeQuery("UPDATE civicrm_domain SET locale_custom_strings = %1 WHERE id = %2", array( diff --git a/CRM/Core/Config.php b/CRM/Core/Config.php index f6aaf031d1..460e011c08 100644 --- a/CRM/Core/Config.php +++ b/CRM/Core/Config.php @@ -218,6 +218,11 @@ class CRM_Core_Config extends CRM_Core_Config_MagicMerge { /** * One function to get domain ID. + * + * @param int $domainID + * @param bool $reset + * + * @return int|null */ public static function domainID($domainID = NULL, $reset = FALSE) { static $domain; diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index 3a3a2b3fb8..82b0c8d7fb 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -598,6 +598,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * Append to the query log (if enabled) + * + * @param string $string */ public static function debug_query($string) { if (defined('CIVICRM_DEBUG_LOG_QUERY')) { @@ -942,6 +944,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * Terminate execution abnormally. + * + * @param string $code */ protected static function abend($code) { // do a hard rollback of any pending transactions diff --git a/CRM/Core/Form/Search.php b/CRM/Core/Form/Search.php index 78b28418cb..5c445965db 100644 --- a/CRM/Core/Form/Search.php +++ b/CRM/Core/Form/Search.php @@ -127,6 +127,8 @@ class CRM_Core_Form_Search extends CRM_Core_Form { /** * Add checkboxes for each row plus a master checkbox. + * + * @param array $rows */ public function addRowSelectors($rows) { $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('class' => 'select-rows')); @@ -140,8 +142,9 @@ class CRM_Core_Form_Search extends CRM_Core_Form { } /** - * Add actions menu to search results form - * @param $tasks + * Add actions menu to search results form. + * + * @param array $tasks */ public function addTaskMenu($tasks) { if (is_array($tasks) && !empty($tasks)) { diff --git a/CRM/Core/Lock.php b/CRM/Core/Lock.php index 56d680fec1..2f37b2dbad 100644 --- a/CRM/Core/Lock.php +++ b/CRM/Core/Lock.php @@ -135,7 +135,12 @@ class CRM_Core_Lock implements \Civi\Core\Lock\LockInterface { } /** + * Acquire lock. + * + * @param int $timeout + * * @return bool + * @throws \CRM_Core_Exception */ public function acquire($timeout = NULL) { if (!$this->_hasLock) { diff --git a/CRM/Core/Menu.php b/CRM/Core/Menu.php index 14f6185280..ff45aeebb3 100644 --- a/CRM/Core/Menu.php +++ b/CRM/Core/Menu.php @@ -30,14 +30,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ require_once 'CRM/Core/I18n.php'; /** - * Class CRM_Core_Menu + * Class CRM_Core_Menu. */ class CRM_Core_Menu { @@ -69,7 +67,7 @@ class CRM_Core_Menu { /** * This function fetches the menu items from xml and xmlMenu hooks. * - * @param boolean $fetchFromXML + * @param bool $fetchFromXML * Fetch the menu items from xml and not from cache. * * @return array @@ -102,8 +100,10 @@ class CRM_Core_Menu { } /** + * Read menu. + * * @param string $name - * @param $menu + * @param string $menu * * @throws Exception */ @@ -164,7 +164,7 @@ class CRM_Core_Menu { /** * This function defines information for various menu items. * - * @param boolen $fetchFromXML + * @param bool $fetchFromXML * Fetch the menu items from xml and not from cache. * * @return array @@ -174,7 +174,9 @@ class CRM_Core_Menu { } /** - * @param $values + * Is array true (whatever that means!). + * + * @param array $values * * @return bool */ @@ -188,8 +190,10 @@ class CRM_Core_Menu { } /** - * @param $menu - * @param $path + * Fill menu values. + * + * @param array $menu + * @param string $path * * @throws Exception */ @@ -263,6 +267,7 @@ class CRM_Core_Menu { /** * This function recomputes menu from xml and populates civicrm_menu. + * * @param bool $truncate */ public static function store($truncate = TRUE) { @@ -302,7 +307,9 @@ class CRM_Core_Menu { } /** - * @param $menu + * Build admin links. + * + * @param array $menu */ public static function buildAdminLinks(&$menu) { $values = array(); @@ -326,11 +333,12 @@ class CRM_Core_Menu { ) ), 'url' => CRM_Utils_System::url($path, $query, - FALSE, // absolute - NULL, // fragment - TRUE, // htmlize - FALSE, // frontend - TRUE // forceBackend; CRM-14439 work-around; acceptable for now because we don't display breadcrumbs on frontend + FALSE, + NULL, + TRUE, + FALSE, + // forceBackend; CRM-14439 work-around; acceptable for now because we don't display breadcrumbs on frontend + TRUE ), 'icon' => CRM_Utils_Array::value('icon', $item), 'extra' => CRM_Utils_Array::value('extra', $item), @@ -353,6 +361,8 @@ class CRM_Core_Menu { } /** + * Get navigation. + * * @param bool $all * * @return mixed @@ -465,6 +475,8 @@ class CRM_Core_Menu { } /** + * Get admin links. + * * @return null */ public static function &getAdminLinks() { @@ -490,7 +502,6 @@ class CRM_Core_Menu { * * @return array * The breadcrumb for this path - * */ public static function buildBreadcrumb(&$menu, $path) { $crumbs = array(); diff --git a/CRM/Core/Payment/PayPalImpl.php b/CRM/Core/Payment/PayPalImpl.php index 826f81bfb2..d54614a1f2 100644 --- a/CRM/Core/Payment/PayPalImpl.php +++ b/CRM/Core/Payment/PayPalImpl.php @@ -947,10 +947,17 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { } /** - * Hash_call: Function to perform the API call to PayPal using API signature + * Hash_call: Function to perform the API call to PayPal using API signature. + * * @methodName is name of API method. * @nvpStr is nvp string. - * returns an associtive array containing the response from the server. + * returns an associative array containing the response from the server. + * + * @param array $args + * @param null $url + * + * @return array|object + * @throws \Exception */ public function invokeAPI($args, $url = NULL) { @@ -1022,10 +1029,13 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { } /** - * This function will take NVPString and convert it to an Associative Array and it will decode the response. - * It is useful to search for a particular key and displaying arrays. - * @nvpstr is NVPString. - * @nvpArray is Associative Array. + * This function will take NVPString and convert it to an Associative Array. + * + * It will decode the response. It is useful to search for a particular key and displaying arrays. + * + * @param string $str + * + * @return array */ public static function deformat($str) { $result = array(); diff --git a/CRM/Core/Payment/eWAY.php b/CRM/Core/Payment/eWAY.php index 61d12180d4..37582a5b5c 100644 --- a/CRM/Core/Payment/eWAY.php +++ b/CRM/Core/Payment/eWAY.php @@ -125,10 +125,12 @@ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { } /** - * ******************************************************* - * This function sends request and receives response from - * eWAY payment process - * ******************************************************* + * Sends request and receive response from eWAY payment process. + * + * @param array $params + * + * @return array|object + * @throws \Exception */ public function doDirectPayment(&$params) { if (CRM_Utils_Array::value('is_recur', $params) == TRUE) { @@ -409,9 +411,11 @@ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { // end function doDirectPayment /** - * ********************************************************************************************** - * This function checks the eWAY response status - returning a boolean false if status != 'true' - * ************************************************************************************************ + * Checks the eWAY response status - returning a boolean false if status != 'true'. + * + * @param object $response + * + * @return bool */ public function isError(&$response) { $status = $response->Status(); diff --git a/CRM/Core/State.php b/CRM/Core/State.php index 6b01490281..78a5de4917 100644 --- a/CRM/Core/State.php +++ b/CRM/Core/State.php @@ -104,7 +104,9 @@ class CRM_Core_State { } /** - * Given an CRM Form, jump to the previous page + * Given an CRM Form, jump to the previous page. + * + * @param CRM_Core_Page $page * * @return mixed * does a jump to the back state @@ -120,10 +122,12 @@ class CRM_Core_State { } /** - * Given an CRM Form, jump to the next page + * Given an CRM Form, jump to the next page. + * + * @param CRM_Core_Page $page * * @return mixed - * does a jump to the nextstate + * Does a jump to the nextstate */ public function handleNextState(&$page) { if ($this->_type & self::FINISH) { @@ -136,8 +140,9 @@ class CRM_Core_State { } /** - * Determine the name of the next state. This is useful when we want - * to display the navigation labels or potential path + * Determine the name of the next state. + * + * This is useful when we want to display the navigation labels or potential path. * * @return string */ @@ -153,6 +158,8 @@ class CRM_Core_State { /** * Mark this page as valid for the QFC framework. + * + * @param array $data */ public function validate(&$data) { $data['valid'][$this->_name] = TRUE; @@ -160,6 +167,8 @@ class CRM_Core_State { /** * Mark this page as invalid for the QFC framework. + * + * @param array $data */ public function invalidate(&$data) { $data['valid'][$this->_name] = NULL; diff --git a/CRM/Core/TemporaryErrorScope.php b/CRM/Core/TemporaryErrorScope.php index ec170a7b71..7f78496083 100644 --- a/CRM/Core/TemporaryErrorScope.php +++ b/CRM/Core/TemporaryErrorScope.php @@ -79,6 +79,8 @@ class CRM_Core_TemporaryErrorScope { /** * Set the active error-handler settings + * + * @param string $frame */ public static function setActive($frame) { $GLOBALS['_PEAR_default_error_mode'] = $frame['_PEAR_default_error_mode']; diff --git a/CRM/Dedupe/BAO/QueryBuilder/IndividualUnsupervised.php b/CRM/Dedupe/BAO/QueryBuilder/IndividualUnsupervised.php index 55293d8fa2..839f03510a 100644 --- a/CRM/Dedupe/BAO/QueryBuilder/IndividualUnsupervised.php +++ b/CRM/Dedupe/BAO/QueryBuilder/IndividualUnsupervised.php @@ -74,6 +74,10 @@ class CRM_Dedupe_BAO_QueryBuilder_IndividualUnsupervised extends CRM_Dedupe_BAO_ /** * An alternative version which might perform a lot better * than the above. Will need to do some testing + * + * @param string $rg + * + * @return array */ public static function internalOptimized($rg) { $sql = " diff --git a/CRM/Dedupe/BAO/RuleGroup.php b/CRM/Dedupe/BAO/RuleGroup.php index 84026f1682..ec82cfb767 100644 --- a/CRM/Dedupe/BAO/RuleGroup.php +++ b/CRM/Dedupe/BAO/RuleGroup.php @@ -412,6 +412,11 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { /** * Get all of the combinations of fields that would work with a rule. + * + * @param array $rgFields + * @param int $threshold + * @param array $combos + * @param array $running */ public static function combos($rgFields, $threshold, &$combos, $running = array()) { foreach ($rgFields as $rgField => $weight) { diff --git a/CRM/Dedupe/Merger.php b/CRM/Dedupe/Merger.php index 3b127bf8c6..5ae6f01a05 100644 --- a/CRM/Dedupe/Merger.php +++ b/CRM/Dedupe/Merger.php @@ -157,6 +157,10 @@ class CRM_Dedupe_Merger { /** * Returns the related tables groups for which a contact has any info entered. + * + * @param int $cid + * + * @return array */ public static function getActiveRelTables($cid) { $cid = (int) $cid; @@ -789,6 +793,8 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m * A 'safe' value skips the merge if there are any un-resolved conflicts. * Does a force merge otherwise (aggressive mode). * + * @param array $conflicts + * * @return bool */ public static function skipMerge($mainId, $otherId, &$migrationInfo, $mode = 'safe', &$conflicts = array()) { diff --git a/CRM/Event/ActionMapping.php b/CRM/Event/ActionMapping.php index 50e181dd72..fc4d9d8dad 100644 --- a/CRM/Event/ActionMapping.php +++ b/CRM/Event/ActionMapping.php @@ -133,6 +133,8 @@ class CRM_Event_ActionMapping extends \Civi\ActionSchedule\Mapping { * The schedule as configured by the administrator. * @param string $phase * See, e.g., RecipientBuilder::PHASE_RELATION_FIRST. + * @param array $defaultParams + * * @return \CRM_Utils_SQL_Select * @see RecipientBuilder */ diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php index 0ed1ba4f90..6e54464185 100644 --- a/CRM/Event/BAO/Participant.php +++ b/CRM/Event/BAO/Participant.php @@ -826,6 +826,13 @@ WHERE civicrm_participant.id = {$participantId} * 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 string $lookup + * @param bool $reverse + * + * @return bool */ public static function lookupValue(&$defaults, $property, $lookup, $reverse) { $id = $property . '_id'; diff --git a/CRM/Event/Badge.php b/CRM/Event/Badge.php index f9aa530148..b5bb98351e 100644 --- a/CRM/Event/Badge.php +++ b/CRM/Event/Badge.php @@ -184,11 +184,9 @@ class CRM_Event_Badge { } /** - * Create labels (pdf) + * Create labels (pdf). * * @param array $participants - * - * @return; */ public function createLabels(&$participants) { diff --git a/CRM/Event/Form/ManageEvent/Registration.php b/CRM/Event/Form/ManageEvent/Registration.php index f4c2d941b4..39e910cd2f 100644 --- a/CRM/Event/Form/ManageEvent/Registration.php +++ b/CRM/Event/Form/ManageEvent/Registration.php @@ -771,6 +771,10 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Add additional profiles from the form to an array of profile ids. + * + * @param array $profileIds + * @param array $values + * @param string $field */ public static function addMultipleProfiles(&$profileIds, $values, $field) { if ($multipleProfiles = CRM_Utils_Array::value($field, $values)) { diff --git a/CRM/Event/Import/Field.php b/CRM/Event/Import/Field.php index cedb0aaebc..d22095108b 100644 --- a/CRM/Event/Import/Field.php +++ b/CRM/Event/Import/Field.php @@ -90,8 +90,9 @@ class CRM_Event_Import_Field { } /** - * The value is in string format. convert the value to the type of this field - * and set the field value with the appropriate type + * Convert the value to the type of this field and set the field value with the appropriate type. + * + * @param string $value */ public function setValue($value) { $this->_value = $value; diff --git a/CRM/Event/Selector/Search.php b/CRM/Event/Selector/Search.php index 34e310b467..bfa2eb5a13 100644 --- a/CRM/Event/Selector/Search.php +++ b/CRM/Event/Selector/Search.php @@ -274,7 +274,7 @@ class CRM_Event_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/Event/Tokens.php b/CRM/Event/Tokens.php index d208b67787..63fa6ed34d 100644 --- a/CRM/Event/Tokens.php +++ b/CRM/Event/Tokens.php @@ -89,10 +89,12 @@ LEFT JOIN civicrm_phone phone ON phone.id = lb.phone_id * * @param \Civi\Token\TokenRow $row * The record for which we want token values. + * @param string $entity * @param string $field * The name of the token field. * @param mixed $prefetch * Any data that was returned by the prefetch(). + * * @return mixed */ public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) { diff --git a/CRM/Financial/BAO/FinancialType.php b/CRM/Financial/BAO/FinancialType.php index 47492863dd..4c3c5ce833 100644 --- a/CRM/Financial/BAO/FinancialType.php +++ b/CRM/Financial/BAO/FinancialType.php @@ -207,11 +207,12 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { } /** - * adding permissions for financial types - * + * Add permissions for financial types. * * @param array $permissions - * an array of permissions + * @param array $descriptions + * + * @return bool */ public static function permissionedFinancialTypes(&$permissions, $descriptions) { if (!self::isACLFinancialTypeStatus()) { @@ -249,7 +250,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { * * @param array $financialTypes * (reference ) an array of financial types - * @param string $action + * @param int|string $action * the type of action, can be add, view, edit, delete * @param bool $resetCache * load values from static cache @@ -288,7 +289,7 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { * * @param array $membershipTypes * (reference ) an array of membership types - * @param string $action + * @param int|string $action * the type of action, can be add, view, edit, delete * * @return array diff --git a/CRM/Logging/Schema.php b/CRM/Logging/Schema.php index 17c6c41c87..b36635eef5 100644 --- a/CRM/Logging/Schema.php +++ b/CRM/Logging/Schema.php @@ -187,6 +187,8 @@ AND TABLE_NAME LIKE 'log_civicrm_%' /** * Drop triggers for all logged tables. + * + * @param string $tableName */ public function dropTriggers($tableName = NULL) { $dao = new CRM_Core_DAO(); diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index aeff5dd80f..44f4bee041 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -606,6 +606,10 @@ ORDER BY i.contact_id, i.{$tempColumn} /** * Returns the regex patterns that are used for preparing the text and html templates. + * + * @param bool $onlyHrefs + * + * @return array|string */ private function getPatterns($onlyHrefs = FALSE) { diff --git a/CRM/Mailing/Event/BAO/Bounce.php b/CRM/Mailing/Event/BAO/Bounce.php index 1f3cedc2d4..ab51735211 100755 --- a/CRM/Mailing/Event/BAO/Bounce.php +++ b/CRM/Mailing/Event/BAO/Bounce.php @@ -130,6 +130,8 @@ class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce { * @param bool $is_distinct * Group by queue ID?. * + * @param string|null $toDate + * * @return int * Number of rows in result set */ diff --git a/CRM/Mailing/Event/BAO/Delivered.php b/CRM/Mailing/Event/BAO/Delivered.php index fa1f708922..8aed89cdaa 100755 --- a/CRM/Mailing/Event/BAO/Delivered.php +++ b/CRM/Mailing/Event/BAO/Delivered.php @@ -85,6 +85,7 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { * Optional ID of a job to filter on. * @param bool $is_distinct * Group by queue ID?. + * @param string $toDate * * @return int * Number of rows in result set @@ -151,6 +152,8 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered { * @param array $sort * Sort array. * + * @param int $is_test + * * @return array * Result set */ diff --git a/CRM/Mailing/Event/BAO/Opened.php b/CRM/Mailing/Event/BAO/Opened.php index 2d42a67726..3ebbaa72f3 100755 --- a/CRM/Mailing/Event/BAO/Opened.php +++ b/CRM/Mailing/Event/BAO/Opened.php @@ -73,6 +73,8 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened { * @param bool $is_distinct * Group by queue ID?. * + * @param string $toDate + * * @return int * Number of rows in result set */ diff --git a/CRM/Mailing/Event/BAO/TrackableURLOpen.php b/CRM/Mailing/Event/BAO/TrackableURLOpen.php index 871214831b..8eecbd668d 100755 --- a/CRM/Mailing/Event/BAO/TrackableURLOpen.php +++ b/CRM/Mailing/Event/BAO/TrackableURLOpen.php @@ -40,8 +40,9 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track } /** - * Track a click-through and return the URL to redirect. If the numbers - * don't match up, return the base url. + * Track a click-through and return the URL to redirect. + * + * If the numbers don't match up, return the base url. * * @param int $queue_id * The Queue Event ID of the clicker. @@ -104,6 +105,8 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track * @param int $url_id * Optional ID of a url to filter on. * + * @param string $toDate + * * @return int * Number of rows in result set */ @@ -157,10 +160,11 @@ class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_Track } /** + * Get tracked url count for each mailing for a given set of mailing IDs. + * * CRM-12814 - * Get tracked url count for each mailing for a given set of mailing IDs * - * @param $mailingIDs + * @param array $mailingIDs * * @return array * trackable url count per mailing ID diff --git a/CRM/Mailing/Event/BAO/Unsubscribe.php b/CRM/Mailing/Event/BAO/Unsubscribe.php index e80199b78e..ae97c496d2 100755 --- a/CRM/Mailing/Event/BAO/Unsubscribe.php +++ b/CRM/Mailing/Event/BAO/Unsubscribe.php @@ -421,7 +421,9 @@ WHERE email = %2 * @param bool $is_distinct * Group by queue ID?. * - * @param null $org_unsubscribe + * @param string $org_unsubscribe + * + * @param string $toDate * * @return int * Number of rows in result set diff --git a/CRM/Member/ActionMapping.php b/CRM/Member/ActionMapping.php index e22082c4d6..c089105dbe 100644 --- a/CRM/Member/ActionMapping.php +++ b/CRM/Member/ActionMapping.php @@ -71,6 +71,8 @@ class CRM_Member_ActionMapping extends \Civi\ActionSchedule\Mapping { * The schedule as configured by the administrator. * @param string $phase * See, e.g., RecipientBuilder::PHASE_RELATION_FIRST. + * @param array $defaultParams + * * @return \CRM_Utils_SQL_Select * @see RecipientBuilder */ diff --git a/CRM/Member/PseudoConstant.php b/CRM/Member/PseudoConstant.php index 1cc4ce40d1..d16e0c7cae 100644 --- a/CRM/Member/PseudoConstant.php +++ b/CRM/Member/PseudoConstant.php @@ -89,8 +89,10 @@ class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { * @param string $column * @param bool $force * + * @param bool $allStatus + * * @return array - * array reference of all membership statuss if any + * array reference of all membership statuses if any */ public static function &membershipStatus($id = NULL, $cond = NULL, $column = 'name', $force = FALSE, $allStatus = FALSE) { if (self::$membershipStatus === NULL) { diff --git a/CRM/Member/Tokens.php b/CRM/Member/Tokens.php index 6249760f75..e17c4ca380 100644 --- a/CRM/Member/Tokens.php +++ b/CRM/Member/Tokens.php @@ -76,10 +76,12 @@ class CRM_Member_Tokens extends \Civi\Token\AbstractTokenSubscriber { * * @param \Civi\Token\TokenRow $row * The record for which we want token values. + * @param string $entity * @param string $field * The name of the token field. * @param mixed $prefetch * Any data that was returned by the prefetch(). + * * @return mixed */ public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) { diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index 4c387888fc..286ef4f0dd 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP { @@ -42,6 +40,7 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP { static $_pcpLinks = NULL; /** + * Class constructor. */ public function __construct() { parent::__construct(); @@ -55,7 +54,6 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP { * @param bool $pcpBlock * If true, create or update PCPBlock, else PCP. * - * * @return object */ public static function add(&$params, $pcpBlock = TRUE) { @@ -231,9 +229,8 @@ ORDER BY target_entity_type, target_entity_id * @param array $pcpId * Contains the pcp ID. * - * - * @return total - * amount + * @return float + * Total amount */ public static function thermoMeter($pcpId) { $query = " @@ -248,12 +245,11 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Show the amount, nickname on honor roll + * Show the amount, nickname on honor roll. * * @param array $pcpId * Contains the pcp ID. * - * * @return array */ public static function honorRoll($pcpId) { @@ -348,7 +344,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Delete the campaign page. * - * @param int + * @param int $id * Campaign page id. */ public static function deleteById($id) { @@ -371,8 +367,6 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; * * @param CRM_Core_Form $form * Form object. - * - * @return void */ public static function buildPCPForm($form) { $form->addElement('checkbox', 'pcp_active', ts('Enable Personal Campaign Pages?'), NULL, array('onclick' => "return showHideByValue('pcp_active',true,'pcpFields','block','radio',false);")); @@ -479,8 +473,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; * Process a PCP contribution. * * @param int $pcpId - * @param $component - * @param $entity + * @param string $component + * @param string $entity * * @return array */ @@ -583,7 +577,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; * @param int $id * Campaign page id. * - * @param $is_active + * @param bool $is_active */ public static function setIsActive($id, $is_active) { switch ($is_active) { @@ -618,7 +612,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Send notfication email to supporter + * Send notification email to supporter. + * * 1. when their PCP status is changed by site admin. * 2. when supporter initially creates a Personal Campaign Page ($isInitial set to true). * @@ -717,12 +712,12 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } /** - * Enable / Disable the campaign page + * Enable / Disable the campaign page. * * @param int $id * Campaign page id. * - * @param $is_active + * @param bool $is_active * @return null */ public static function setDisable($id, $is_active) { diff --git a/CRM/Pledge/BAO/Query.php b/CRM/Pledge/BAO/Query.php index 67a570e95d..d9af00c1a4 100644 --- a/CRM/Pledge/BAO/Query.php +++ b/CRM/Pledge/BAO/Query.php @@ -364,9 +364,11 @@ class CRM_Pledge_BAO_Query { } /** + * From clause. + * * @param string $name - * @param $mode - * @param $side + * @param string $mode + * @param string $side * * @return null|string */ @@ -415,6 +417,11 @@ class CRM_Pledge_BAO_Query { /** * Ideally this function should include fields that are displayed in the selector. + * + * @param int $mode + * @param bool $includeCustomFields + * + * @return array|null */ public static function defaultReturnProperties( $mode, diff --git a/CRM/Price/BAO/PriceField.php b/CRM/Price/BAO/PriceField.php index b5571f82cd..b49793d884 100644 --- a/CRM/Price/BAO/PriceField.php +++ b/CRM/Price/BAO/PriceField.php @@ -794,9 +794,10 @@ WHERE id IN (" . implode(',', array_keys($priceFields)) . ')'; * @param string $displayOpt * Tax display setting option. * - * @return string - * tax label for custom field + * @param string $taxTerm * + * @return string + * Tax label for custom field. */ public static function getTaxLabel($opt, $valueFieldName, $displayOpt, $taxTerm) { if ($displayOpt == 'Do_not_show') { diff --git a/CRM/Price/Form/Set.php b/CRM/Price/Form/Set.php index 81dcba4653..9e278f6c41 100644 --- a/CRM/Price/Form/Set.php +++ b/CRM/Price/Form/Set.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form to process actions on Price Sets + * Form to process actions on Price Sets. */ class CRM_Price_Form_Set extends CRM_Core_Form { @@ -47,8 +45,6 @@ class CRM_Price_Form_Set extends CRM_Core_Form { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { // current set id @@ -111,8 +107,6 @@ class CRM_Price_Form_Set extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->applyFilter('__ALL__', 'trim'); @@ -239,8 +233,9 @@ class CRM_Price_Form_Set extends CRM_Core_Form { } /** - * Set default values for the form. Note that in edit/view mode - * the default values are retrieved from the database + * Set default values for the form. Note that in edit/view mode. + * + * The default values are retrieved from the database. * * @return array * array of default values @@ -262,8 +257,6 @@ class CRM_Price_Form_Set extends CRM_Core_Form { /** * Process the form. - * - * @return void */ public function postProcess() { // get the submitted form values. diff --git a/CRM/Queue/ErrorPolicy.php b/CRM/Queue/ErrorPolicy.php index da2e296668..9e3cee1bfc 100644 --- a/CRM/Queue/ErrorPolicy.php +++ b/CRM/Queue/ErrorPolicy.php @@ -113,9 +113,17 @@ class CRM_Queue_ErrorPolicy { } /** - * Receive (semi) recoverable error notices + * Receive (semi) recoverable error notices. * * @see set_error_handler + * + * @param string $errno + * @param string $errstr + * @param string $errfile + * @param int $errline + * + * @return bool + * @throws \Exception */ public function onError($errno, $errstr, $errfile, $errline) { if (!(error_reporting() & $errno)) { diff --git a/CRM/Queue/Page/AJAX.php b/CRM/Queue/Page/AJAX.php index 9d3f0cc018..6f37e38e7d 100644 --- a/CRM/Queue/Page/AJAX.php +++ b/CRM/Queue/Page/AJAX.php @@ -104,6 +104,9 @@ class CRM_Queue_Page_AJAX { /** * Performing any view-layer filtering on result and send to client. + * + * @param string $op + * @param array $result */ public static function _return($op, $result) { if ($result['is_error']) { diff --git a/CRM/Report/Interface.php b/CRM/Report/Interface.php index eb3532de10..d10c0eddf5 100644 --- a/CRM/Report/Interface.php +++ b/CRM/Report/Interface.php @@ -29,21 +29,20 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ interface CRM_Report_Interface { /** * The constructor gets the submitted form values. * - * @param $formValues + * @param array $formValues */ public function __construct(&$formValues); /** * Builds the quickform for this search. - * @param $form + * + * @param CRM_Core_Form $form */ public function buildForm(&$form); @@ -55,13 +54,13 @@ interface CRM_Report_Interface { */ /** - * Count of records that match the current input parameters - * Used by pager + * Count of records that match the current input parameters Used by pager. */ public function count(); /** - * Summary information for the query that can be displayed in the template + * Summary information for the query that can be displayed in the template. + * * This is useful to pass total / sub total information if needed */ public function summary(); @@ -76,8 +75,6 @@ interface CRM_Report_Interface { * @param int $offset * @param int $rowcount * @param string $sort - * - * @return */ public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL); @@ -88,8 +85,6 @@ interface CRM_Report_Interface { * @param int $rowcount * @param string $sort * @param bool $includeContactIDs - * - * @return */ public function all( $offset = 0, $rowcount = 0, $sort = NULL, diff --git a/CRM/Upgrade/Incremental/php/FourFour.php b/CRM/Upgrade/Incremental/php/FourFour.php index 080a15ece4..59bbbb296c 100644 --- a/CRM/Upgrade/Incremental/php/FourFour.php +++ b/CRM/Upgrade/Incremental/php/FourFour.php @@ -695,11 +695,13 @@ CREATE TABLE IF NOT EXISTS `civicrm_word_replacement` ( } /** - * Syntatic sugar for adding a task which (a) is in this class and (b) has - * a high priority. + * Syntactic sugar for adding a task which (a) is 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/FourSix.php b/CRM/Upgrade/Incremental/php/FourSix.php index 2c1f3113b2..8e5f2f9e17 100644 --- a/CRM/Upgrade/Incremental/php/FourSix.php +++ b/CRM/Upgrade/Incremental/php/FourSix.php @@ -180,6 +180,11 @@ class CRM_Upgrade_Incremental_php_FourSix extends CRM_Upgrade_Incremental_Base { * Queue Task Callback for CRM-16846 * * Run a sql file without resetting locale to that version + * + * @param \CRM_Queue_TaskContext $ctx + * @param string $rev + * + * @return bool */ public static function task_4_6_x_runOnlySql(CRM_Queue_TaskContext $ctx, $rev) { $upgrade = new CRM_Upgrade_Form(); diff --git a/CRM/Upgrade/Incremental/php/FourThree.php b/CRM/Upgrade/Incremental/php/FourThree.php index f506978967..4252800659 100644 --- a/CRM/Upgrade/Incremental/php/FourThree.php +++ b/CRM/Upgrade/Incremental/php/FourThree.php @@ -938,8 +938,13 @@ ALTER TABLE civicrm_financial_account } /** - * Read creation and modification times from civicrm_log; add - * them to civicrm_contact. + * Read creation and modification times from civicrm_log; add them to civicrm_contact. + * + * @param \CRM_Queue_TaskContext $ctx + * @param int $startId + * @param int $endId + * + * @return bool */ public function convertTimestamps(CRM_Queue_TaskContext $ctx, $startId, $endId) { $sql = " @@ -1072,6 +1077,10 @@ id IN (' . implode(',', $val) . ')'; /** * Update financial_account_id for bad data in financial_trxn table. * CRM-12844 + * + * @param \CRM_Queue_TaskContext $ctx + * + * @return bool */ public function updateLineItemData(CRM_Queue_TaskContext $ctx) { $sql = "SELECT cc.id contribution_id, cc.contribution_recur_id, diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php index b053763d84..7dfdd90ef1 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Business object for managing price sets - * + * Business object for managing price sets. */ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set { @@ -93,14 +90,12 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ } /** - * Calculate the default price set id. - * assigned to the contribution/membership etc + * Calculate the default price set id assigned to the contribution/membership etc. * * @param string $entity * * @return int * priceSetID - * */ public static function getDefaultPriceSet($entity = 'contribution') { if ($entity == 'contribution') { @@ -138,7 +133,6 @@ WHERE ps.name = '{$entityName}' * * @return string * title - * */ public static function getTitle($id) { return CRM_Core_DAO::getFieldValue('CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set', $id, 'title'); @@ -255,7 +249,6 @@ WHERE ct.id = cp.contribution_type_id AND * @return bool * false if fields exist for this set, true if the * set could be deleted - * */ public static function deleteSet($id) { // remove from all inactive forms @@ -330,7 +323,8 @@ WHERE ct.id = cp.contribution_type_id AND } /** - * Find a price_set_id associatied with the given table, id and usedFor + * Find a price_set_id associated with the given details. + * * Used For value for events:1, contribution:2, membership:3 * * @param string $entityTable @@ -550,6 +544,8 @@ WHERE id = %1"; } /** + * Initialise set. + * * @param CRM_Core_Form $form * @param int $id * @param string $entityTable @@ -651,9 +647,11 @@ WHERE id = %1"; } /** - * @param $fields + * Process amount. + * + * @param array $fields * @param array $params - * @param $lineItem + * @param array $lineItem */ public static function processAmount(&$fields, &$params, &$lineItem) { // using price set @@ -839,12 +837,16 @@ WHERE id = %1"; } /** - * check the current Membership - * having end date null. + * Check the current Membership. + * + * @param array $options + * @param int $userid + * + * @return bool */ public static function checkCurrentMembership(&$options, $userid) { if (!$userid || empty($options)) { - return; + return FALSE; } static $_contact_memberships = array(); $checklifetime = FALSE; @@ -869,10 +871,10 @@ WHERE id = %1"; } /** - * Set daefult the price set fields. + * Set default the price set fields. * * @param CRM_Core_Form $form - * @param $defaults + * @param array $defaults * * @return array */ @@ -903,7 +905,6 @@ WHERE id = %1"; * * @return array * Array of the field ids - * */ public static function getFieldIds($id) { $priceField = new CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field(); @@ -916,7 +917,7 @@ WHERE id = %1"; } /** - * Copy a price set, including all the fields + * Copy a price set, including all the fields. * * @param int $id * The price set id to copy. @@ -963,7 +964,7 @@ WHERE id = %1"; } /** - * check price set permission. + * Check price set permission. * * @param int $sid * The price set id. @@ -983,8 +984,7 @@ WHERE id = %1"; } /** - * Get the sum of participant count. - * for all fields of given price set. + * Get the sum of participant count for all fields of given price set. * * @param int $sid * The price set id. @@ -1022,7 +1022,9 @@ INNER JOIN civicrm_price_set pset ON ( pset.id = field.price_set_id ) } /** - * @param $ids + * Get membership count. + * + * @param array $ids * * @return array */ @@ -1116,6 +1118,8 @@ GROUP BY mt.member_of_contact_id"; } /** + * Get event price set for domain. + * * @return object */ public static function eventPriceSetDomainID() { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php index 37def5446d..3a169ccae5 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php @@ -306,6 +306,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO { /** * returns the list of fields that can be exported. * + * @param bool $prefix + * * @return array */ static function &export($prefix = FALSE) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php index f7cfc5c969..e4b6eaee98 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php @@ -207,6 +207,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO { /** * returns the list of fields that can be exported. * + * @param bool $prefix + * * @return array */ static function &export($prefix = FALSE) { diff --git a/CRM/Utils/SQL/Select.php b/CRM/Utils/SQL/Select.php index 322dac6f1a..70c9f32fc8 100644 --- a/CRM/Utils/SQL/Select.php +++ b/CRM/Utils/SQL/Select.php @@ -421,9 +421,9 @@ class CRM_Utils_SQL_Select implements ArrayAccess { * * PHP NULL's will be treated as SQL NULL's. The PHP string "null" will be treated as a string. * - * @throws CRM_Core_Exception + * @param string $activeMode + * * @return string - * SQL expression */ public function interpolate($expr, $args, $activeMode = self::INTERPOLATE_INPUT) { if ($args === NULL) { diff --git a/CRM/Utils/SoapServer.php b/CRM/Utils/SoapServer.php index 15b528b246..ee3f10990f 100644 --- a/CRM/Utils/SoapServer.php +++ b/CRM/Utils/SoapServer.php @@ -137,6 +137,15 @@ class CRM_Utils_SoapServer { /** * MAILER API. + * + * @param string $key + * @param int $job + * @param int $queue + * @param string $hash + * @param string $body + * + * @return array|int + * @throws \SoapFault */ public function mailer_event_bounce($key, $job, $queue, $hash, $body) { $this->verify($key); @@ -152,10 +161,12 @@ class CRM_Utils_SoapServer { } /** - * @param $key - * @param $job - * @param $queue - * @param $hash + * Mailer event unsubscribe. + * + * @param string $key + * @param int $job + * @param int $queue + * @param string $hash * * @return array|int * @throws SoapFault diff --git a/CRM/Utils/System.php b/CRM/Utils/System.php index 18d00fb6bc..a19f229f4b 100644 --- a/CRM/Utils/System.php +++ b/CRM/Utils/System.php @@ -510,6 +510,12 @@ class CRM_Utils_System { } /** + * Authenticate or abort. + * + * @param string $message + * @param bool $abort + * + * @return bool */ public static function authenticateAbort($message, $abort) { if ($abort) { @@ -753,6 +759,11 @@ class CRM_Utils_System { /** * Get a setting from a loaded PHP module. + * + * @param string $pModuleName + * @param string $pSetting + * + * @return mixed */ public static function getModuleSetting($pModuleName, $pSetting) { $vModules = self::parsePHPModules(); diff --git a/CRM/Utils/System/Base.php b/CRM/Utils/System/Base.php index 54e6299503..6e3adf9b00 100644 --- a/CRM/Utils/System/Base.php +++ b/CRM/Utils/System/Base.php @@ -877,7 +877,7 @@ abstract class CRM_Utils_System_Base { /** * Log error to CMS. * - * $param string $message + * @param string $message */ public function logger($message) { } diff --git a/CRM/Utils/System/DrupalBase.php b/CRM/Utils/System/DrupalBase.php index 3fb5d8effa..ed9ea9099a 100644 --- a/CRM/Utils/System/DrupalBase.php +++ b/CRM/Utils/System/DrupalBase.php @@ -497,6 +497,10 @@ abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base { /** * Fixme: Why are we overriding the parent function? Seems inconsistent. * This version supplies slightly different params to $this->url (not absolute and html encoded) but why? + * + * @param string $action + * + * @return string */ public function postURL($action) { if (!empty($action)) { diff --git a/CRM/Utils/System/Joomla.php b/CRM/Utils/System/Joomla.php index 03ca3fe485..8e6917e23b 100644 --- a/CRM/Utils/System/Joomla.php +++ b/CRM/Utils/System/Joomla.php @@ -716,6 +716,8 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { /** * Append Joomla js to coreResourcesList. + * + * @param array $list */ public function appendCoreResources(&$list) { $list[] = 'js/crm.joomla.js'; diff --git a/CRM/Utils/System/WordPress.php b/CRM/Utils/System/WordPress.php index c5a8816a6d..3ca0033d12 100644 --- a/CRM/Utils/System/WordPress.php +++ b/CRM/Utils/System/WordPress.php @@ -623,7 +623,11 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { } /** - * FIXME: Do something + * FIXME: Do something. + * + * @param \CRM_Core_Form $form + * + * @return NULL|string */ public function getLoginDestination(&$form) { return NULL; @@ -662,6 +666,8 @@ class CRM_Utils_System_WordPress extends CRM_Utils_System_Base { /** * Append WP js to coreResourcesList. + * + * @param array $list */ public function appendCoreResources(&$list) { $list[] = 'js/crm.wordpress.js'; diff --git a/tests/phpunit/WebTest/Campaign/MailingTest.php b/tests/phpunit/WebTest/Campaign/MailingTest.php index 22388e61a0..fb1d8caffb 100644 --- a/tests/phpunit/WebTest/Campaign/MailingTest.php +++ b/tests/phpunit/WebTest/Campaign/MailingTest.php @@ -100,9 +100,12 @@ class WebTest_Campaign_MailingTest extends CiviSeleniumTestCase { } /** + * Test mailing add. + * * @param string $groupName - * @param $campaignTitle - * @param $firstUserName + * @param string $campaignTitle + * @param string $title + * @param string $firstUserName */ public function mailingAddTest($groupName, $campaignTitle, $title, $firstUserName) { //---- create mailing contact and add to mailing Group -- 2.25.1