Changeset 11447 for trunk/src/bp-notifications/classes/class-bp-notifications-notification.php

Timestamp:

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

Author:

tw2113

Message:

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

File:

• trunk/src/bp-notifications/classes/class-bp-notifications-notification.php (modified) (6 diffs)

trunk/src/bp-notifications/classes/class-bp-notifications-notification.php

@@ -837 +837 @@
      *                           determine which rows should be updated. Of the format
      *                           array( 'item_id' => 7, 'component_action' => 'members', ).
-     * @return int|bool Number of rows updated on success, false on failure.
+     * @return int|false Number of rows updated on success, false on failure.
      */
     public static function update( $update_args = array(), $where_args = array() ) {
@@ -872 +872 @@
      *                    which rows should be deleted.  Of the format
      *                    array( 'item_id' => 7, 'component_action' => 'members', ).
-     * @return int|bool Number of rows deleted on success, false on failure.
+     * @return int|false Number of rows deleted on success, false on failure.
      */
     public static function delete( $args = array() ) {
@@ -902 +902 @@
      *
      * @param int $id ID of the notification item to be deleted.
-     * @return bool True on success, false on failure.
+     * @return int|false True on success, false on failure.
      */
     public static function delete_by_id( $id ) {
@@ -1017 +1017 @@
      * @param string $component_action  Name of the component action.
      * @param int    $secondary_item_id The ID of the secondary item.
-     * @return bool|int False on failure to update. ID on success.
+     * @return int|false False on failure to update. ID on success.
      */
     public static function mark_all_for_user( $user_id, $is_new = 0, $item_id = 0, $component_name = '', $component_action = '', $secondary_item_id = 0 ) {
@@ -1060 +1060 @@
      * @param string $component_action  Name of the component action.
      * @param int    $secondary_item_id The ID of the secondary item.
-     * @return bool|int
+     * @return int|false
      */
     public static function mark_all_from_user( $user_id, $is_new = 0, $component_name = '', $component_action = '', $secondary_item_id = 0 ) {
@@ -1104 +1104 @@
      * @param int    $secondary_item_id Optional. ID of the secondary
      *                                  associated item.
-     * @return bool|int
+     * @return int|false
      */
     public static function mark_all_by_type( $item_id, $is_new = 0, $component_name = '', $component_action = '', $secondary_item_id = 0 ) {