diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index b9ab0551946e..99c901e30d3f 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -56,7 +56,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { /** * Field for all the objects related to this contribution * - * @var array of objects (e.g membership object, participant object) + * @var \CRM_Member_BAO_Membership|\CRM_Event_BAO_Participant[] */ public $_relatedObjects = []; @@ -66,7 +66,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { * This is used for composing messages because they have dependency on the * contribution_page or event page - although over time we may eliminate that * - * @var string component or event + * @var "contribution"\"event" */ public $_component = NULL; @@ -4363,10 +4363,10 @@ public static function checkTaxAmount($params, $isLineItem = FALSE) { /** * Check financial type validation on update of a contribution. * - * @param Integer $financialTypeId + * @param int $financialTypeId * Value of latest Financial Type. * - * @param Integer $contributionId + * @param int $contributionId * Contribution Id. * * @param array $errors @@ -4956,15 +4956,15 @@ public static function addPayments($contributions, $contributionStatusId = NULL) } /** - * Function use to store line item proportionaly in - * in entity financial trxn table + * Function use to store line item proportionally in in entity financial trxn table * * @param array $trxnParams * - * @param Integer $trxnId + * @param int $trxnId * * @param float $contributionTotalAmount * + * @throws \CiviCRM_API3_Exception */ public static function assignProportionalLineItems($trxnParams, $trxnId, $contributionTotalAmount) { $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($trxnParams['contribution_id']); diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php index 62f1fe7a0b30..196a0c348baa 100644 --- a/CRM/Contribute/Form/AbstractEditPayment.php +++ b/CRM/Contribute/Form/AbstractEditPayment.php @@ -58,7 +58,9 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Contact_Form_Task { public $_fields = []; /** - * @var array current payment processor including a copy of the object in 'object' key + * Current payment processor including a copy of the object in 'object' key. + * + * @var array */ public $_paymentProcessor; diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php index 081c9a031512..0121cd1dbb9d 100644 --- a/CRM/Contribute/Form/Contribution.php +++ b/CRM/Contribute/Form/Contribution.php @@ -152,7 +152,9 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP public $_lineItem; /** - * @var array soft credit info + * Soft credit info. + * + * @var array */ public $_softCreditInfo; diff --git a/CRM/Contribute/Form/ContributionRecur.php b/CRM/Contribute/Form/ContributionRecur.php index 602cbe9d2fee..20aa64f1725f 100644 --- a/CRM/Contribute/Form/ContributionRecur.php +++ b/CRM/Contribute/Form/ContributionRecur.php @@ -39,12 +39,16 @@ class CRM_Contribute_Form_ContributionRecur extends CRM_Core_Form { use CRM_Core_Form_EntityFormTrait; /** - * @var int Contribution ID + * Contribution ID. + * + * @var int */ protected $_coid = NULL; /** - * @var int Contribution Recur ID + * Contribution Recur ID. + * + * @var int */ protected $_crid = NULL; @@ -59,7 +63,9 @@ class CRM_Contribute_Form_ContributionRecur extends CRM_Core_Form { protected $contributionRecurID = NULL; /** - * @var int Membership ID + * Membership ID. + * + * @var int */ protected $_mid = NULL; @@ -71,10 +77,11 @@ class CRM_Contribute_Form_ContributionRecur extends CRM_Core_Form { protected $_paymentProcessorObj = NULL; /** - * @var array + * Current payment processor. * - * Current payment processor including a copy of the object in 'object' key for - * legacy reasons. + * This includes a copy of the object in 'object' key for legacy reasons. + * + * @var array */ public $_paymentProcessor = []; diff --git a/CRM/Contribute/Page/UserDashboard.php b/CRM/Contribute/Page/UserDashboard.php index 32c231782f0c..289051836a9d 100644 --- a/CRM/Contribute/Page/UserDashboard.php +++ b/CRM/Contribute/Page/UserDashboard.php @@ -74,7 +74,7 @@ public function listContribution() { 'ccid' => $row['contribution_id'], 'cs' => $this->getUserChecksum(), 'cid' => $row['contact_id'], - ]) + ]), ]; } } diff --git a/CRM/Core/BAO/ActionSchedule.php b/CRM/Core/BAO/ActionSchedule.php index 2b54981f9e6f..a85f4df85261 100644 --- a/CRM/Core/BAO/ActionSchedule.php +++ b/CRM/Core/BAO/ActionSchedule.php @@ -120,13 +120,14 @@ public static function getAllEntityStatusLabels() { * @param bool $namesOnly * Return simple list of names. * - * @param \Civi\ActionSchedule\Mapping|NULL $filterMapping + * @param \Civi\ActionSchedule\Mapping|null $filterMapping * Filter by the schedule's mapping type. * @param int $filterValue * Filter by the schedule's entity_value. * * @return array * (reference) reminder list + * @throws \CRM_Core_Exception */ public static function &getList($namesOnly = FALSE, $filterMapping = NULL, $filterValue = NULL) { $query = " diff --git a/CRM/Core/DAO/permissions.php b/CRM/Core/DAO/permissions.php index 6ba337cd1b4a..b2640be20376 100644 --- a/CRM/Core/DAO/permissions.php +++ b/CRM/Core/DAO/permissions.php @@ -62,21 +62,3 @@ function _civicrm_api3_permissions($entity, $action, &$params) { return isset($perm[$action]) ? $perm[$action] : $perm['default']; } - -# FIXME: not sure how to permission the following API 3 calls: -# contribution_transact (make online contributions) -# entity_tag_display -# group_contact_pending -# group_contact_update_status -# mailing_event_bounce -# mailing_event_click -# mailing_event_confirm -# mailing_event_forward -# mailing_event_open -# mailing_event_reply -# mailing_group_event_domain_unsubscribe -# mailing_group_event_resubscribe -# mailing_group_event_subscribe -# mailing_group_event_unsubscribe -# membership_status_calc -# survey_respondant_count diff --git a/CRM/Core/Payment/FirstData.php b/CRM/Core/Payment/FirstData.php index a123e8f85dea..a8f5b4f7ff42 100644 --- a/CRM/Core/Payment/FirstData.php +++ b/CRM/Core/Payment/FirstData.php @@ -52,7 +52,7 @@ * ************************** */ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { - # (not used, implicit in the API, might need to convert?) + // (not used, implicit in the API, might need to convert?) const CHARSET = 'UFT-8'; /** @@ -122,7 +122,7 @@ public function mapProcessorFieldstoParams($params) { $requestFields['email'] = $params['email']; $requestFields['ip'] = $params['ip_address']; $requestFields['transactionorigin'] = "Eci"; - #32 character string + // 32 character string $requestFields['invoice_number'] = $params['invoiceID']; $requestFields['ordertype'] = 'Sale'; $requestFields['comments'] = $params['description']; @@ -179,9 +179,9 @@ public function doDirectPayment(&$params) { * define variables for connecting with the gateway **********************************************************/ - # Name and location of certificate file + // Name and location of certificate file $key = $this->_paymentProcessor['password']; - # Your store number + // Your store number $requestFields["configfile"] = $this->_paymentProcessor['user_name']; $port = "1129"; $host = $this->_paymentProcessor['url_site'] . ":" . $port . "/LSGSXML"; diff --git a/CRM/Core/Payment/eWAY.php b/CRM/Core/Payment/eWAY.php index 68992819af9a..8f198b46c824 100644 --- a/CRM/Core/Payment/eWAY.php +++ b/CRM/Core/Payment/eWAY.php @@ -99,7 +99,7 @@ * Class CRM_Core_Payment_eWAY. */ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { - # (not used, implicit in the API, might need to convert?) + // (not used, implicit in the API, might need to convert?) const CHARSET = 'UTF-8'; /** diff --git a/CRM/Core/Reference/OptionValue.php b/CRM/Core/Reference/OptionValue.php index 9f37cdf9fc4d..9908be044b64 100644 --- a/CRM/Core/Reference/OptionValue.php +++ b/CRM/Core/Reference/OptionValue.php @@ -5,7 +5,9 @@ */ class CRM_Core_Reference_OptionValue extends CRM_Core_Reference_Basic { /** - * @var string option-group-name + * Option group name. + * + * @var string */ protected $targetOptionGroupName;