Changeset 11447 for trunk/src/bp-core/deprecated/1.9.php

Timestamp:

03/04/2017 06:26:55 PM (9 years ago)

Author:

tw2113

Message:

Cleanup from recent Scrutinizer review around documentation and param/return types.

File:

• trunk/src/bp-core/deprecated/1.9.php (modified) (6 diffs)

trunk/src/bp-core/deprecated/1.9.php

@@ -20 +20 @@
  *
  * @since 1.0.0
- * @param string $item_id
- * @param int $user_id
- * @param string $component_name
- * @param string $component_action
- * @param string $secondary_item_id
- * @param string $date_notified
- * @param int $is_new
- * @return boolean True on success, false on failure.
+ * @param string       $item_id
+ * @param int          $user_id
+ * @param string       $component_name
+ * @param string       $component_action
+ * @param int          $secondary_item_id
+ * @param false|string $date_notified
+ * @param int          $is_new
+ * @return int|boolean True on success, false on failure.
  */
 function bp_core_add_notification( $item_id, $user_id, $component_name, $component_action, $secondary_item_id = 0, $date_notified = false, $is_new = 1 ) {
@@ -63 +63 @@
  *
  * @since 1.0.0
+ *
  * @param int $id ID of notification.
- * @return boolean True on success, false on failure.
+ * @return false|integer True on success, false on failure.
  */
 function bp_core_delete_notification( $id ) {
@@ -87 +88 @@
  * @since 1.0.0
  * @param int $id ID of notification.
- * @return BP_Core_Notification
+ * @return false|BP_Core_Notification
  */
 function bp_core_get_notification( $id ) {
@@ -141 +142 @@
  * @param string $component_name
  * @param string $component_action
- * @return boolean True on success, false on failure.
+ * @return false|int True on success, false on failure.
  */
 function bp_core_delete_notifications_by_type( $user_id, $component_name, $component_action ) {
@@ -166 +167 @@
  *
  * @since 1.0.0
+ *
  * @param int $user_id
  * @param string $component_name
  * @param string $component_action
+ * @return false|int True on success, false on failure.
+ */
+function bp_core_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false ) {
+
+        // Bail if notifications is not active
+        if ( ! bp_is_active( 'notifications' ) ) {
+                return false;
+        }
+
+        // Trigger the deprecated function notice
+        _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notifications_by_item_id()' );
+
+        return bp_notifications_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id );
+}
+
+/**
+ * Delete all notifications for by type.
+ *
+ * @deprecated Deprecated since BuddyPress 1.9.0. Use
+ *             bp_notifications_delete_all_notifications_by_type() instead.
+ *
+ * @since 1.0.0
+ *
+ * @param int          $user_id
+ * @param string       $component_name
+ * @param false|string $component_action
  * @return boolean True on success, false on failure.
  */
-function bp_core_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false ) {
-
-        // Bail if notifications is not active
-        if ( ! bp_is_active( 'notifications' ) ) {
-                return false;
-        }
-
-        // Trigger the deprecated function notice
-        _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notifications_by_item_id()' );
-
-        return bp_notifications_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id );
-}
-
-/**
- * Delete all notifications for by type.
- *
- * @deprecated Deprecated since BuddyPress 1.9.0. Use
- *             bp_notifications_delete_all_notifications_by_type() instead.
+function bp_core_delete_all_notifications_by_type( $item_id, $component_name, $component_action = false, $secondary_item_id = false ) {
+
+        // Bail if notifications is not active
+        if ( ! bp_is_active( 'notifications' ) ) {
+                return false;
+        }
+
+        // Trigger the deprecated function notice
+        _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_all_notifications_by_type()' );
+
+        bp_notifications_delete_all_notifications_by_type( $item_id, $component_name, $component_action, $secondary_item_id );
+}
+
+/**
+ * Delete all notifications for a user.
+ *
+ * Used when clearing out all notifications for a user, when deleted or spammed
+ *
+ * @deprecated Deprecated since BuddyPress 1.9.0. Use
+ *             bp_notifications_delete_notifications_from_user() instead.
  *
  * @since 1.0.0
@@ -194 +224 @@
  * @param string $component_name
  * @param string $component_action
- * @return boolean True on success, false on failure.
- */
-function bp_core_delete_all_notifications_by_type( $item_id, $component_name, $component_action = false, $secondary_item_id = false ) {
-
-        // Bail if notifications is not active
-        if ( ! bp_is_active( 'notifications' ) ) {
-                return false;
-        }
-
-        // Trigger the deprecated function notice
-        _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_all_notifications_by_type()' );
-
-        bp_notifications_delete_all_notifications_by_type( $item_id, $component_name, $component_action, $secondary_item_id );
-}
-
-/**
- * Delete all notifications for a user.
- *
- * Used when clearing out all notifications for a user, when deleted or spammed
- *
- * @deprecated Deprecated since BuddyPress 1.9.0. Use
- *             bp_notifications_delete_notifications_from_user() instead.
- *
- * @since 1.0.0
- * @param int $user_id
- * @param string $component_name
- * @param string $component_action
- * @return boolean True on success, false on failure.
+ * @return false|int True on success, false on failure.
  */
 function bp_core_delete_notifications_from_user( $user_id, $component_name, $component_action ) {