lithium\storage\Cache::delete()

public static method

Deletes using the specified cache configuration.

Can handle single- and multi-key deletes.

Parameters

  • string $name

    The cache configuration to delete from.
  • mixed $key

    Key to be deleted or an array of keys to delete.
  • array $options

    Options for the method and strategies.

    • 'conditions' mixed: A function or item that must return or evaluate to true in order to continue write operation.

Returns

boolean

true on successful cache delete, false otherwise. When deleting multiple items and an error occurs deleting any of the items the whole operation fails and this method will return false.

Filter

This method can be filtered.

Source

	public static function delete($name, $key, array $options = []) {
		$options += ['conditions' => null, 'strategies' => true];

		if (is_callable($options['conditions']) && !$options['conditions']()) {
			return false;
		}
		try {
			$adapter = static::adapter($name);
		} catch (ConfigException $e) {
			return false;
		}
		$key = static::key($key);

		if (is_array($key)) {
			$keys = $key;
		} else {
			$keys = [$key];
		}
		$params = compact('keys');

		return Filters::run(get_called_class(), __FUNCTION__, $params, function($params) use ($adapter) {
			return $adapter->delete($params['keys']);
		});
	}