Function Self_learning_cache->remove

Definitions

sources/caches.php

  • Remove something from a list entry in the cache; the opposite of append.Be careful because this only removes from the current bucket.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$key ID_TEXT No No required parameter N/A N/A Cache key
$value mixed No No required parameter N/A N/A The value to remove; the same as what was used in append

Returns

  • Whether the value was actually removed
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Remove something from a list entry in the cache; the opposite of append.Be careful because this only removes from the current bucket.
 *
 * @param  ID_TEXT $key Cache key
 * @param  mixed $value The value to remove; the same as what was used in append
 * @return boolean Whether the value was actually removed
 */

public function remove(string $key, $value) : bool