ravinderk / Give

includes/payments/class-give-payment.php

Doc Comments +2 added lines, -2 removed lines

@@ -369,7 +369,7 @@ 
 	 *
 	 * @param  int|bool $payment_id A given payment
 	 *
-	 * @return mixed void|false
+	 * @return false|null void|false
 	 */
 	public function __construct( $payment_id = false ) {
 
@@ -1088,7 +1088,7 @@ 
 	 *
 	 * @param  string $note The note to add
 	 *
-	 * @return bool           If the note was specified or not
+	 * @return false|null           If the note was specified or not
 	 */
 	public function add_note( $note = false ) {
 		// Bail if no note specified.

includes/admin/tools/data/class-give-tools-delete-import-donors.php

Doc Comments +4 added lines, -1 removed lines

@@ -216,7 +216,7 @@ 
 	 * Return the calculated completion percentage.
 	 *
 	 * @since 1.8.12
-	 * @return int
+	 * @return double
 	 */
 	public function get_percentage_complete() {
 		return ceil( ( 100 * $this->step_completed ) / $this->total_step );
@@ -353,6 +353,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer $page
+	 */
 	public function get_delete_ids( $donation_ids, $page ) {
 		$index            = $page --;
 		$count            = count( $donation_ids );

includes/class-give-donor.php

Doc Comments +1 added lines, -1 removed lines

@@ -918,7 +918,7 @@
 	 * @access public
 	 *
 	 * @param  string $meta_key Metadata name. Default is empty.
-	 * @param  mixed $meta_value Optional. Metadata value. Default is empty.
+	 * @param  string $meta_value Optional. Metadata value. Default is empty.
 	 *
 	 * @return bool               False for failure. True for success.
 	 */

includes/admin/tools/import/class-give-import-donations.php

Doc Comments +2 added lines, -2 removed lines

@@ -452,7 +452,7 @@ 
 
 		/**
 		 * @param $option_value
-		 * @param $value
+		 * @param boolean $value
 		 *
 		 * @return string
 		 */
@@ -529,7 +529,7 @@ 
 		 *
 		 * @since 1.8.14
 		 *
-		 * @param $file_id
+		 * @param integer $file_id
 		 *
 		 * @return bool|int
 		 */

includes/class-give-db-donors.php

Doc Comments +4 added lines, -4 removed lines

@@ -165,7 +165,7 @@ 
 	 * NOTE: This should not be called directly as it does not make necessary changes to
 	 * the payment meta and logs. Use give_donor_delete() instead.
 	 *
-	 * @param  bool|string|int $_id_or_email ID or Email of Donor.
+	 * @param  integer $_id_or_email ID or Email of Donor.
 	 *
 	 * @since  1.0
 	 * @access public
@@ -367,7 +367,7 @@ 
 	 * @since  1.4.3
 	 * @access public
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public function update_donor_email_on_user_update( $user_id = 0, $old_user_data = false ) {
 
@@ -424,7 +424,7 @@ 
 	 * @access public
 	 *
 	 * @param  string $field ID or email. Default is 'id'.
-	 * @param  mixed  $value The Customer ID or email to search. Default is 0.
+	 * @param  integer  $value The Customer ID or email to search. Default is 0.
 	 *
 	 * @return mixed         Upon success, an object of the donor. Upon failure, NULL
 	 */
@@ -667,7 +667,7 @@ 
 	 * @access public
 	 * @since  2.0
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public function update_donor_info_on_user_update( $user_id = 0 ) {
 

includes/forms/template.php

Doc Comments +5 added lines, -5 removed lines

@@ -21,7 +21,7 @@ 
  *
  * @since 1.0
  *
- * @return string Donation form.
+ * @return false|null Donation form.
  */
 function give_get_donation_form( $args = array() ) {
 
@@ -1538,7 +1538,7 @@ 
  *
  * @param  int $form_id The form ID.
  *
- * @return bool
+ * @return false|null
  */
 function give_terms_agreement( $form_id ) {
 	$form_option = give_get_meta( $form_id, '_give_terms_option', true );
@@ -1716,7 +1716,7 @@ 
  * @param  int   $form_id The form ID.
  * @param  array $args    An array of form arguments.
  *
- * @return mixed
+ * @return boolean
  */
 function give_show_goal_progress( $form_id, $args ) {
 
@@ -1736,7 +1736,7 @@ 
  *
  * @since  1.8
  *
- * @param  $form_id
+ * @param  integer $form_id
  * @param  $args
  *
  * @return mixed|string
@@ -1777,7 +1777,7 @@ 
  * @param  int   $form_id The form ID.
  * @param  array $args    An array of form arguments.
  *
- * @return void|bool
+ * @return false|null
  */
 function give_form_content( $form_id, $args ) {
 

includes/payments/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -692,7 +692,7 @@ 
  * @param  int $year Year number. Default is null.
  * @param  int $hour Hour number. Default is null.
  *
- * @return int $earnings  Earnings
+ * @return double $earnings  Earnings
  */
 function give_get_earnings_by_date( $day = null, $month_num, $year = null, $hour = null ) {
 	// This is getting deprecated soon. Use Give_Payment_Stats with the get_earnings() method instead.
@@ -952,7 +952,7 @@ 
  * @param string $meta_key The meta key to pull.
  * @param bool $single Pull single meta entry or as an object.
  *
- * @return mixed $meta Payment Meta.
+ * @return string $meta Payment Meta.
  */
 function give_get_payment_meta( $payment_id = 0, $meta_key = '_give_payment_meta', $single = true ) {
 	$payment = new Give_Payment( $payment_id );
@@ -1000,7 +1000,7 @@ 
  *
  * @param int $payment_id Payment ID.
  *
- * @return int $form_id Form ID.
+ * @return string $form_id Form ID.
  */
 function give_get_payment_form_id( $payment_id ) {
 	$payment = new Give_Payment( $payment_id );

includes/admin/admin-filters.php

Doc Comments +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
  *
  * @param   string $value
  *
- * @return  mixed
+ * @return  string
  */
 function __give_validate_decimal_separator_setting_field( $value ) {
 	$thousand_separator = give_clean( $_POST['thousands_separator'] );

includes/import-functions.php

Doc Comments +1 added lines

@@ -666,6 +666,7 @@
  * Check if Import donation is duplicate
  *
  * @since 1.8.13
+ * @param Give_Donate_Form $form
  */
 function give_check_import_donation_duplicate( $payment_data, $data, $form, $donor_data ) {
 	$return = false;