From c2b5a0afba753a54cff13b47ee51b976c4a4d159 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Wed, 4 Mar 2015 09:24:41 +1100 Subject: [PATCH] comment fixes --- CRM/Campaign/BAO/Campaign.php | 4 ++++ CRM/Campaign/Controller/Search.php | 4 ++++ CRM/Campaign/Form/Survey/Results.php | 6 ++++++ CRM/Core/Payment/Google.php | 7 +++++++ CRM/Core/Payment/Moneris.php | 5 ++++- CRM/Extension/Browser.php | 3 +++ CRM/Member/BAO/Membership.php | 4 ++-- CRM/Member/Import/Field.php | 2 ++ CRM/Member/Import/Parser/Membership.php | 6 ++++-- Civi/Core/Resolver.php | 13 ++++++++++++- 10 files changed, 48 insertions(+), 6 deletions(-) diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index 809a55f6a2..7d7c766066 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -356,6 +356,10 @@ Order By camp.title"; /** * Retrieve campaigns for dashboard. * + * @param array $params + * @param bool $onlyCount + * + * @return array|int */ public static function getCampaignSummary($params = array(), $onlyCount = FALSE) { $campaigns = array(); diff --git a/CRM/Campaign/Controller/Search.php b/CRM/Campaign/Controller/Search.php index dce86880f5..e790a7ade7 100755 --- a/CRM/Campaign/Controller/Search.php +++ b/CRM/Campaign/Controller/Search.php @@ -48,6 +48,10 @@ class CRM_Campaign_Controller_Search extends CRM_Core_Controller { /** * Class constructor. + * + * @param null $title + * @param bool|int $action + * @param bool $modal */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Campaign/Form/Survey/Results.php b/CRM/Campaign/Form/Survey/Results.php index a09fad8def..cebc910b0b 100644 --- a/CRM/Campaign/Form/Survey/Results.php +++ b/CRM/Campaign/Form/Survey/Results.php @@ -204,6 +204,12 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey { /** * Global validation rules for the form. + * + * @param $fields + * @param $files + * @param $form + * + * @return array|bool */ public static function formRule($fields, $files, $form) { $errors = array(); diff --git a/CRM/Core/Payment/Google.php b/CRM/Core/Payment/Google.php index ab28749b43..a3a34ccbad 100644 --- a/CRM/Core/Payment/Google.php +++ b/CRM/Core/Payment/Google.php @@ -285,9 +285,16 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { /** * Hash_call: Function to perform the API call to PayPal using API signature + * * @paymentProcessor is the array of payment processor settings value. * @searchParamsnvpStr is the array of search params. * returns an associtive array containing the response from the server. + * + * @param $paymentProcessor + * @param $searchParams + * + * @return array|object + * @throws \Exception */ public function invokeAPI($paymentProcessor, $searchParams) { $merchantID = $paymentProcessor['user_name']; diff --git a/CRM/Core/Payment/Moneris.php b/CRM/Core/Payment/Moneris.php index 4fad580ea4..7e0c395a57 100644 --- a/CRM/Core/Payment/Moneris.php +++ b/CRM/Core/Payment/Moneris.php @@ -53,7 +53,10 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { * * @param $paymentProcessor * - * @return \CRM_Core_Payment_Moneris + * @param null $paymentForm + * @param bool $force + * + * @throws \Exception */ public function __construct($mode, &$paymentProcessor, &$paymentForm = NULL, $force = FALSE) { $this->_mode = $mode; diff --git a/CRM/Extension/Browser.php b/CRM/Extension/Browser.php index 4d979ae9d0..b3929d49e5 100644 --- a/CRM/Extension/Browser.php +++ b/CRM/Extension/Browser.php @@ -326,6 +326,9 @@ class CRM_Extension_Browser { /** * A dummy function required for suppressing download errors. + * + * @param $errorNumber + * @param $errorString */ public static function downloadError($errorNumber, $errorString) { } diff --git a/CRM/Member/BAO/Membership.php b/CRM/Member/BAO/Membership.php index 20cc3a7f6b..80edae96ca 100644 --- a/CRM/Member/BAO/Membership.php +++ b/CRM/Member/BAO/Membership.php @@ -1303,9 +1303,9 @@ AND civicrm_membership.is_test = %2"; * @param int $defaultContributionTypeID * @param array $membershipLineItems * Line items specific to membership payment that is separate to contribution. - * @throws CRM_Core_Exception + * @param $isPayLater * - * @return void + * @throws \CRM_Core_Exception */ public static function postProcessMembership( $membershipParams, $contactID, &$form, $premiumParams, diff --git a/CRM/Member/Import/Field.php b/CRM/Member/Import/Field.php index 732fd4d290..112e87b1f2 100644 --- a/CRM/Member/Import/Field.php +++ b/CRM/Member/Import/Field.php @@ -108,6 +108,8 @@ class CRM_Member_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 + * + * @param $value */ public function setValue($value) { $this->_value = $value; diff --git a/CRM/Member/Import/Parser/Membership.php b/CRM/Member/Import/Parser/Membership.php index 9107d979c3..13628030c5 100644 --- a/CRM/Member/Import/Parser/Membership.php +++ b/CRM/Member/Import/Parser/Membership.php @@ -57,6 +57,10 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { /** * Class constructor. + * + * @param $mapperKeys + * @param null $mapperLocType + * @param null $mapperPhoneType */ public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) { parent::__construct(); @@ -594,8 +598,6 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { * * @param $formatted * - * @return; - * formatted containing date values */ public function formattedDates($calcDates, &$formatted) { $dates = array( diff --git a/Civi/Core/Resolver.php b/Civi/Core/Resolver.php index 0d332fe36d..d35b512f5d 100644 --- a/Civi/Core/Resolver.php +++ b/Civi/Core/Resolver.php @@ -34,6 +34,8 @@ class Resolver { protected static $_singleton; /** + * Singleton function. + * * @return Resolver */ public static function singleton() { @@ -48,6 +50,7 @@ class Resolver { * * @param string|array $id * A callback expression; any of the following. + * * @return array * A PHP callback. Do not serialize (b/c it may include an object). * @throws \RuntimeException @@ -102,6 +105,7 @@ class Resolver { * @param string|callable $id * @param array $args * Ordered parameters. To call-by-reference, set an array-parameter by reference. + * * @return mixed */ public function call($id, $args) { @@ -123,6 +127,8 @@ class ResolverConstantCallback { private $value; /** + * Class constructor. + * * @param mixed $value * The value to be returned by the dummy callback. */ @@ -131,6 +137,8 @@ class ResolverConstantCallback { } /** + * Invoke function. + * * @return mixed */ public function __invoke() { @@ -155,8 +163,11 @@ class ResolverApi { private $url; /** + * Class constructor. + * * @param array $url * Parsed URL (e.g. "api3://EntityName/action?foo=bar"). + * * @see parse_url */ public function __construct($url) { @@ -192,7 +203,7 @@ class ResolverApi { * * @return array * Named placeholders based on the positional arguments - * (e.g. "@1" => "firstValue"). + * (e.g. "@1" => "firstValue"). */ protected function createPlaceholders($prefix, $args) { $result = array(); -- 2.25.1