ravinderk / Give

includes/payments/class-payment-stats.php

Doc Comments +3 added lines, -3 removed lines

@@ -36,7 +36,7 @@ 
 	 * @param  $end_date   string|bool  The end date for which we'd like to filter our sale stats. If false, we'll use the default end date of `this_month`
 	 * @param  $status     string|array The sale status(es) to count. Only valid when retrieving global stats
 	 *
-	 * @return float|int                Total amount of donations based on the passed arguments.
+	 * @return string                Total amount of donations based on the passed arguments.
 	 */
 	public function get_sales( $form_id = 0, $start_date = false, $end_date = false, $status = 'publish' ) {
 
@@ -83,7 +83,7 @@ 
 	 * @param  $end_date    string|bool The end date for which we'd like to filter the donations stats. If false, method will use the default end date of `this_month`.
 	 * @param  $gateway_id  string|bool The gateway to get earnings for such as 'paypal' or 'stripe'.
 	 *
-	 * @return float|int                Total amount of donations based on the passed arguments.
+	 * @return string                Total amount of donations based on the passed arguments.
 	 */
 	public function get_earnings( $form_id = 0, $start_date = false, $end_date = false, $gateway_id = false ) {
 		$this->setup_dates( $start_date, $end_date );
@@ -168,7 +168,7 @@ 
 	 * @param  $end_date    string|bool The end date for which we'd like to filter our sale stats. If false, we'll use the default end date of `this_month`
 	 * @param  $gateway_id  string|bool The gateway to get earnings for such as 'paypal' or 'stripe'
 	 *
-	 * @return float|int                Total amount of donations based on the passed arguments.
+	 * @return string                Total amount of donations based on the passed arguments.
 	 */
 	public function get_earnings_cache_key( $form_id = 0, $start_date = false, $end_date = false, $gateway_id = false ) {
 

includes/admin/reports/class-donor-reports-table.php

Doc Comments +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
 	 *
 	 * @access public
 	 * @since  1.0
-	 * @return mixed string If search is present, false otherwise
+	 * @return string|false string If search is present, false otherwise
 	 */
 	public function get_search() {
 		return ! empty( $_GET['s'] ) ? urldecode( trim( $_GET['s'] ) ) : false;

includes/formatting.php

Doc Comments +1 added lines, -1 removed lines

@@ -283,7 +283,7 @@
  * @since 1.0
  *
  * @param int|float|string $amount   Formatted or sanitized price
- * @param int|bool         $dp       number of decimals
+ * @param boolean         $dp       number of decimals
  * @param bool             $sanitize Whether or not sanitize number
  *
  * @return string $amount Newly formatted amount or Price Not Available

give.php

Doc Comments +1 added lines, -1 removed lines

@@ -521,7 +521,7 @@
  * Example: <?php $give = Give(); ?>
  *
  * @since 1.0
- * @return object|Give
+ * @return Give
  */
 function Give() {
 	return Give::instance();

includes/admin/tools/data/class-give-tools-delete-test-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/user-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -675,7 +675,7 @@
 /**
  * This function will check whether the donor email is primary or additional.
  *
- * @param $email Donor Email.
+ * @param string $email Donor Email.
  *
  * @since 1.8.13
  *

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/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
 		 */