function LocalStream::rename

Same name in other branches
  1. 9 core/lib/Drupal/Core/StreamWrapper/LocalStream.php \Drupal\Core\StreamWrapper\LocalStream::rename()
  2. 10 core/lib/Drupal/Core/StreamWrapper/LocalStream.php \Drupal\Core\StreamWrapper\LocalStream::rename()
  3. 11.x core/lib/Drupal/Core/StreamWrapper/LocalStream.php \Drupal\Core\StreamWrapper\LocalStream::rename()

Support for rename().

Parameters

string $from_uri: The URI to the file to rename.

string $to_uri: The new URI for file.

Return value

bool TRUE if file was successfully renamed.

Overrides PhpStreamWrapperInterface::rename

See also

http://php.net/manual/streamwrapper.rename.php

1 method overrides LocalStream::rename()
LocalReadOnlyStream::rename in core/lib/Drupal/Core/StreamWrapper/LocalReadOnlyStream.php
Support for rename().

File

core/lib/Drupal/Core/StreamWrapper/LocalStream.php, line 393

Class

LocalStream
Defines a Drupal stream wrapper base class for local files.

Namespace

Drupal\Core\StreamWrapper

Code

public function rename($from_uri, $to_uri) {
    return rename($this->getLocalPath($from_uri), $this->getLocalPath($to_uri));
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.