Changeset 54423

Timestamp:

10/08/2022 01:39:43 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Tests: Add wp_cache_*_multiple() functions to Memcached implementation used in the test suite.

Since this object cache implementation was added, WordPress has introduced a variety of caching API improvements:

• wp_cache_add_multiple()
• wp_cache_set_multiple()
• wp_cache_get_multiple()
• wp_cache_delete_multiple()

Although WordPress core provides a compatibility layer if these functions are missing from third-party object caches, this commit updates the Memcached object cache used in the test suite to implement these new functions directly.

Follow-up to [40561], [47938], [47944], [52700], [52703], [52706], [52708].

Props petitphp, spacedmonkey, tillkruss, SergeyBiryukov.
Fixes #54864.

File:

• trunk/tests/phpunit/includes/object-cache.php (modified) (8 diffs)

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

@@ -39 +39 @@
     global $wp_object_cache;
     return $wp_object_cache->addByKey( $server_key, $key, $value, $group, $expiration );
+}
+
+/**
+ * Adds multiple values to the cache in one call, if the cache keys don't already exist.
+ *
+ * @param array  $items      Array of keys and values to be added.
+ * @param string $group      Optional. Where the cache contents are grouped. Default empty.
+ * @param int    $expiration Optional. When to expire the cache contents, in seconds.
+ *                           Default 0 (no expiration).
+ * @return bool[] Array of return values, grouped by key. Each value is either
+ *                true on success, or false if cache key and group already exist.
+ */
+function wp_cache_add_multiple( array $items, $group = '', $expiration = 0 ) {
+    global $wp_object_cache;
+    return $wp_object_cache->addMultiple( $items, $group, $expiration );
 }
 
@@ -246 +261 @@
     global $wp_object_cache;
     return $wp_object_cache->deleteByKey( $server_key, $key, $group, $time );
+}
+
+/**
+ * Deletes multiple values from the cache in one call.
+ *
+ * @param array  $keys  Array of keys under which the cache to deleted.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @return bool[] Array of return values, grouped by key. Each value is either
+ *                true on success, or false if the contents were not deleted.
+ */
+function wp_cache_delete_multiple( array $keys, $group = '' ) {
+    global $wp_object_cache;
+    return $wp_object_cache->deleteMultiple( $keys, $group );
 }
 
@@ -441 +469 @@
 
 /**
+ * Retrieves multiple values from the cache in one call.
+ *
+ * @param array  $keys  Array of keys under which the cache contents are stored.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @param bool   $force Optional. Whether to force an update of the local cache
+ *                      from the persistent cache. Default false.
+ * @return array Array of return values, grouped by key. Each value is either
+ *               the cache contents on success, or false on failure.
+ */
+function wp_cache_get_multiple( $keys, $group = '', $force = false ) {
+    global $wp_object_cache;
+    return $wp_object_cache->getMultiple( $keys, $group, $force );
+}
+
+/**
  * Retrieves a Memcached option value.
  *
@@ -718 +761 @@
     global $wp_object_cache;
     return $wp_object_cache->setMultiByKey( $server_key, $items, $groups, $expiration );
+}
+
+/**
+ * Sets multiple values to the cache in one call.
+ *
+ * Differs from wp_cache_add_multiple() in that it will always write data.
+ *
+ * @param array  $items      Array of keys and values to be set.
+ * @param string $group      Optional. Where the cache contents are grouped. Default empty.
+ * @param int    $expiration Optional. When to expire the cache contents, in seconds.
+ *                           Default 0 (no expiration).
+ * @return bool[] Array of return values, grouped by key. Each value is either
+ *                true on success, or false on failure.
+ */
+function wp_cache_set_multiple( array $items, $group = '', $expiration = 0 ) {
+    global $wp_object_cache;
+    return $wp_object_cache->setMultiple( $items, $group, $expiration );
 }
 
@@ -958 +1018 @@
 
     /**
+     * Adds multiple values to cache.
+     *
+     * @param array  $items      Array of keys and values to be added.
+     * @param string $group      Optional. Where the cache contents are grouped. Default empty.
+     * @param int    $expiration Optional. When to expire the cache contents, in seconds.
+     *                           Default 0 (no expiration).
+     * @return bool[] Array of return values, grouped by key. Each value is either
+     *                true on success, or false if cache key and group already exist.
+     */
+    public function addMultiple( array $items, $group = '', $expiration = 0 ) {
+        $values = array();
+
+        foreach ( $items as $key => $value ) {
+            $values[ $key ] = $this->add( $key, $value, $group, $expiration );
+        }
+
+        return $values;
+    }
+
+    /**
      * Adds a single server to the list of Memcached servers.
      *
@@ -1258 +1338 @@
     public function deleteByKey( $server_key, $key, $group = 'default', $time = 0 ) {
         return $this->delete( $key, $group, $time, $server_key, true );
+    }
+
+    /**
+     * Removes multiple items from the cache.
+     *
+     * @param array  $keys  Array of keys under which the cache to deleted.
+     * @param string $group Optional. Where the cache contents are grouped. Default empty.
+     * @return bool[] Array of return values, grouped by key. Each value is either
+     *                true on success, or false if the contents were not deleted.
+     */
+    public function deleteMultiple( $keys, $group ) {
+        $values = array();
+
+        foreach ( $keys as $key ) {
+            $values[ $key ] = $this->delete( $key, $group );
+        }
+
+        return $values;
     }
 
@@ -1538 +1636 @@
 
     /**
+     * Get multiple items from the cache.
+     *
+     * @param array  $keys  Array of keys under which the cache contents are stored.
+     * @param string $group Optional. Where the cache contents are grouped. Default empty.
+     * @param bool   $force Optional. Whether to force an update of the local cache
+     *                      from the persistent cache. Default false.
+     * @return array Array of return values, grouped by key. Each value is either
+     *               the cache contents on success, or false on failure.
+     */
+    public function getMultiple( $keys, $group = '', $force = false ) {
+        $values = array();
+
+        foreach ( $keys as $key ) {
+            $found          = null;
+            $value          = $this->get( $key, $group, $force, $found );
+            $values[ $key ] = $found ? $value : false;
+        }
+
+        return $values;
+    }
+
+    /**
      * Retrieves a Memcached option value.
      *
@@ -1951 +2071 @@
     public function setMultiByKey( $server_key, $items, $groups = 'default', $expiration = 0 ) {
         return $this->setMulti( $items, $groups, $expiration, $server_key, true );
+    }
+
+    /**
+     * Sets multiple values in cache.
+     *
+     * @param array  $items      Array of keys and values to be set.
+     * @param string $group      Optional. Where the cache contents are grouped. Default empty.
+     * @param int    $expiration Optional. When to expire the cache contents, in seconds.
+     *                           Default 0 (no expiration).
+     * @return bool[] Array of return values, grouped by key. Each value is either
+     *                true on success, or false on failure.
+     */
+    public function setMultiple( array $items, $group = '', $expiration = 0 ) {
+        $values = array();
+
+        foreach ( $items as $key => $value ) {
+            $values[ $key ] = $this->set( $key, $value, $group, $expiration );
+        }
+
+        return $values;
     }