Changeset 5917

Timestamp:

08/16/2015 06:43:03 AM (9 years ago)

Author:

netweb

Message:

Topics: Return string in bbp_update_forum_last_active_time()

Includes updated PHPdocs and unit tests for bbp_update_topic_last_*() functions.

Props thebrandonallen. See #2811

Location:

trunk

Files:

• src/includes/topics/functions.php (modified) (1 diff)
• tests/phpunit/testcases/topics/functions/update-last-thing.php (modified) (2 diffs)

trunk/src/includes/topics/functions.php

@@ -2588 +2588 @@
  * Update the topics last active date/time (aka freshness)
  *
- * @since bbPress (r2680)
- *
- * @param int $topic_id Optional. Topic id
- * @param string $new_time Optional. New time in mysql format
+ * @since 2.0.0 bbPress (r2680)
+ *
+ * @param int    $topic_id Optional. Topic id.
+ * @param string $new_time Optional. New time in mysql format.
+ * @uses bbp_is_reply() To check if the passed topic id is a reply
  * @uses bbp_get_topic_id() To get the topic id
  * @uses bbp_get_reply_topic_id() To get the reply topic id
- * @uses current_time() To get the current time
- * @uses update_post_meta() To update the topic last active meta
- * @return bool True on success, false on failure
+ * @uses get_post_field() To get the timestamp of the newest topic reply
+ * @uses bbp_get_public_child_last_id() To get the newest topic reply id
+ * @uses bbp_get_reply_post_type() To get the reply post type
+ * @uses update_post_meta() To update the topic last active time meta
+ * @return string MySQL timestamp of last active reply
  */
 function bbp_update_topic_last_active_time( $topic_id = 0, $new_time = '' ) {

trunk/tests/phpunit/testcases/topics/functions/update-last-thing.php

@@ -1 +1 @@
 <?php
-
 /**
  * Tests for the `bbp_update_topic_last_*()` functions.
@@ -8 +7 @@
  * @group update_last_thing
  */
+
 class BBP_Tests_Topics_Functions_Update_Topic_Last_Thing extends BBP_UnitTestCase {
 
     /**
      * @covers ::bbp_update_topic_last_active_id
-     * @todo   Implement test_bbp_update_topic_last_active_id().
      */
     public function test_bbp_update_topic_last_active_id() {
-        // Remove the following lines when you implement this test.
-        $this->markTestIncomplete(
-            'This test has not been implemented yet.'
-        );
+        $f = $this->factory->forum->create();
+        $t = $this->factory->topic->create( array(
+            'post_parent' => $f,
+            'topic_meta' => array(
+                'forum_id' => $f,
+            ),
+        ) );
+        $r1 = $this->factory->reply->create( array(
+            'post_parent' => $t,
+            'reply_meta' => array(
+                'forum_id' => $f,
+                'topic_id' => $t,
+            ),
+        ) );
+
+        $id = bbp_update_topic_last_active_id( $t, $r1 );
+        $this->assertSame( $r1, $id );
+
+        $id = bbp_get_topic_last_active_id( $t );
+        $this->assertSame( $r1, $id );
+
+        $r2 = $this->factory->reply->create_many( 2, array(
+            'post_parent' => $t,
+            'reply_meta' => array(
+                'forum_id' => $f,
+                'topic_id' => $t,
+            ),
+        ) );
+
+        bbp_update_topic_last_active_id( $t );
+        $id = bbp_get_topic_last_active_id( $t );
+        $this->assertSame( $r2[1], $id );
     }
 
     /**
      * @covers ::bbp_update_topic_last_active_time
-     * @todo   Implement test_bbp_update_topic_last_active_time().
      */
     public function test_bbp_update_topic_last_active_time() {
-        // Remove the following lines when you implement this test.
-        $this->markTestIncomplete(
-            'This test has not been implemented yet.'
-        );
+        $f = $this->factory->forum->create();
+        $t = $this->factory->topic->create( array(
+            'post_parent' => $f,
+            'topic_meta' => array(
+                'forum_id' => $f,
+            ),
+        ) );
+        $r1 = $this->factory->reply->create( array(
+            'post_parent' => $t,
+            'reply_meta' => array(
+                'forum_id' => $f,
+                'topic_id' => $t,
+            ),
+        ) );
+
+        $r1_time_raw       = get_post_field( 'post_date', $r1 );
+        $r1_time_formatted = bbp_get_time_since( bbp_convert_date( $r1_time_raw ) );
+
+        $time = bbp_update_topic_last_active_time( $t, $r1_time_raw );
+        $this->assertSame( $r1_time_raw, $time );
+
+        $time = bbp_get_topic_last_active_time( $t );
+        $this->assertSame( $r1_time_formatted, $time );
+
+        $r2 = $this->factory->reply->create_many( 2, array(
+            'post_parent' => $t,
+            'reply_meta' => array(
+                'forum_id' => $f,
+                'topic_id' => $t,
+            ),
+        ) );
+
+        $r2_time_raw       = get_post_field( 'post_date', $r2[1] );
+        $r2_time_formatted = bbp_get_time_since( bbp_convert_date( $r2_time_raw ) );
+
+        bbp_update_topic_last_active_time( $t );
+        $time = bbp_get_topic_last_active_time( $t );
+        $this->assertSame( $r2_time_formatted, $time );
     }
 
     /**
      * @covers ::bbp_update_topic_last_reply_id
-     * @todo   Implement test_bbp_update_topic_last_reply_id().
      */
     public function test_bbp_update_topic_last_reply_id() {
-        // Remove the following lines when you implement this test.
-        $this->markTestIncomplete(
-            'This test has not been implemented yet.'
-        );
+        $f = $this->factory->forum->create();
+        $t = $this->factory->topic->create( array(
+            'post_parent' => $f,
+            'topic_meta' => array(
+                'forum_id' => $f,
+            ),
+        ) );
+        $r1 = $this->factory->reply->create( array(
+            'post_parent' => $t,
+            'reply_meta' => array(
+                'forum_id' => $f,
+                'topic_id' => $t,
+            ),
+        ) );
+
+        $id = bbp_update_topic_last_reply_id( $t, $r1 );
+        $this->assertSame( $r1, $id );
+
+        $id = bbp_get_topic_last_reply_id( $t );
+        $this->assertSame( $r1, $id );
+
+        $r2 = $this->factory->reply->create_many( 2, array(
+            'post_parent' => $t,
+            'reply_meta' => array(
+                'forum_id' => $f,
+                'topic_id' => $t,
+            ),
+        ) );
+
+        bbp_update_topic_last_reply_id( $t );
+        $id = bbp_get_topic_last_reply_id( $t );
+        $this->assertSame( $r2[1], $id );
     }
 }