impress-org / give

includes/misc-functions.php

Doc Comments +6 added lines, -6 removed lines

@@ -228,7 +228,7 @@ 
  *
  * @since 1.8.17
  *
- * @return array|string
+ * @return boolean
  */
 function give_get_history_session() {
 	return (bool) Give()->session->get( 'history_access' );
@@ -704,7 +704,7 @@ 
  *
  * @todo  Remove this, when WordPress Core ticket is resolved (https://core.trac.wordpress.org/ticket/16828).
  *
- * @return bool
+ * @return false|null
  */
 function give_donation_metabox_menu() {
 
@@ -982,7 +982,7 @@ 
  *
  * @since 1.8
  *
- * @param $form_id
+ * @param integer $form_id
  *
  * @return bool
  */
@@ -1089,7 +1089,7 @@ 
  * @param int    $id
  * @param string $meta_key
  * @param mixed  $meta_value
- * @param mixed  $prev_value
+ * @param string  $prev_value
  *
  * @return mixed
  */
@@ -1348,7 +1348,7 @@ 
  * @since 1.8.13
  *
  * @param array      $list      List of objects or arrays
- * @param int|string $field     Field from the object to place instead of the entire object
+ * @param string $field     Field from the object to place instead of the entire object
  * @param int|string $index_key Optional. Field from the object to use as keys for the new array.
  *                              Default null.
  *
@@ -1782,7 +1782,7 @@ 
  *
  * @since 2.1
  *
- * @param $form_id
+ * @param integer $form_id
  *
  * @return bool
  */

includes/payments/backward-compatibility.php

Doc Comments +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
  *                              metadata entries with the specified value.
  *                              Otherwise, update all entries.
  *
- * @return mixed
+ * @return null|boolean
  */
 function _give_20_bc_saving_old_payment_meta( $check, $object_id, $meta_key, $meta_value, $prev_value ) {
 	// Bailout.

includes/payments/class-give-payment.php

Doc Comments +2 added lines, -2 removed lines

@@ -405,7 +405,7 @@ 
 	 *
 	 * @param  int|bool $payment_id A given payment.
 	 *
-	 * @return mixed void|false
+	 * @return false|null void|false
 	 */
 	public function __construct( $payment_id = false ) {
 
@@ -1175,7 +1175,7 @@ 
 	 *
 	 * @param  string|bool $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/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/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' ) {
 
@@ -84,7 +84,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;
@@ -210,7 +210,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/payments/class-payments-query.php

Doc Comments +3 added lines, -3 removed lines

@@ -107,7 +107,7 @@ 
 	 * @since  1.0
 	 * @access public
 	 *
-	 * @param $query_var
+	 * @param string $query_var
 	 * @param $value
 	 */
 	public function __set( $query_var, $value ) {
@@ -124,7 +124,7 @@ 
 	 * @since  1.0
 	 * @access public
 	 *
-	 * @param $query_var
+	 * @param string $query_var
 	 */
 	public function __unset( $query_var ) {
 		unset( $this->args[ $query_var ] );
@@ -477,7 +477,7 @@ 
 	 * @param string   $order
 	 * @param WP_Query $query
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function custom_orderby( $order, $query ) {
 

includes/payments/functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -572,7 +572,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/process-donation.php

Doc Comments +2 added lines, -2 removed lines

@@ -24,7 +24,7 @@ 
  *
  * @throws ReflectionException Exception Handling.
  *
- * @return mixed
+ * @return false|null
  */
 function give_process_donation_form() {
 
@@ -1366,7 +1366,7 @@ 
  *
  * @param array $valid_data List of Valid Data.
  *
- * @return bool
+ * @return boolean|null
  */
 function give_validate_donation_amount( $valid_data ) {
 

includes/shortcodes.php

Doc Comments +1 added lines, -1 removed lines

@@ -791,7 +791,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 ) {