public function CachedStorage::deleteAll

public CachedStorage::deleteAll($prefix = '')

Deletes configuration objects whose names start with a given prefix.

Given the following configuration object names:

  • node.type.article
  • node.type.page

Passing the prefix 'node.type.' will delete the above configuration objects.

Parameters

string $prefix: (optional) The prefix to search for. If omitted, all configuration objects that exist will be deleted.

Return value

bool TRUE on success, FALSE otherwise.

Overrides StorageInterface::deleteAll

File

core/lib/Drupal/Core/Config/CachedStorage.php, line 215

Class

CachedStorage
Defines the cached storage.

Namespace

Drupal\Core\Config

Code

public function deleteAll($prefix = '') {
  // If the cache was the first to be deleted, another process might start
  // rebuilding the cache before the storage is renamed.
  $names = $this->storage->listAll($prefix);
  if ($this->storage->deleteAll($prefix)) {
    $this->cache->deleteMultiple($this->getCacheKeys($names));
    return TRUE;
  }
  return FALSE;
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Config!CachedStorage.php/function/CachedStorage::deleteAll/8.1.x