- Timestamp:
- 09/24/2015 11:55:02 PM (10 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-notifications/classes/class-bp-notifications-notification.php
r9993 r10138 8 8 * @subpackage NotificationsClasses 9 9 * 10 * @since BuddyPress (1.9.0)10 * @since 1.9.0 11 11 */ 12 12 13 // Exit if accessed directly 13 // Exit if accessed directly. 14 14 defined( 'ABSPATH' ) || exit; 15 15 … … 19 19 * Use this class to create, access, edit, or delete BuddyPress Notifications. 20 20 * 21 * @since BuddyPress (1.9.0)21 * @since 1.9.0 22 22 */ 23 23 class BP_Notifications_Notification { … … 26 26 * The notification ID. 27 27 * 28 * @since BuddyPress (1.9.0)28 * @since 1.9.0 29 29 * @access public 30 30 * @var int … … 35 35 * The ID of the item associated with the notification. 36 36 * 37 * @since BuddyPress (1.9.0)37 * @since 1.9.0 38 38 * @access public 39 39 * @var int … … 44 44 * The ID of the secondary item associated with the notification. 45 45 * 46 * @since BuddyPress (1.9.0)46 * @since 1.9.0 47 47 * @access public 48 48 * @var int … … 53 53 * The ID of the user the notification is associated with. 54 54 * 55 * @since BuddyPress (1.9.0)55 * @since 1.9.0 56 56 * @access public 57 57 * @var int … … 62 62 * The name of the component that the notification is for. 63 63 * 64 * @since BuddyPress (1.9.0)64 * @since 1.9.0 65 65 * @access public 66 66 * @var string … … 71 71 * The component action which the notification is related to. 72 72 * 73 * @since BuddyPress (1.9.0)73 * @since 1.9.0 74 74 * @access public 75 75 * @var string … … 80 80 * The date the notification was created. 81 81 * 82 * @since BuddyPress (1.9.0)82 * @since 1.9.0 83 83 * @access public 84 84 * @var string … … 89 89 * Is the notification new, or has it already been read. 90 90 * 91 * @since BuddyPress (1.9.0)91 * @since 1.9.0 92 92 * @access public 93 93 * @var bool … … 100 100 * Constructor method. 101 101 * 102 * @since BuddyPress (1.9.0)102 * @since 1.9.0 103 103 * 104 104 * @param int $id Optional. Provide an ID to access an existing … … 115 115 * Update or insert notification details into the database. 116 116 * 117 * @since BuddyPress (1.9.0)117 * @since 1.9.0 118 118 * 119 119 * @global wpdb $wpdb WordPress database object. … … 143 143 * Please use this hook to filter the properties above. Each part will be passed in. 144 144 * 145 * @since BuddyPress (2.0.0)145 * @since 2.0.0 146 146 * 147 147 * @param BP_Notifications_Notification $value Current instance of the notification item being saved. Passed by reference. … … 169 169 * Fires after the current notification item gets saved. 170 170 * 171 * @since BuddyPress (2.0.0)171 * @since 2.0.0 172 172 * 173 173 * @param BP_Notifications_Notification $value Current instance of the notification item being saved. Passed by reference. … … 182 182 * Fetch data for an existing notification from the database. 183 183 * 184 * @since BuddyPress (1.9.0)184 * @since 1.9.0 185 185 * 186 186 * @global BuddyPress $bp The one true BuddyPress instance. … … 212 212 * Create a notification entry. 213 213 * 214 * @since BuddyPress (1.9.0)214 * @since 1.9.0 215 215 * 216 216 * @param array $data { … … 236 236 * Update notifications. 237 237 * 238 * @since BuddyPress (1.9.0)238 * @since 1.9.0 239 239 * 240 240 * @see wpdb::update() for further description of paramater formats. … … 259 259 * Delete notifications. 260 260 * 261 * @since BuddyPress (1.9.0)261 * @since 1.9.0 262 262 * 263 263 * @see wpdb::update() for further description of paramater formats. … … 281 281 * clause. 282 282 * 283 * @since BuddyPress (1.9.0)283 * @since 1.9.0 284 284 * 285 285 * @param array $args See {@link BP_Notifications_Notification::get()} … … 382 382 * Filters the MySQL WHERE conditions for the Notifications items get method. 383 383 * 384 * @since BuddyPress (2.3.0)384 * @since 2.3.0 385 385 * 386 386 * @param array $where_conditions Current conditions for MySQL WHERE statement. … … 407 407 * clause. 408 408 * 409 * @since BuddyPress (1.9.0)409 * @since 1.9.0 410 410 * 411 411 * @param array $args See {@link BP_Notifications_Notification::get()} … … 445 445 * Used by BP_Notifications_Notification::get() to create its LIMIT clause. 446 446 * 447 * @since BuddyPress (1.9.0)447 * @since 1.9.0 448 448 * 449 449 * @param array $args See {@link BP_Notifications_Notification::get()} … … 503 503 * which can easily be passed as arguments to the $wpdb methods. 504 504 * 505 * @since BuddyPress (1.9.0)505 * @since 1.9.0 506 506 * 507 507 * @param array $args Associative array of filter arguments. … … 567 567 * Check that a specific notification is for a specific user. 568 568 * 569 * @since BuddyPress (1.9.0)569 * @since 1.9.0 570 570 * 571 571 * @param int $user_id ID of the user being checked. … … 614 614 * Get notifications, based on provided filter parameters. 615 615 * 616 * @since BuddyPress (1.9.0)616 * @since 1.9.0 617 617 * 618 618 * @param array $args { … … 703 703 * Get a count of total notifications matching a set of arguments. 704 704 * 705 * @since BuddyPress (1.9.0)705 * @since 1.9.0 706 706 * 707 707 * @see BP_Notifications_Notification::get() for a description of … … 762 762 * AND keyword from the 'where' clause). 763 763 * 764 * @since BuddyPress (2.3.0)764 * @since 2.3.0 765 765 * 766 766 * @param array $meta_query An array of meta_query filters. See the … … 804 804 * the leading AND keyword from the query). 805 805 * 806 * @since BuddyPress (2.3.0)806 * @since 2.3.0 807 807 * 808 808 * @param array $date_query An array of date_query parameters. See the … … 828 828 * Update notifications. 829 829 * 830 * @since BuddyPress (1.9.0)830 * @since 1.9.0 831 831 * 832 832 * @see BP_Notifications_Notification::get() for a description of … … 849 849 * Fires before the update of a notification item. 850 850 * 851 * @since BuddyPress (2.3.0)851 * @since 2.3.0 852 852 * 853 853 * @param array $update_args See BP_Notifications_Notification::update(). … … 867 867 * Delete notifications. 868 868 * 869 * @since BuddyPress (1.9.0)869 * @since 1.9.0 870 870 * 871 871 * @see BP_Notifications_Notification::get() for a description of … … 884 884 * Fires before the deletion of a notification item. 885 885 * 886 * @since BuddyPress (2.0.0)886 * @since 2.0.0 887 887 * 888 888 * @param array $args Associative array of columns/values, to determine … … 900 900 * Delete a single notification by ID. 901 901 * 902 * @since BuddyPress (1.9.0)902 * @since 1.9.0 903 903 * 904 904 * @see BP_Notifications_Notification::delete() for explanation of … … 918 918 * Fetch all the notifications in the database for a specific user. 919 919 * 920 * @since BuddyPress (1.9.0)920 * @since 1.9.0 921 921 * 922 922 * @param int $user_id ID of the user whose notifications are being … … 937 937 * Fetch all the unread notifications in the database for a specific user. 938 938 * 939 * @since BuddyPress (1.9.0)939 * @since 1.9.0 940 940 * 941 941 * @param int $user_id ID of the user whose notifications are being … … 954 954 * Fetch all the read notifications in the database for a specific user. 955 955 * 956 * @since BuddyPress (1.9.0)956 * @since 1.9.0 957 957 * 958 958 * @param int $user_id ID of the user whose notifications are being … … 971 971 * Get unread notifications for a user, in a pagination-friendly format. 972 972 * 973 * @since BuddyPress (1.9.0)973 * @since 1.9.0 974 974 * 975 975 * @param array $args { … … 1017 1017 * Mark all user notifications as read. 1018 1018 * 1019 * @since BuddyPress (1.9.0)1019 * @since 1.9.0 1020 1020 * 1021 1021 * @param int $user_id The ID of the user who the notifications are for. … … 1062 1062 * Mark all notifications from a user as read. 1063 1063 * 1064 * @since BuddyPress (1.9.0)1064 * @since 1.9.0 1065 1065 * 1066 1066 * @param int $user_id The ID of the user who the notifications are from. … … 1103 1103 * secondary item id, and component name and action. 1104 1104 * 1105 * @since BuddyPress (1.9.0)1105 * @since 1.9.0 1106 1106 * 1107 1107 * @param int $item_id The ID of the item associated with the
Note: See TracChangeset
for help on using the changeset viewer.