This class has been deprecated. since 1.9.0 instead.

Contents

Code Reference Classes BP_Core_Notification

BP_Core_Notification

BP_Core_Notification is deprecated.

Description

Use BP_Notifications_Notification instead.

Source

File: bp-core/classes/class-bp-core-notification.php

19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
class BP_Core_Notification {
 
    /**
     * The notification id.
     *
     * @var int
     */
    public $id;
 
    /**
     * The ID to which the notification relates to within the component.
     *
     * @var int
     */
    public $item_id;
 
    /**
     * The secondary ID to which the notification relates to within the component.
     *
     * @var int
     */
    public $secondary_item_id = null;
 
    /**
     * The user ID for who the notification is for.
     *
     * @var int
     */
    public $user_id;
 
    /**
     * The name of the component that the notification is for.
     *
     * @var string
     */
    public $component_name;
 
    /**
     * The action within the component which the notification is related to.
     *
     * @var string
     */
    public $component_action;
 
    /**
     * The date the notification was created.
     *
     * @var string
     */
    public $date_notified;
 
    /**
     * Is the notification new or has it already been read.
     *
     * @var boolean
     */
    public $is_new;
 
    /** Public Methods ********************************************************/
 
    /**
     * Constructor
     *
     * @param int $id ID for the notification.
     */
    public function __construct( $id = 0 ) {
        if ( !empty( $id ) ) {
            $this->id = $id;
            $this->populate();
        }
    }
 
    /**
     * Update or insert notification details into the database.
     *
     * @global wpdb $wpdb WordPress database abstraction object.
     *
     * @return bool Success or failure.
     */
    public function save() {
        global $wpdb;
 
        $bp = buddypress();
 
        // 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.
        } 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 );
        }
 
        if ( !$result = $wpdb->query( $sql ) )
            return false;
 
        $this->id = $wpdb->insert_id;
 
        return true;
    }
 
    /** Private Methods *******************************************************/
 
    /**
     * Fetches the notification data from the database.
     *
     * @global wpdb $wpdb WordPress database abstraction object.
     */
    public function populate() {
        global $wpdb;
 
        $bp = buddypress();
 
        if ( $notification = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$bp->core->table_name_notifications} WHERE id = %d", $this->id ) ) ) {
            $this->item_id = $notification->item_id;
            $this->secondary_item_id = $notification->secondary_item_id;
            $this->user_id           = $notification->user_id;
            $this->component_name    = $notification->component_name;
            $this->component_action  = $notification->component_action;
            $this->date_notified     = $notification->date_notified;
            $this->is_new            = $notification->is_new;
        }
    }
 
    /** Static Methods ********************************************************/
 
    /**
     * Check the access for a user.
     *
     * @param int $user_id         ID to check access for.
     * @param int $notification_id Notification ID to check for.
     * @return string
     */
    public static function check_access( $user_id, $notification_id ) {
        global $wpdb;
 
        $bp = buddypress();
 
        return $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(id) FROM {$bp->core->table_name_notifications} WHERE id = %d AND user_id = %d", $notification_id, $user_id ) );
    }
 
    /**
     * Fetches all the notifications in the database for a specific user.
     *
     * @global wpdb $wpdb WordPress database abstraction object.
     *
     * @static
     *
     * @param int    $user_id User ID.
     * @param string $status 'is_new' or 'all'.
     * @return array Associative array
     */
    public static function get_all_for_user( $user_id, $status = 'is_new' ) {
        global $wpdb;
 
        $bp = buddypress();
 
        $is_new = ( 'is_new' === $status )
            ? ' AND is_new = 1 '
            : '';
 
        return $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$bp->core->table_name_notifications} WHERE user_id = %d {$is_new}", $user_id ) );
    }
 
    /**
     * Delete all the notifications for a user based on the component name and action.
     *
     * @global wpdb $wpdb WordPress database abstraction object.
     *
     * @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
     */
    public static function delete_for_user_by_type( $user_id, $component_name, $component_action ) {
        global $wpdb;
 
        $bp = buddypress();
 
        return $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->core->table_name_notifications} WHERE user_id = %d AND component_name = %s AND component_action = %s", $user_id, $component_name, $component_action ) );
    }
 
    /**
     * Delete all the notifications that have a specific item id, component name and action.
     *
     * @global wpdb $wpdb WordPress database abstraction object.
     *
     * @static
     *
     * @param int      $user_id           The ID of the user who the notifications are for.
     * @param int      $item_id           The item ID of the notifications we wish to delete.
     * @param string   $component_name    The name of the component that the notifications we wish to delete.
     * @param string   $component_action  The action of the component that the notifications we wish to delete.
     * @param int|bool $secondary_item_id (optional) The secondary item id of the notifications that we wish to
     *                                    use to delete.
     * @return mixed
     */
    public static function delete_for_user_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false ) {
        global $wpdb;
 
        $bp = buddypress();
 
        $secondary_item_sql = !empty( $secondary_item_id )
            ? $wpdb->prepare( " AND secondary_item_id = %d", $secondary_item_id )
            : '';
 
        return $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->core->table_name_notifications} WHERE user_id = %d AND item_id = %d AND component_name = %s AND component_action = %s{$secondary_item_sql}", $user_id, $item_id, $component_name, $component_action ) );
    }
 
    /**
     * Deletes all the notifications sent by a specific user, by component and action.
     *
     * @global wpdb $wpdb WordPress database abstraction 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.
     * @return mixed
     */
    public static function delete_from_user_by_type( $user_id, $component_name, $component_action ) {
        global $wpdb;
 
        $bp = buddypress();
 
        return $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->core->table_name_notifications} WHERE item_id = %d AND component_name = %s AND component_action = %s", $user_id, $component_name, $component_action ) );
    }
 
    /**
     * Deletes all the notifications for all users by item id, and optional secondary item id,
     * and component name and action.
     *
     * @global wpdb $wpdb WordPress database abstraction object.
     *
     * @static
     *
     * @param string $item_id           The item id that they notifications are to be for.
     * @param string $component_name    The component that the notifications are to be from.
     * @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.
     * @return mixed
     */
    public static function delete_all_by_type( $item_id, $component_name, $component_action, $secondary_item_id ) {
        global $wpdb;
 
        if ( $component_action )
            $component_action_sql = $wpdb->prepare( "AND component_action = %s", $component_action );
        else
            $component_action_sql = '';
 
        if ( $secondary_item_id )
            $secondary_item_sql = $wpdb->prepare( "AND secondary_item_id = %d", $secondary_item_id );
        else
            $secondary_item_sql = '';
 
        $bp = buddypress();
 
        return $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->core->table_name_notifications} WHERE item_id = %d AND component_name = %s {$component_action_sql} {$secondary_item_sql}", $item_id, $component_name ) );
    }
}

Expand full source code Collapse full source code

Methods

  • __construct — Constructor
  • check_access — Check the access for a user.
  • delete_all_by_type — Deletes all the notifications for all users by item id, and optional secondary item id, and component name and action.
  • delete_for_user_by_item_id — Delete all the notifications that have a specific item id, component name and action.
  • delete_for_user_by_type — Delete all the notifications for a user based on the component name and action.
  • delete_from_user_by_type — Deletes all the notifications sent by a specific user, by component and action.
  • get_all_for_user — Fetches all the notifications in the database for a specific user.
  • populate — Fetches the notification data from the database.
  • save — Update or insert notification details into the database.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.