Changeset 12873 for trunk/src/bp-core/classes/class-bp-invitation.php

Timestamp:

03/23/2021 11:31:33 PM (3 years ago)

Author:

dcavins

Message:

BP_Invitation: Increment date_modified on key actions.

When an invitation is sent or accepted, the date_modified
should be updated. However, if a date_modified has been
specified in the invitation or request creation function
(as we do in our unit test functions), the date_modified
should be set to that, even if notices are sent (now) as
part of the creation process.

Ensure that BP_Invitation::get_query_clauses() handles specified date_modified data updates.

Fixes #8444.

File:

• trunk/src/bp-core/classes/class-bp-invitation.php (modified) (9 diffs)

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

@@ -639 +639 @@
                 $where_clauses['format'][] = '%d';
             }
+        }
+
+        // date_modified
+        if ( ! empty( $args['date_modified'] ) ) {
+            $where_clauses['data']['date_modified'] = $args['date_modified'];
+            $where_clauses['format'][] = '%s';
         }
 
@@ -988 +994 @@
      * @since 5.0.0
      *
-     * @param int $id The ID of the invitation to mark as sent.
-     */
-    public static function mark_sent( $id = 0 ) {
+     * @param int   $id   The ID of the invitation to mark as sent.
+     * @param array $args {
+     *     Optional. Invitation characteristics used
+     *     to override certain sending behaviors.
+     *
+     *     @type string $date_modified Modified time in 'Y-m-d h:i:s' format, GMT.
+     *                                 Defaults to current time if not specified.
+     * }
+     * @return int|bool The number of rows updated, or false on error.
+     */
+    public static function mark_sent( $id = 0, $args = array() ) {
 
         if ( ! $id ) {
@@ -998 +1012 @@
         // Values to be updated.
         $update_args = array(
-            'invite_sent' => 'sent',
+            'invite_sent'   => 'sent',
+            'date_modified' => bp_core_current_time(),
         );
+        // Respect a specified `date-modified`.
+        if ( ! empty( $args['date_modified'] ) ) {
+            $update_args['date_modified'] = $args['date_modified'];
+        }
 
         // WHERE clauses.
@@ -1015 +1034 @@
      * @since 5.0.0
      *
-     * @param array $args See BP_Invitation::update().
+     * @param array $args See BP_Invitation::update().
+     * @return int|bool The number of rows updated, or false on error.
      */
     public static function mark_sent_by_data( $args ) {
@@ -1021 +1041 @@
         // Values to be updated.
         $update_args = array(
-            'invite_sent' => 'sent',
+            'invite_sent'   => 'sent',
+            'date_modified' => bp_core_current_time(),
         );
+        // Respect a specified `date-modified`.
+        if ( ! empty( $args['date_modified'] ) ) {
+            $update_args['date_modified'] = $args['date_modified'];
+        }
 
         return self::update( $update_args, $args );
@@ -1034 +1059 @@
      * @since 5.0.0
      *
-     * @param int $id The ID of the invitation to mark as sent.
-     */
-    public static function mark_accepted( $id = 0 ) {
+     * @param int   $id   The ID of the invitation to mark as sent.
+     * @param array $args {
+     *     Optional. Invitation characteristics used
+     *     to override certain sending behaviors.
+     *
+     *     @type string $date_modified Modified time in 'Y-m-d h:i:s' format, GMT.
+     *                                 Defaults to current time if not specified.
+     * }
+     * @return int|bool The number of rows updated, or false on error.
+     */
+    public static function mark_accepted( $id = 0, $args = array() ) {
 
         if ( ! $id ) {
@@ -1044 +1077 @@
         // Values to be updated.
         $update_args = array(
-            'accepted' => 'accepted',
+            'accepted'      => 'accepted',
+            'date_modified' => bp_core_current_time(),
         );
+        // Respect a specified `date-modified`.
+        if ( ! empty( $args['date_modified'] ) ) {
+            $update_args['date_modified'] = $args['date_modified'];
+        }
 
         // WHERE clauses.
@@ -1061 +1099 @@
      * @since 5.0.0
      *
-     * @param array $args See BP_Invitation::update().
+     * @param array $args See BP_Invitation::update().
+     * @return int|bool The number of rows updated, or false on error.
      */
     public static function mark_accepted_by_data( $args ) {
@@ -1067 +1106 @@
         // Values to be updated.
         $update_args = array(
-            'accepted' => 'accepted',
+            'accepted'      => 'accepted',
+            'date_modified' => bp_core_current_time(),
         );
+        // Respect a specified `date-modified`.
+        if ( ! empty( $args['date_modified'] ) ) {
+            $update_args['date_modified'] = $args['date_modified'];
+        }
 
         return self::update( $update_args, $args );