impress-org / give

includes/forms/functions.php

Doc Comments +5 added lines, -5 removed lines

@@ -152,7 +152,7 @@ 
  *
  * Used to redirect a user back to the donation form if there are errors present.
  *
- * @param array|string $args
+ * @param string $args
  *
  * @access public
  * @since  1.0
@@ -298,7 +298,7 @@ 
  * @since  1.0
  * @since  1.8.16 Add security check
  *
- * @return bool
+ * @return false|null
  */
 function give_listen_for_failed_payments() {
 
@@ -1289,7 +1289,7 @@ 
  * @since 2.2.0
  *
  * @param array|integer   $price_or_level_id Price level data.
- * @param boolean|integer $form_id           Donation Form ID.
+ * @param integer $form_id           Donation Form ID.
  *
  * @return boolean
  */
@@ -1393,7 +1393,7 @@ 
  *
  * @since 2.2.0
  *
- * @return object
+ * @return Give_Donor
  */
 function give_get_name_with_title_prefixes( $donor ) {
 
@@ -1438,7 +1438,7 @@ 
  *
  * @since 2.2.0
  *
- * @return array
+ * @return string|boolean
  */
 function give_get_default_title_prefixes() {
 	/**

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() ) {
 
@@ -1681,7 +1681,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 );
@@ -1891,7 +1891,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() ) {
 
@@ -1923,7 +1923,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 ) {
 
@@ -1952,7 +1952,7 @@ 
  *
  * @since  1.8
  *
- * @param  $form_id
+ * @param  integer $form_id
  * @param  $args
  *
  * @return mixed|string
@@ -1993,7 +1993,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 ) {
 
@@ -2297,7 +2297,7 @@ 
  *
  * @since 2.1
  *
- * @return array
+ * @return string[]
  */
 function add_class_for_form_grid( $class, $id, $args ) {
 	$class[] = 'give-form-grid-wrap';
@@ -2314,7 +2314,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/gateways/paypal-standard.php

Doc Comments +2 added lines, -2 removed lines

@@ -506,7 +506,7 @@ 
  *
  * @since 1.6.3
  *
- * @param $pending_reason
+ * @param string $pending_reason
  *
  * @return string
  */
@@ -583,7 +583,7 @@ 
  * @param int   $payment_id   Payment ID
  * @param array $payment_data Array of payment data.
  *
- * @return mixed|string
+ * @return string
  */
 function give_build_paypal_url( $payment_id, $payment_data ) {
 	// Only send to PayPal if the pending payment is created successfully.

includes/install.php

Doc Comments +1 added lines, -1 removed lines

@@ -438,7 +438,7 @@
  *
  * @since 1.8.11
  *
- * @return void
+ * @return false|null
  */
 function give_create_pages() {
 

includes/login-register.php

Doc Comments +3 added lines, -3 removed lines

@@ -181,7 +181,7 @@ 
  * @param string $user_login Username
  * @param string $user_pass  Password
  *
- * @return bool
+ * @return false|null
  */
 function give_log_user_in( $user_id, $user_login, $user_pass ) {
 
@@ -222,7 +222,7 @@ 
  *
  * @param array $data Data sent from the register form
  *
- * @return bool
+ * @return false|null
  */
 function give_process_register_form( $data ) {
 
@@ -308,7 +308,7 @@ 
  *
  * @since 1.8.17
  *
- * @return bool
+ * @return boolean|null
  */
 function give_email_access_login() {
 

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 ) {