Changeset 12873 for trunk/src/bp-core/classes/class-bp-invitation-manager.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-manager.php (modified) (12 diffs)

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

@@ -140 +140 @@
         // "Send" the invite if necessary.
         if ( $invite_id && $r['send_invite'] ) {
-            $sent = $this->send_invitation_by_id( $invite_id );
+            $sent = $this->send_invitation_by_id( $invite_id, $r );
             if ( ! $sent ) {
                 return false;
@@ -155 +155 @@
      * @access public
      *
-     * @param int $invitation_id ID of invitation to send.
+     * @param int   $invitation_id ID of invitation to send.
+     * @param array $args          See BP_Invitation::mark_sent().
      *
      * @return int|bool The number of rows updated, or false on error.
      */
-    public function send_invitation_by_id( $invitation_id = 0 ) {
+    public function send_invitation_by_id( $invitation_id = 0, $args = array() ) {
         $updated = false;
 
@@ -197 +198 @@
         $this->run_send_action( $invitation );
 
-        $updated = BP_Invitation::mark_sent( $invitation->id );
+        $updated = BP_Invitation::mark_sent( $invitation->id, $args );
 
         return $updated;
@@ -306 +307 @@
      * @access public
      *
-     * @param int $request_id ID of request to send.
+     * @param int   $request_id ID of request to send.
+     * @param array $args       See BP_Invitation::mark_sent().
      *
      * @return int|bool The number of rows updated, or false on error.
      */
-    public function send_request_notification_by_id( $request_id = 0 ) {
+    public function send_request_notification_by_id( $request_id = 0, $args = array() ) {
         $updated = false;
 
@@ -326 +328 @@
          * A sent invitation + a request = acceptance.
          */
-        $args = array(
+        $invite_args = array(
             'user_id'           => $request->user_id,
             'invitee_email'     => $request->invitee_email,
@@ -333 +335 @@
             'invite_sent'       => 'sent'
         );
-        $invites = $this->invitation_exists( $args );
+        $invites = $this->invitation_exists( $invite_args );
 
         if ( ! empty( $invites ) ) {
             // Accept the request.
-            return $this->accept_invitation( $args );
+            return $this->accept_invitation( $invite_args );
         }
 
@@ -343 +345 @@
         $this->run_send_action( $request );
 
-        $updated = BP_Invitation::mark_sent( $request->id );
+        $updated = BP_Invitation::mark_sent( $request->id, $args );
 
         return $updated;
@@ -453 +455 @@
      *      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 )
+     * @param array $args {
+     *     Invitation characteristics. Some basic info is required to accept an invitation,
+     *     because we'll need to accept all similar invitations and requests.
+     *
+     *     @type int    $user_id           User ID of the invitee.
+     *                                     Either 'user_id' or 'invitee_email' is required.
+     *     @type string $invitee_email     Email address of the invitee.
+     *                                     Either 'user_id' or 'invitee_email' is required.
+     *     @type int    $item_id           Item ID of the invitation to accept.
+     *     @type int    $secondary_item_id Optional. Secondary item ID if needed.
+     *     @type string $invite_sent       Optional. Defaults to only allowing the
+     *                                     acceptance of sent invitations.
+     *     @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 Number of rows updated on success, false on failure.
@@ -461 +475 @@
      public function accept_invitation( $args = array() ) {
 
-        /*
-         * Some basic info is required to accept an invitation,
-         * because we'll need to mark all similar invitations and requests.
-         * The following, except the optional 'secondary_item_id', are required.
-         */
         $r = bp_parse_args( $args, array(
             'user_id'           => 0,
@@ -472 +481 @@
             'secondary_item_id' => null,
             'invite_sent'       => 'sent',
+            'date_modified'     => bp_core_current_time(),
         ), 'accept_invitation' );
         $r['class'] = $this->class_name;
@@ -502 +512 @@
      *      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 )
+     * @param array $args {
+     *     Invitation characteristics. Some basic info is required to accept an invitation,
+     *     because we'll need to accept all similar invitations and requests.
+     *
+     *     @type int    $user_id           User ID of the invitee.
+     *     @type int    $item_id           Item ID of the invitation to accept.
+     *     @type int    $secondary_item_id Optional. Secondary item ID if needed.
+     *     @type string $date_modified     Modified time in 'Y-m-d h:i:s' format, GMT.
+     *                                     Defaults to current time if not specified.
+     * }
      *
      * @return bool Number of rows updated on success, false on failure.
      */
      public function accept_request( $args = array() ) {
-        /*
-         * Some basic info is required to accept an invitation,
-         * because we'll need to accept all similar invitations and requests.
-         * The following, except the optional 'secondary_item_id', are required.
-         */
+
         $r = bp_parse_args( $args, array(
             'user_id'           => 0,
             'item_id'           => null,
             'secondary_item_id' => null,
+            'date_modified'     => bp_core_current_time(),
         ), 'accept_request' );
         $r['class'] = $this->class_name;
@@ -619 +633 @@
      * @since 5.0.0
      *
-     * @param int $id The ID of the invitation to mark as sent.
+     * @see BP_Invitation::mark_accepted()
+     *      for a description of arguments.
      * @return bool True on success, false on failure.
      */
-    public function mark_accepted_by_id( $id ) {
-        return BP_Invitation::mark_accepted( $id );
+    public function mark_accepted_by_id( $id, $args ) {
+        return BP_Invitation::mark_accepted( $id, $args );
     }