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 ) {
 		global $wpdb;
@@ -187,7 +187,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/class-addon-activation-banner.php

Doc Comments +1 added lines, -1 removed lines

@@ -487,7 +487,7 @@
 	 *
 	 * @param string $main_file Plugin Main File.
 	 *
-	 * @return bool|mixed|string
+	 * @return string
 	 */
 	public function get_plugin_folder_name( $main_file ) {
 		// Remove plugin file and get the Add-on's folder name only.

includes/class-give-donor.php

Doc Comments +1 added lines, -1 removed lines

@@ -999,7 +999,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/shortcodes.php

Doc Comments +1 added lines, -1 removed lines

@@ -708,7 +708,7 @@
  * @type string $display_style       How the form is displayed, either in new page or modal popup.
  *                                       Default 'redirect'. Accepts 'redirect', 'modal'.
  * }
- * @return string|bool The markup of the form grid or false.
+ * @return string|null The markup of the form grid or false.
  */
 function give_form_grid_shortcode( $atts ) {
 

includes/class-give-comment.php

Doc Comments +2 added lines, -1 removed lines

@@ -425,7 +425,7 @@ 
 	 * @param int        $comment_id
 	 * @param WP_Comment $comment
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function __get_comment_author( $author, $comment_id, $comment ) {
 		if ( in_array( $comment->comment_type, $this->comment_types ) ) {
@@ -448,6 +448,7 @@ 
 	 * @access public
 	 *
 	 * @param array @comment_types
+	 * @param string[] $comment_types
 	 *
 	 * @return array
 	 */

includes/forms/template.php

Doc Comments +7 added lines, -8 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() ) {
 
@@ -1482,7 +1482,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 );
@@ -1676,7 +1676,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 = array() ) {
 
@@ -1703,7 +1703,7 @@ 
  * @param  int $total      Total amount based on shortcode parameter.
  * @param  int $total_goal Total Goal amount passed by Admin.
  *
- * @return mixed
+ * @return boolean
  */
 function give_show_goal_totals_progress( $total, $total_goal ) {
 
@@ -1727,7 +1727,7 @@ 
  *
  * @since  1.8
  *
- * @param  $form_id
+ * @param  integer $form_id
  * @param  $args
  *
  * @return mixed|string
@@ -1768,7 +1768,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 ) {
 
@@ -2050,7 +2050,7 @@ 
  *
  * @since 2.1
  *
- * @return array
+ * @return string[]
  */
 function add_class_for_form_grid( $class, $id, $args ) {
 	$class[] = 'give-form-grid-wrap';
@@ -2061,7 +2061,6 @@ 
 /**
  * Add hidden field to Form Grid page
  *
- * @param int              $form_id The form ID.
  * @param array            $args    An array of form arguments.
  * @param Give_Donate_Form $form    Form object.
  *

includes/payments/class-give-sequential-donation-number.php

Doc Comments +1 added lines, -1 removed lines

@@ -197,7 +197,7 @@
 	 * @since
 	 * @access public
 	 *
-	 * @param $serial_number
+	 * @param integer $serial_number
 	 *
 	 * @return string
 	 */

includes/payments/functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -569,7 +569,7 @@
  *
  * @since 1.0
  *
- * @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.

includes/admin/donors/donor-actions.php

Doc Comments +3 added lines, -3 removed lines

@@ -21,7 +21,7 @@ 
  *
  * @since 1.0
  *
- * @return array|bool $output Response messages
+ * @return false|null $output Response messages
  */
 function give_edit_donor( $args ) {
 
@@ -431,7 +431,7 @@ 
  *
  * @since  1.7
  *
- * @return bool|null
+ * @return false|null
  */
 function give_remove_donor_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {
@@ -475,7 +475,7 @@ 
  *
  * @since  1.7
  *
- * @return bool|null
+ * @return false|null
  */
 function give_set_donor_primary_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {