Changeset 53767

Timestamp:

07/23/2022 02:56:51 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Cache API: Make the placement of wp_cache_flush_group() more consistent.

Includes:

• Placing WP_Object_Cache::flush_group() next to ::flush().
• Placing wp_cache_supports_group_flush() next to wp_cache_flush_group().
• Placing the wp_cache_flush_group() unit test next to the ::flush() method test.
• Removing test name from assertion messages, as it is already mentioned directly above in case of failure.
• Adjusting function descriptions per the documentation standards.

Follow-up to [52706], [53763].

See #55647, #4476.

Location:

trunk

Files:

• src/wp-includes/cache-compat.php (modified) (2 diffs)
• src/wp-includes/cache.php (modified) (3 diffs)
• src/wp-includes/class-wp-object-cache.php (modified) (2 diffs)
• tests/phpunit/includes/object-cache.php (modified) (2 diffs)
• tests/phpunit/tests/cache.php (modified) (2 diffs)
• tests/phpunit/tests/pluggable.php (modified) (2 diffs)

trunk/src/wp-includes/cache-compat.php

@@ -146 +146 @@
     /**
      * Removes all cache items in a group, if the object cache implementation supports it.
-     * Before calling this method, always check for group flushing support using the
-     * `wp_cache_supports_group_flush()` method.
+     *
+     * Before calling this function, always check for group flushing support using the
+     * `wp_cache_supports_group_flush()` function.
      *
      * @since 6.1.0
@@ -176 +177 @@
 if ( ! function_exists( 'wp_cache_supports_group_flush' ) ) :
     /**
-     * Whether the object cache implementation supports flushing individual cache groups.
+     * Determines whether the object cache implementation supports flushing individual cache groups.
      *
      * @since 6.1.0

trunk/src/wp-includes/cache.php

@@ -21 +21 @@
 function wp_cache_init() {
     $GLOBALS['wp_object_cache'] = new WP_Object_Cache();
-}
-
-/**
- * Whether the object cache implementation supports flushing individual cache groups.
- *
- * @since 6.1.0
- *
- * @see WP_Object_Cache::flush_group()
- *
- * @return bool True if group flushing is supported, false otherwise.
- */
-function wp_cache_supports_group_flush() {
-    return true;
 }
 
@@ -297 +284 @@
 /**
  * Removes all cache items in a group, if the object cache implementation supports it.
- * Before calling this method, always check for group flushing support using the
- * `wp_cache_supports_group_flush()` method.
+ *
+ * Before calling this function, always check for group flushing support using the
+ * `wp_cache_supports_group_flush()` function.
  *
  * @since 6.1.0
@@ -312 +300 @@
 
     return $wp_object_cache->flush_group( $group );
+}
+
+/**
+ * Determines whether the object cache implementation supports flushing individual cache groups.
+ *
+ * @since 6.1.0
+ *
+ * @see WP_Object_Cache::flush_group()
+ *
+ * @return bool True if group flushing is supported, false otherwise.
+ */
+function wp_cache_supports_group_flush() {
+    return true;
 }
 

trunk/src/wp-includes/class-wp-object-cache.php

@@ -292 +292 @@
 
     /**
-     * Removes all cache items in a group.
-     *
-     * @since 6.1.0
-     *
-     * @param string $group Name of group to remove from cache.
-     * @return true Always returns true.
-     */
-    public function flush_group( $group ) {
-        unset( $this->cache[ $group ] );
-
-        return true;
-    }
-
-    /**
      * Retrieves the cache contents, if it exists.
      *
@@ -511 +497 @@
 
     /**
+     * Removes all cache items in a group.
+     *
+     * @since 6.1.0
+     *
+     * @param string $group Name of group to remove from cache.
+     * @return true Always returns true.
+     */
+    public function flush_group( $group ) {
+        unset( $this->cache[ $group ] );
+
+        return true;
+    }
+
+    /**
      * Sets the list of global cache groups.
      *

trunk/tests/phpunit/includes/object-cache.php

@@ -283 +283 @@
     global $wp_object_cache;
     return $wp_object_cache->flush( $delay );
+}
+
+/**
+ * Whether the object cache implementation supports flushing individual cache groups.
+ *
+ * @since 6.1.0
+ *
+ * @return bool True if group flushing is supported, false otherwise.
+ */
+function wp_cache_supports_group_flush() {
+    return false;
 }
 
@@ -744 +755 @@
     global $wp_object_cache;
     $wp_object_cache = new WP_Object_Cache();
-}
-
-/**
- * Whether the object cache implementation supports flushing individual cache groups.
- *
- * @since 6.1.0
- *
- * @return bool True if group flushing is supported, false otherwise.
- */
-function wp_cache_supports_group_flush() {
-    return false;
 }
 

trunk/tests/phpunit/tests/cache.php

@@ -128 +128 @@
         // If there is no value get returns false.
         $this->assertFalse( $this->cache->get( $key ) );
+    }
+
+    /**
+     * @ticket 4476
+     * @ticket 9773
+     *
+     * @covers ::wp_cache_flush_group
+     */
+    public function test_wp_cache_flush_group() {
+        $key = 'my-key';
+        $val = 'my-val';
+
+        wp_cache_set( $key, $val, 'group-test' );
+        wp_cache_set( $key, $val, 'group-kept' );
+
+        $this->assertSame( $val, wp_cache_get( $key, 'group-test' ), 'group-test should contain my-val' );
+
+        if ( wp_using_ext_object_cache() ) {
+            $this->setExpectedIncorrectUsage( 'wp_cache_flush_group' );
+        }
+
+        $results = wp_cache_flush_group( 'group-test' );
+
+        if ( wp_using_ext_object_cache() ) {
+            $this->assertFalse( $results );
+        } else {
+            $this->assertTrue( $results );
+            $this->assertFalse( wp_cache_get( $key, 'group-test' ), 'group-test should return false' );
+            $this->assertSame( $val, wp_cache_get( $key, 'group-kept' ), 'group-kept should still contain my-val' );
+        }
     }
 
@@ -416 +446 @@
         $this->assertSame( $expected, $found );
     }
-
-    /**
-     * @ticket 4476
-     * @ticket 9773
-     *
-     * test wp_cache_flush_group
-     *
-     * @covers ::wp_cache_flush_group
-     */
-    public function test_wp_cache_flush_group() {
-        $key = 'my-key';
-        $val = 'my-val';
-
-        wp_cache_set( $key, $val, 'group-test' );
-        wp_cache_set( $key, $val, 'group-kept' );
-
-        $this->assertSame( $val, wp_cache_get( $key, 'group-test' ), 'test_wp_cache_flush_group: group-test should contain my-val' );
-
-        if ( wp_using_ext_object_cache() ) {
-            $this->setExpectedIncorrectUsage( 'wp_cache_flush_group' );
-        }
-
-        $results = wp_cache_flush_group( 'group-test' );
-
-        if ( wp_using_ext_object_cache() ) {
-            $this->assertFalse( $results );
-        } else {
-            $this->assertTrue( $results );
-            $this->assertFalse( wp_cache_get( $key, 'group-test' ), 'test_wp_cache_flush_group: group-test should return false' );
-            $this->assertSame( $val, wp_cache_get( $key, 'group-kept' ), 'test_wp_cache_flush_group: group-kept should still contain my-val' );
-        }
-    }
 }

trunk/tests/phpunit/tests/pluggable.php

@@ -269 +269 @@
                     // wp-includes/cache.php:
                     'wp_cache_init'                      => array(),
-                    'wp_cache_supports_group_flush'      => array(),
                     'wp_cache_add'                       => array(
                         'key',
@@ -330 +329 @@
                     'wp_cache_flush_runtime'             => array(),
                     'wp_cache_flush_group'               => array( 'group' ),
+                    'wp_cache_supports_group_flush'      => array(),
                     'wp_cache_close'                     => array(),
                     'wp_cache_add_global_groups'         => array( 'groups' ),