comment fixes
authorEileen McNaughton <eileen@fuzion.co.nz>
Tue, 3 Mar 2015 22:24:41 +0000 (09:24 +1100)
committerEileen McNaughton <eileen@fuzion.co.nz>
Tue, 3 Mar 2015 22:24:41 +0000 (09:24 +1100)
CRM/Campaign/BAO/Campaign.php
CRM/Campaign/Controller/Search.php
CRM/Campaign/Form/Survey/Results.php
CRM/Core/Payment/Google.php
CRM/Core/Payment/Moneris.php
CRM/Extension/Browser.php
CRM/Member/BAO/Membership.php
CRM/Member/Import/Field.php
CRM/Member/Import/Parser/Membership.php
Civi/Core/Resolver.php

index 809a55f6a2d3c17be6b39fb2ae382e48141e4574..7d7c7660662308c27f67764eb3670d67d1d28498 100644 (file)
@@ -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();
index dce86880f508928f5a5b608f260ee34714772067..e790a7ade7c7de0ba28cff67d5e7f3f3d274c5d5 100755 (executable)
@@ -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) {
 
index a09fad8def3882013db98121c5d16f7d2307b191..cebc910b0b662c265cc8d433930af1a1017cd852 100644 (file)
@@ -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();
index ab28749b431ab8660a777c1f0bd6927af07f46f3..a3a34ccbada10bed586efc26324fe4c1e3a04783 100644 (file)
@@ -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'];
index 4fad580ea4b70229a488d71e4b27af50e4e56347..7e0c395a57a4c92a3b3f247b8d545f99d7bd9761 100644 (file)
@@ -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;
index 4d979ae9d0286bb08589ec32a5c8bbed12aad1b2..b3929d49e5fa2365ace36dc932b5da1149272b9f 100644 (file)
@@ -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) {
   }
index 20cc3a7f6b155f5d29ebbe56d3dd70e4be97f36f..80edae96ca46b4121c645af7fb734344d99c203e 100644 (file)
@@ -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,
index 732fd4d290291123c06909d2a24855829e409577..112e87b1f2bfc215b9509b166246c85141694914 100644 (file)
@@ -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;
index 9107d979c3e647b56d27c90529e578a2181f5b28..13628030c529325ba2397b5af5f26c011c9792d7 100644 (file)
@@ -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(
index 0d332fe36d1d9e6f41cc072f2c6157f96625e35b..d35b512f5db5bc183d8d5ce3e9d5324f10f6f673 100644 (file)
@@ -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();