Merge pull request #17345 from eileenmcnaughton/ev_batch

[civicrm-core.git] / CRM / Utils / Cache / NaiveMultipleTrait.php

<?php
/*
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC. All rights reserved.                        |
 |                                                                    |
 | This work is published under the GNU AGPLv3 license with some      |
 | permitted exceptions and without any warranty. For full license    |
 | and copyright information, see https://civicrm.org/licensing       |
 +--------------------------------------------------------------------+
 */

/**
 *
 * @package CRM
 * @copyright CiviCRM LLC https://civicrm.org/licensing
 *
 * The traditional CRM_Utils_Cache_Interface did not support multiple-key
 * operations. To get drop-in compliance with PSR-16, we use a naive adapter.
 * An operation like `getMultiple()` just calls `get()` multiple times.
 *
 * Ideally, these should be replaced with more performant/native versions.
 */
trait CRM_Utils_Cache_NaiveMultipleTrait {

  /**
   * Obtains multiple cache items by their unique keys.
   *
   * @param iterable $keys A list of keys that can obtained in a single operation.
   * @param mixed $default Default value to return for keys that do not exist.
   *
   * @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
   *
   * @throws \Psr\SimpleCache\InvalidArgumentException
   *   MUST be thrown if $keys is neither an array nor a Traversable,
   *   or if any of the $keys are not a legal value.
   */
  public function getMultiple($keys, $default = NULL) {
    $this->assertIterable('getMultiple', $keys);

    $result = [];
    foreach ($keys as $key) {
      $result[$key] = $this->get($key, $default);
    }
    return $result;
  }

  /**
   * Persists a set of key => value pairs in the cache, with an optional TTL.
   *
   * @param iterable $values A list of key => value pairs for a multiple-set operation.
   * @param null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and
   *                                       the driver supports TTL then the library may set a default value
   *                                       for it or let the driver take care of that.
   *
   * @return bool True on success and false on failure.
   *
   * @throws \Psr\SimpleCache\InvalidArgumentException
   *   MUST be thrown if $values is neither an array nor a Traversable,
   *   or if any of the $values are not a legal value.
   */
  public function setMultiple($values, $ttl = NULL) {
    $this->assertIterable('setMultiple', $values);

    $result = TRUE;
    foreach ($values as $key => $value) {
      if (is_int($key)) {
        $key = (string) $key;
      }
      $result = $this->set($key, $value, $ttl) || $result;
    }
    return $result;
  }

  /**
   * Deletes multiple cache items in a single operation.
   *
   * @param iterable $keys A list of string-based keys to be deleted.
   *
   * @return bool True if the items were successfully removed. False if there was an error.
   *
   * @throws \Psr\SimpleCache\InvalidArgumentException
   *   MUST be thrown if $keys is neither an array nor a Traversable,
   *   or if any of the $keys are not a legal value.
   */
  public function deleteMultiple($keys) {
    $this->assertIterable('deleteMultiple', $keys);

    $result = TRUE;
    foreach ($keys as $key) {
      $result = $this->delete($key) || $result;
    }
    return $result;
  }

  /**
   * @param $func
   * @param $keys
   * @throws \CRM_Utils_Cache_InvalidArgumentException
   */
  private function assertIterable($func, $keys) {
    if (!is_array($keys) && !($keys instanceof Traversable)) {
      throw new CRM_Utils_Cache_InvalidArgumentException("$func expects iterable input");
    }
  }

}