W3cubDocs

/Drupal 8

public function FileStorage::deleteAll

public FileStorage::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/FileStorage.php, line 218

Class

FileStorage
Defines the file storage.

Namespace

Drupal\Core\Config

Code

public function deleteAll($prefix = '') {
  $success = TRUE;
  $files = $this->listAll($prefix);
  foreach ($files as $name) {
    if (!$this->delete($name) && $success) {
      $success = FALSE;
    }
  }
  if ($success && $this->collection != StorageInterface::DEFAULT_COLLECTION) {
    // Remove empty directories.
    if (!(new \FilesystemIterator($this->getCollectionDirectory()))->valid()) {
      drupal_rmdir($this->getCollectionDirectory());
    }
  }
  return $success;
}

© 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!FileStorage.php/function/FileStorage::deleteAll/8.1.x