public function FileStorage::rename

public FileStorage::rename($name, $new_name)

Renames a configuration object in the storage.

Parameters

string $name: The name of a configuration object to rename.

string $new_name: The new name of a configuration object.

Return value

bool TRUE on success, FALSE otherwise.

Overrides StorageInterface::rename

File

core/lib/Drupal/Core/Config/FileStorage.php, line 161

Class

FileStorage

Defines the file storage.

Namespace

Drupal\Core\Config

Code

public function rename($name, $new_name) {
  $status = @rename($this->getFilePath($name), $this->getFilePath($new_name));
  if ($status === FALSE) {
    throw new StorageException('Failed to rename configuration file from: ' . $this->getFilePath($name) . ' to: ' . $this->getFilePath($new_name));
  }
  return TRUE;
}