BuddyPress/buddypress
1
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/buddypress/buddypress.git synced 2026-05-31 05:04:29 +08:00
Code Packages Activity Actions
buddypress/bp-notifications/bp-notifications-classes.php

897 lines
26 KiB
PHP
Raw Permalink Blame History

<?php
/**
* BuddyPress Notifications Classes
*
* Classes used for the Notifications component.
*
* @package BuddyPress
* @subpackage NotificationsClasses
*
* @since BuddyPress (1.9.0)
*/
// Exit if accessed directly
if ( !defined( 'ABSPATH' ) ) exit;
/**
* BuddyPress Notification items.
*
* Use this class to create, access, edit, or delete BuddyPress Notifications.
*
* @since BuddyPress (1.9.0)
*/
class BP_Notifications_Notification {
/**
* The notification ID.
*
* @var int
*/
public $id;
/**
* The ID of the item associated with the notification.
*
* @var int
*/
public $item_id;
/**
* The ID of the secondary item associated with the notification.
*
* @var int
*/
public $secondary_item_id = null;
/**
* The ID of the user the notification is associated with.
*
* @var int
*/
public $user_id;
/**
* The name of the component that the notification is for.
*
* @var string
*/
public $component_name;
/**
* The component action 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 bool
*/
public $is_new;
/** Public Methods ****************************************************/
/**
* Constructor method.
*
* @since BuddyPress (1.9.0)
*
* @param int $id Optional. Provide an ID to access an existing
* notification item.
*/
public function __construct( $id = 0 ) {
if ( ! empty( $id ) ) {
$this->id = $id;
$this->populate();
}
}
/**
* Update or insert notification details into the database.
*
* @since BuddyPress (1.9.0)
*
* @global wpdb $wpdb WordPress database object.
*
* @return bool True on success, false on failure.
*/
public function save() {
// Return value
$retval = false;
// Default data and format
$data = array(
'user_id' => $this->user_id,
'item_id' => $this->item_id,
'secondary_item_id' => $this->secondary_item_id,
'component_name' => $this->component_name,
'component_action' => $this->component_action,
'date_notified' => $this->date_notified,
'is_new' => $this->is_new,
);
$data_format = array( '%d', '%d', '%d', '%s', '%s', '%s', '%d' );
// Update
if ( ! empty( $this->id ) ) {
$result = self::_update( $data, array( 'ID' => $this->id ), $data_format, array( '%d' ) );
// Insert
} else {
$result = self::_insert( $data, $data_format );
}
// Set the notification ID if successful
if ( ! empty( $result ) && ! is_wp_error( $result ) ) {
global $wpdb;
$this->id = $wpdb->insert_id;
$retval = $wpdb->insert_id;
}
// Return the result
return $retval;
}
/**
* Fetch data for an existing notification from the database.
*
* @since BuddyPress (1.9.0)
*
* @global BuddyPress $bp The one true BuddyPress instance.
* @global wpdb $wpdb WordPress database object.
*/
public function populate() {
global $wpdb;
$bp = buddypress();
// Look for a notification
$notification = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$bp->notifications->table_name} WHERE id = %d", $this->id ) );
// Setup the notification data
if ( ! empty( $notification ) && ! is_wp_error( $notification ) ) {
$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;
}
}
/** Protected Static Methods ******************************************/
/**
* Create a notification entry.
*
* @since BuddyPress (1.9.0)
*
* @param array $data {
* Array of notification data, passed to {@link wpdb::insert()}.
* @type int $user_id ID of the associated user.
* @type int $item_id ID of the associated item.
* @type int $secondary_item_id ID of the secondary associated item.
* @type string $component_name Name of the associated component.
* @type string $component_action Name of the associated component
* action.
* @type string $date_notified Timestamp of the notification.
* @type bool $is_new True if the notification is unread, otherwise
* false.
* }
* @param array $data_format See {@link wpdb::insert()}.
* @return int|false The number of rows inserted, or false on error.
*/
protected static function _insert( $data = array(), $data_format = array() ) {
global $wpdb;
return $wpdb->insert( buddypress()->notifications->table_name, $data, $data_format );
}
/**
* Update notifications.
*
* @since BuddyPress (1.9.0)
*
* @see wpdb::update() for further description of paramater formats.
*
* @param array $data Array of notification data to update, passed to
* {@link wpdb::update()}. Accepts any property of a
* BP_Notification_Notification object.
* @param array $where The WHERE params as passed to wpdb::update().
* Typically consists of array( 'ID' => $id ) to specify the ID
* of the item being updated. See {@link wpdb::update()}.
* @param array $data_format See {@link wpdb::insert()}.
* @param array $where_format See {@link wpdb::insert()}.
* @return int|false The number of rows updated, or false on error.
*/
protected static function _update( $data = array(), $where = array(), $data_format = array(), $where_format = array() ) {
global $wpdb;
return $wpdb->update( buddypress()->notifications->table_name, $data, $where, $data_format, $where_format );
}
/**
* Delete notifications.
*
* @since BuddyPress (1.9.0)
*
* @see wpdb::update() for further description of paramater formats.
*
* @param array $where Array of WHERE clauses to filter by, passed to
* {@link wpdb::delete()}. Accepts any property of a
* BP_Notification_Notification object.
* @param array $where_format See {@link wpdb::insert()}.
* @return int|false The number of rows updated, or false on error.
*/
protected static function _delete( $where = array(), $where_format = array() ) {
global $wpdb;
return $wpdb->delete( buddypress()->notifications->table_name, $where, $where_format );
}
/**
* Assemble the WHERE clause of a get() SQL statement.
*
* Used by BP_Notifications_Notification::get() to create its WHERE
* clause.
*
* @since BuddyPress (1.9.0)
*
* @param array $args See {@link BP_Notifications_Notification::get()}
* for more details.
* @return string WHERE clause.
*/
protected static function get_where_sql( $args = array() ) {
global $wpdb;
$where_conditions = array();
$where = '';
// id
if ( ! empty( $args['id'] ) ) {
$id_in = implode( ',', wp_parse_id_list( $args['id'] ) );
$where_conditions['id'] = "id IN ({$id_in})";
}
// user_id
if ( ! empty( $args['user_id'] ) ) {
$user_id_in = implode( ',', wp_parse_id_list( $args['user_id'] ) );
$where_conditions['user_id'] = "user_id IN ({$user_id_in})";
}
// item_id
if ( ! empty( $args['item_id'] ) ) {
$item_id_in = implode( ',', wp_parse_id_list( $args['item_id'] ) );
$where_conditions['item_id'] = "item_id IN ({$item_id_in})";
}
// secondary_item_id
if ( ! empty( $args['secondary_item_id'] ) ) {
$secondary_item_id_in = implode( ',', wp_parse_id_list( $args['secondary_item_id'] ) );
$where_conditions['secondary_item_id'] = "secondary_item_id IN ({$secondary_item_id_in})";
}
// component_name
if ( ! empty( $args['component_name'] ) ) {
if ( ! is_array( $args['component_name'] ) ) {
$component_names = explode( ',', $args['component_name'] );
} else {
$component_names = $args['component_name'];
}
$cn_clean = array();
foreach ( $component_names as $cn ) {
$cn_clean[] = $wpdb->prepare( '%s', $cn );
}
$cn_in = implode( ',', $cn_clean );
$where_conditions['component_name'] = "component_name IN ({$cn_in})";
}
// component_action
if ( ! empty( $args['component_action'] ) ) {
if ( ! is_array( $args['component_action'] ) ) {
$component_actions = explode( ',', $args['component_action'] );
} else {
$component_actions = $args['component_action'];
}
$ca_clean = array();
foreach ( $component_actions as $ca ) {
$ca_clean[] = $wpdb->prepare( '%s', $ca );
}
$ca_in = implode( ',', $ca_clean );
$where_conditions['component_action'] = "component_action IN ({$ca_in})";
}
// is_new
if ( ! empty( $args['is_new'] ) ) {
$where_conditions['is_new'] = "is_new = 1";
} elseif ( ( 0 === $args['is_new'] ) || ( false === $args['is_new'] ) ) {
$where_conditions['is_new'] = "is_new = 0";
}
// search_terms
if ( ! empty( $args['search_terms'] ) ) {
$search_terms = like_escape( esc_sql( $args['search_terms'] ) );
$where_conditions['search_terms'] = "( component_name LIKE '%%$search_terms%%' OR component_action LIKE '%%$search_terms%%' )";
}
// Custom WHERE
if ( ! empty( $where_conditions ) ) {
$where = 'WHERE ' . implode( ' AND ', $where_conditions );
}
return $where;
}
/**
* Assemble the ORDER BY clause of a get() SQL statement.
*
* Used by BP_Notifications_Notification::get() to create its ORDER BY
* clause.
*
* @since BuddyPress (1.9.0)
*
* @param array $args See {@link BP_Notifications_Notification::get()}
* for more details.
* @return string ORDER BY clause.
*/
protected static function get_order_by_sql( $args = array() ) {
// Setup local variable
$conditions = array();
$retval = '';
// Order by
if ( ! empty( $args['order_by'] ) ) {
$order_by = implode( ', ', (array) $args['order_by'] );
$conditions['order_by'] = "{$order_by}";
}
// Sort order direction
if ( ! empty( $args['sort_order'] ) && in_array( $args['sort_order'], array( 'ASC', 'DESC' ) ) ) {
$sort_order = $args['sort_order'];
$conditions['sort_order'] = "{$sort_order}";
}
// Custom ORDER BY
if ( ! empty( $conditions ) ) {
$retval = 'ORDER BY ' . implode( ' ', $conditions );
}
return $retval;
}
/**
* Assemble the LIMIT clause of a get() SQL statement.
*
* Used by BP_Notifications_Notification::get() to create its LIMIT clause.
*
* @since BuddyPress (1.9.0)
*
* @param array $args See {@link BP_Notifications_Notification::get()}
* for more details.
* @return string LIMIT clause.
*/
protected static function get_paged_sql( $args = array() ) {
global $wpdb;
// Setup local variable
$retval = '';
// Custom LIMIT
if ( ! empty( $args['page'] ) && ! empty( $args['per_page'] ) ) {
$page = absint( $args['page'] );
$per_page = absint( $args['per_page'] );
$offset = $per_page * ( $page - 1 );
$retval = $wpdb->prepare( "LIMIT %d, %d", $offset, $per_page );
}
return $retval;
}
/**
* Assemble query clauses, based on arrguments, to pass to $wpdb methods.
*
* The insert(), update(), and delete() methods of {@link wpdb} expect
* arguments of the following forms:
*
* - associative arrays whose key/value pairs are column => value, to
* be used in WHERE, SET, or VALUES clauses
* - arrays of "formats", which tell $wpdb->prepare() which type of
* value to expect when sanitizing (eg, array( '%s', '%d' ))
*
* This utility method can be used to assemble both kinds of params,
* out of a single set of associative array arguments, such as:
*
* $args = array(
* 'user_id' => 4,
* 'component_name' => 'groups',
* );
*
* This will be converted to:
*
* array(
* 'data' => array(
* 'user_id' => 4,
* 'component_name' => 'groups',
* ),
* 'format' => array(
* '%d',
* '%s',
* ),
* )
*
* which can easily be passed as arguments to the $wpdb methods.
*
* @since BuddyPress (1.9.0)
*
* @param $args Associative array of filter arguments.
* See {@BP_Notifications_Notification::get()} for a breakdown.
* @return array Associative array of 'data' and 'format' args.
*/
protected static function get_query_clauses( $args = array() ) {
$where_clauses = array(
'data' => array(),
'format' => array(),
);
// id
if ( ! empty( $args['id'] ) ) {
$where_clauses['data']['id'] = absint( $args['id'] );
$where_clauses['format'][] = '%d';
}
// user_id
if ( ! empty( $args['user_id'] ) ) {
$where_clauses['data']['user_id'] = absint( $args['user_id'] );
$where_clauses['format'][] = '%d';
}
// item_id
if ( ! empty( $args['item_id'] ) ) {
$where_clauses['data']['item_id'] = absint( $args['item_id'] );
$where_clauses['format'][] = '%d';
}
// secondary_item_id
if ( ! empty( $args['secondary_item_id'] ) ) {
$where_clauses['data']['secondary_item_id'] = absint( $args['secondary_item_id'] );
$where_clauses['format'][] = '%d';
}
// component_name
if ( ! empty( $args['component_name'] ) ) {
$where_clauses['data']['component_name'] = $args['component_name'];
$where_clauses['format'][] = '%s';
}
// component_action
if ( ! empty( $args['component_action'] ) ) {
$where_clauses['data']['component_action'] = $args['component_action'];
$where_clauses['format'][] = '%s';
}
// is_new
if ( isset( $args['is_new'] ) ) {
$where_clauses['data']['is_new'] = ! empty( $args['is_new'] ) ? 1 : 0;
$where_clauses['format'][] = '%d';
}
return $where_clauses;
}
/** Public Static Methods *********************************************/
/**
* Check that a specific notification is for a specific user.
*
* @since BuddyPress (1.9.0)
*
* @param int $user_id ID of the user being checked.
* @param int $notification_id ID of the notification being checked.
* @return bool True if the notification belongs to the user, otherwise
* false.
*/
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 ) );
}
/**
* Get notifications, based on provided filter parameters.
*
* @since BuddyPress (1.9.0)
*
* @param array $args {
* Associative array of arguments. All arguments but $page and
* $per_page can be treated as filter values for get_where_sql()
* and get_query_clauses(). All items are optional.
* @type int|array $id ID of notification being updated. Can be an
* array of IDs.
* @type int|array $user_id ID of user being queried. Can be an
* array of user IDs.
* @type int|array $item_id ID of associated item. Can be an array
* of multiple item IDs.
* @type int|array $secondary_item_id ID of secondary associated
* item. Can be an array of multiple IDs.
* @type string|array $component_name Name of the component to
* filter by. Can be an array of component names.
* @type string|array $component_action Name of the action to
* filter by. Can be an array of actions.
* @type bool $is_new Whether to limit the query to is_new (unread)
* notifications. Default: true.
* @type string $search_terms Term to match against component_name
* or component_action fields.
* @type int $page Number of the current page of results. Default:
* false (no pagination - all items).
* @type int $per_page Number of items to show per page. Default:
* false (no pagination - all items).
* }
* @return array Located notifications.
*/
public static function get( $args = array() ) {
global $wpdb;
// Parse the arguments
$r = wp_parse_args( $args, array(
'id' => false,
'user_id' => false,
'item_id' => false,
'secondary_item_id' => false,
'component_name' => false,
'component_action' => false,
'is_new' => true,
'search_terms' => '',
'order_by' => false,
'sort_order' => false,
'page' => false,
'per_page' => false,
) );
// SELECT
$select_sql = "SELECT *";
// FROM
$from_sql = "FROM " . buddypress()->notifications->table_name;
// WHERE
$where_sql = self::get_where_sql( array(
'id' => $r['id'],
'user_id' => $r['user_id'],
'item_id' => $r['item_id'],
'secondary_item_id' => $r['secondary_item_id'],
'component_name' => $r['component_name'],
'component_action' => $r['component_action'],
'is_new' => $r['is_new'],
'search_terms' => $r['search_terms'],
) );
// ORDER BY
$order_sql = self::get_order_by_sql( array(
'order_by' => $r['order_by'],
'sort_order' => $r['sort_order']
) );
// LIMIT %d, %d
$pag_sql = self::get_paged_sql( array(
'page' => $r['page'],
'per_page' => $r['per_page'],
) );
$sql = "{$select_sql} {$from_sql} {$where_sql} {$order_sql} {$pag_sql}";
return $wpdb->get_results( $sql );
}
/**
* Get a count of total notifications matching a set of arguments.
*
* @since BuddyPress (1.9.0)
*
* @see BP_Notifications_Notification::get() for a description of
* arguments.
*
* @param array $args See {@link BP_Notifications_Notification::get()}.
* @return int Count of located items.
*/
public static function get_total_count( $args ) {
global $wpdb;
$bp = buddypress();
$select_sql = "SELECT COUNT(*)";
$from_sql = "FROM {$bp->notifications->table_name}";
$where_sql = self::get_where_sql( $args );
$sql = "{$select_sql} {$from_sql} {$where_sql}";
return $wpdb->get_var( $sql );
}
/**
* Update notifications.
*
* @since BuddyPress (1.9.0)
*
* @see BP_Notifications_Notification::get() for a description of
* accepted update/where arguments.
*
* @param array $update_args Associative array of fields to update,
* and the values to update them to. Of the format
* array( 'user_id' => 4, 'component_name' => 'groups', )
* @param array $where_args Associative array of columns/values, to
* 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.
*/
public static function update( $update_args = array(), $where_args = array() ) {
$update = self::get_query_clauses( $update_args );
$where = self::get_query_clauses( $where_args );
return self::_update( $update['data'], $where['data'], $update['format'], $where['format'] );
}
/**
* Delete notifications.
*
* @since BuddyPress (1.9.0)
*
* @see BP_Notifications_Notification::get() for a description of
* accepted update/where arguments.
*
* @param array $args Associative array of columns/values, to determine
* 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.
*/
public static function delete( $args = array() ) {
$where = self::get_query_clauses( $args );
return self::_delete( $where['data'], $where['format'] );
}
/** Convenience methods ***************************************************/
/**
* Delete a single notification by ID.
*
* @since BuddyPress (1.9.0)
*
* @see BP_Notifications_Notification::delete() for explanation of
* return value.
*
* @param int $id ID of the notification item to be deleted.
* @return bool True on success, false on failure.
*/
public static function delete_by_id( $id ) {
return self::delete( array(
'id' => $id,
) );
}
/**
* Fetch all the notifications in the database for a specific user.
*
* @since BuddyPress (1.9.0)
*
* @param int $user_id ID of the user whose notifications are being
* fetched.
* @param string $status Optional. Status of notifications to fetch.
* 'is_new' to get only unread items, 'all' to get all.
* @return array Associative array of notification items.
*/
public static function get_all_for_user( $user_id, $status = 'is_new' ) {
return self::get( array(
'user_id' => $user_id,
'is_new' => 'is_new' === $status,
) );
}
/**
* Fetch all the unread notifications in the database for a specific user.
*
* @since BuddyPress (1.9.0)
*
* @param int $user_id ID of the user whose notifications are being
* fetched.
* @return array Associative array of unread notification items.
*/
public static function get_unread_for_user( $user_id = 0 ) {
return self::get( array(
'user_id' => $user_id,
'is_new' => true,
) );
}
/**
* Fetch all the read notifications in the database for a specific user.
*
* @since BuddyPress (1.9.0)
*
* @param int $user_id ID of the user whose notifications are being
* fetched.
* @return array Associative array of unread notification items.
*/
public static function get_read_for_user( $user_id = 0 ) {
return self::get( array(
'user_id' => $user_id,
'is_new' => false,
) );
}
/**
* Get unread notifications for a user, in a pagination-friendly format.
*
* @since BuddyPress (1.9.0)
*
* @param array $args {
* Array of arguments.
* @type int $user_id ID of the user for whom the notifications are
* being fetched. Default: logged-in user ID.
* @type bool $is_new Whether to limit the query to unread
* notifications. Default: true.
* @type int $page Number of the page to return. Default: 1.
* @type int $per_page Number of results to display per page.
* Default: 10.
* @type string $search_terms Optional. A term to search against in
* the 'component_name' and 'component_action' columns.
* }
* @return array {
* @type array $notifications Array of notification results.
* @type int $total Count of all located notifications matching
* the query params.
* }
*/
public static function get_current_notifications_for_user( $args = array() ) {
$r = wp_parse_args( $args, array(
'user_id' => bp_loggedin_user_id(),
'is_new' => true,
'page' => 1,
'per_page' => 25,
'search_terms' => '',
) );
$notifications = self::get( $r );
// Bail if no notifications
if ( empty( $notifications ) ) {
return false;
}
$total_count = self::get_total_count( $r );
return array( 'notifications' => &$notifications, 'total' => $total_count );
}
/** Mark ******************************************************************/
/**
* Mark all user notifications as read.
*
* @since BuddyPress (1.9.0)
*
* @param int $user_id The ID of the user who the notifications
* are for.
* @param int $is_new Mark as read (1) or unread (0).
*/
public static function mark_all_for_user( $user_id, $is_new = 0, $item_id = 0, $component_name = '', $component_action = '', $secondary_item_id = 0 ) {
// Values to be updated
$update_args = array(
'is_new' => $is_new,
);
// WHERE clauses
$where_args = array(
'user_id' => $user_id,
);
if ( ! empty( $item_id ) ) {
$where_args['item_id'] = $item_id;
}
if ( ! empty( $component_name ) ) {
$where_args['component_name'] = $component_name;
}
if ( ! empty( $component_action ) ) {
$where_args['component_action'] = $component_action;
}
if ( ! empty( $secondary_item_id ) ) {
$where_args['secondary_item_id'] = $secondary_item_id;
}
return self::update( $update_args, $where_args );
}
/**
* Mark all notifications from a user as read.
*
* @since BuddyPress (1.9.0)
*
* @param int $user_id The ID of the user who the notifications are from.
* @param int $is_new Mark as read (1) or unread (0).
*/
public static function mark_all_from_user( $user_id, $is_new = 0, $component_name = '', $component_action = '', $secondary_item_id = 0 ) {
// Values to be updated
$update_args = array(
'is_new' => $is_new,
);
// WHERE clauses
$where_args = array(
'item_id' => $user_id,
);
if ( ! empty( $component_name ) ) {
$where_args['component_name'] = $component_name;
}
if ( ! empty( $component_action ) ) {
$where_args['component_action'] = $component_action;
}
if ( ! empty( $secondary_item_id ) ) {
$where_args['secondary_item_id'] = $secondary_item_id;
}
return self::update( $update_args, $where_args );
}
/**
* Mark all notifications for all users as read by item id, and optional
* secondary item id, and component name and action.
*
* @since BuddyPress (1.9.0)
*
* @param int $item_id The ID of the item associated with the
* notifications.
* @param string $component_name The component that the notifications
* are associated with.
* @param string $component_action The action that the notifications
* are associated with.
* @param string $secondary_item_id Optional. ID of the secondary
* associated item.
*/
public static function mark_all_by_type( $item_id, $is_new = 0, $component_name = '', $component_action = '', $secondary_item_id = 0 ) {
// Values to be updated
$update_args = array(
'is_new' => $is_new,
);
// WHERE clauses
$where_args = array(
'item_id' => $item_id,
);
if ( ! empty( $component_name ) ) {
$where_args['component_name'] = $component_name;
}
if ( ! empty( $component_action ) ) {
$where_args['component_action'] = $component_action;
}
if ( ! empty( $secondary_item_id ) ) {
$where_args['secondary_item_id'] = $secondary_item_id;
}
return self::update( $update_args, $where_args );
}
}
View git blame Copy permalink