Changeset 10355 for trunk/src/bp-core/classes/class-bp-core-notification.php

Timestamp:

11/15/2015 07:13:42 PM (11 years ago)

Author:

tw2113

Message:

More documentation cleanup for part of BP-Core component.

See #6398.

File:

• trunk/src/bp-core/classes/class-bp-core-notification.php (modified) (11 diffs)

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

@@ -15 +15 @@
  * Use BP_Notifications_Notification instead.
  *
- * @package BuddyPress Core
  * @deprecated since 1.9.0
  */
@@ -81 +80 @@
      * Constructor
      *
-     * @param int $id
+     * @param int $id ID for the notification.
      */
     public function __construct( $id = 0 ) {
@@ -102 +101 @@
         $bp = buddypress();
 
-        // Update
+        // Update.
         if ( !empty( $this->id ) ) {
             $sql = $wpdb->prepare( "UPDATE {$bp->core->table_name_notifications} SET item_id = %d, secondary_item_id = %d, user_id = %d, component_name = %s, component_action = %d, date_notified = %s, is_new = %d ) WHERE id = %d", $this->item_id, $this->secondary_item_id, $this->user_id, $this->component_name, $this->component_action, $this->date_notified, $this->is_new, $this->id );
 
-        // Save
+        // Save.
         } else {
             $sql = $wpdb->prepare( "INSERT INTO {$bp->core->table_name_notifications} ( item_id, secondary_item_id, user_id, component_name, component_action, date_notified, is_new ) VALUES ( %d, %d, %d, %s, %s, %s, %d )", $this->item_id, $this->secondary_item_id, $this->user_id, $this->component_name, $this->component_action, $this->date_notified, $this->is_new );
@@ -149 +148 @@
      * @param int $user_id         ID to check access for.
      * @param int $notification_id Notification ID to check for.
-     *
      * @return string
      */
@@ -164 +162 @@
      *
      * @global wpdb $wpdb WordPress database object
+     *
+     * @static
      *
      * @param int    $user_id User ID.
      * @param string $status 'is_new' or 'all'.
-     *
      * @return array Associative array
-     * @static
      */
     public static function get_all_for_user( $user_id, $status = 'is_new' ) {
@@ -188 +186 @@
      * @global wpdb $wpdb WordPress database object.
      *
-     * @param int    $user_id
-     * @param string $component_name
-     * @param string $component_action
-     *
-     * @static
-     *
+     * @static
+     *
+     * @param int    $user_id          ID of the user to delet notification for.
+     * @param string $component_name   Component name.
+     * @param string $component_action Component action.
      * @return mixed
      */
@@ -208 +205 @@
      *
      * @global wpdb $wpdb WordPress database object.
+     *
+     * @static
      *
      * @param int      $user_id           The ID of the user who the notifications are for.
@@ -215 +214 @@
      * @param int|bool $secondary_item_id (optional) The secondary item id of the notifications that we wish to
      *                                    use to delete.
-     * @static
-     *
      * @return mixed
      */
@@ -236 +233 @@
      * @global wpdb $wpdb WordPress database object.
      *
+     * @static
+     *
      * @param int    $user_id          The ID of the user whose sent notifications we wish to delete.
      * @param string $component_name   The name of the component the notification was sent from.
      * @param string $component_action The action of the component the notification was sent from.
-     * @static
-     *
      * @return mixed
      */
@@ -256 +253 @@
      *
      * @global wpdb $wpdb WordPress database object.
+     *
+     * @static
      *
      * @param string $item_id           The item id that they notifications are to be for.
@@ -261 +260 @@
      * @param string $component_action  The action that the notifications are to be from.
      * @param string $secondary_item_id Optional secondary item id that the notifications are to have.
-     * @static
-     *
      * @return mixed
      */