class Local
Same name in other branches
- 9 core/lib/Drupal/Core/FileTransfer/Local.php \Drupal\Core\FileTransfer\Local
- 8.9.x core/lib/Drupal/Core/FileTransfer/Local.php \Drupal\Core\FileTransfer\Local
- 11.x core/lib/Drupal/Core/FileTransfer/Local.php \Drupal\Core\FileTransfer\Local
Defines the local connection class for copying files as the httpd user.
Hierarchy
- class \Drupal\Core\FileTransfer\FileTransfer
- class \Drupal\Core\FileTransfer\Local extends \Drupal\Core\FileTransfer\FileTransfer implements \Drupal\Core\FileTransfer\ChmodInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait
Expanded class hierarchy of Local
3 files declare their use of Local
- TestFileTransferWithSettingsForm.php in core/
modules/ update/ tests/ modules/ update_test/ src/ TestFileTransferWithSettingsForm.php - UpdateManagerInstall.php in core/
modules/ update/ src/ Form/ UpdateManagerInstall.php - UpdateReady.php in core/
modules/ update/ src/ Form/ UpdateReady.php
8 string references to 'Local'
- InstallerExistingConfigSyncDirectoryMultilingualTest::prepareEnvironment in core/
tests/ Drupal/ FunctionalTests/ Installer/ InstallerExistingConfigSyncDirectoryMultilingualTest.php - Prepares the current environment for running the test.
- InstallerExistingConfigSyncDirectoryMultilingualTest::testConfigSync in core/
tests/ Drupal/ FunctionalTests/ Installer/ InstallerExistingConfigSyncDirectoryMultilingualTest.php - Confirms that the installation installed the configuration correctly.
- locale.settings.yml in core/
profiles/ testing_multilingual/ config/ install/ locale.settings.yml - core/profiles/testing_multilingual/config/install/locale.settings.yml
- LocaleTranslationChangeProjectVersionTest::setUp in core/
modules/ locale/ tests/ src/ Functional/ LocaleTranslationChangeProjectVersionTest.php - LocaleUpdateBase::setTranslationFiles in core/
modules/ locale/ tests/ src/ Functional/ LocaleUpdateBase.php - Setup the environment containing local and remote translation files.
File
-
core/
lib/ Drupal/ Core/ FileTransfer/ Local.php, line 11
Namespace
Drupal\Core\FileTransferView source
class Local extends FileTransfer implements ChmodInterface {
use DependencySerializationTrait;
/**
* The file system service.
*
* @var \Drupal\Core\File\FileSystemInterface
*/
protected $fileSystem;
/**
* {@inheritdoc}
*/
public function __construct($jail, FileSystemInterface $file_system) {
parent::__construct($jail);
$this->fileSystem = $file_system;
}
/**
* {@inheritdoc}
*/
public function connect() {
// No-op
}
/**
* {@inheritdoc}
*/
public static function factory($jail, $settings) {
return new Local($jail, \Drupal::service('file_system'));
}
/**
* {@inheritdoc}
*/
protected function copyFileJailed($source, $destination) {
if (@(!copy($source, $destination))) {
throw new FileTransferException('Cannot copy %source to %destination.', 0, [
'%source' => $source,
'%destination' => $destination,
]);
}
}
/**
* {@inheritdoc}
*/
protected function createDirectoryJailed($directory) {
if (!is_dir($directory) && @(!mkdir($directory, 0777, TRUE))) {
throw new FileTransferException('Cannot create directory %directory.', 0, [
'%directory' => $directory,
]);
}
}
/**
* {@inheritdoc}
*/
protected function removeDirectoryJailed($directory) {
if (!is_dir($directory)) {
// Programmer error assertion, not something we expect users to see.
throw new FileTransferException('removeDirectoryJailed() called with a path (%directory) that is not a directory.', 0, [
'%directory' => $directory,
]);
}
/** @var \Drupal\Core\File\FileSystemInterface $file_system */
$file_system = \Drupal::service('file_system');
foreach (new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($directory, \RecursiveDirectoryIterator::SKIP_DOTS), \RecursiveIteratorIterator::CHILD_FIRST) as $filename => $file) {
if ($file->isDir()) {
if (@(!$file_system->rmdir($filename))) {
throw new FileTransferException('Cannot remove directory %directory.', 0, [
'%directory' => $filename,
]);
}
}
elseif ($file->isFile()) {
if (@(!$this->fileSystem
->unlink($filename))) {
throw new FileTransferException('Cannot remove file %file.', 0, [
'%file' => $filename,
]);
}
}
}
if (@(!$file_system->rmdir($directory))) {
throw new FileTransferException('Cannot remove directory %directory.', 0, [
'%directory' => $directory,
]);
}
}
/**
* {@inheritdoc}
*/
protected function removeFileJailed($file) {
if (@(!$this->fileSystem
->unlink($file))) {
throw new FileTransferException('Cannot remove file %file.', 0, [
'%file' => $file,
]);
}
}
/**
* {@inheritdoc}
*/
public function isDirectory($path) {
return is_dir($path);
}
/**
* {@inheritdoc}
*/
public function isFile($path) {
return is_file($path);
}
/**
* {@inheritdoc}
*/
public function chmodJailed($path, $mode, $recursive) {
if ($recursive && is_dir($path)) {
foreach (new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($path, \RecursiveDirectoryIterator::SKIP_DOTS), \RecursiveIteratorIterator::SELF_FIRST) as $filename => $file) {
if (@(!chmod($filename, $mode))) {
throw new FileTransferException('Cannot chmod %path.', 0, [
'%path' => $filename,
]);
}
}
}
elseif (@(!chmod($path, $mode))) {
throw new FileTransferException('Cannot chmod %path.', 0, [
'%path' => $path,
]);
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
FileTransfer::$hostname | protected | property | The hostname for this file transfer. | ||
FileTransfer::$jail | protected | property | Full path to directory where file-transfer is restricted to. | ||
FileTransfer::$password | protected | property | The password for this file transfer. | 1 | |
FileTransfer::$port | protected | property | The port for this file transfer. | 1 | |
FileTransfer::$username | protected | property | The username for this file transfer. | 1 | |
FileTransfer::checkPath | final protected | function | Checks that the path is inside the jail and throws an exception if not. | ||
FileTransfer::chmod | final public | function | Changes the permissions of the specified $path (file or directory). | ||
FileTransfer::copyDirectory | final public | function | Copies a directory. | ||
FileTransfer::copyDirectoryJailed | protected | function | Copies a directory. | 1 | |
FileTransfer::copyFile | final public | function | Copies a file. | ||
FileTransfer::createDirectory | final public | function | Creates a directory. | ||
FileTransfer::findChroot | public | function | Returns the chroot property for this connection. | ||
FileTransfer::fixRemotePath | final protected | function | Returns a modified path suitable for passing to the server. | ||
FileTransfer::getSettingsForm | public | function | Returns a form to collect connection settings credentials. | 3 | |
FileTransfer::removeDirectory | final public | function | Removes a directory. | ||
FileTransfer::removeFile | final public | function | Removes a file. | ||
FileTransfer::sanitizePath | public | function | Changes backslashes to slashes, also removes a trailing slash. | ||
FileTransfer::setChroot | public | function | Sets the chroot and changes the jail to match the correct path scheme. | ||
FileTransfer::__get | public | function | Implements the magic __get() method. | ||
FileTransfer::__isset | public | function | |||
FileTransfer::__set | public | function | |||
FileTransfer::__unset | public | function | |||
Local::$fileSystem | protected | property | The file system service. | ||
Local::chmodJailed | public | function | Changes the permissions of the file / directory specified in $path. | Overrides ChmodInterface::chmodJailed | |
Local::connect | public | function | Connects to the server. | Overrides FileTransfer::connect | |
Local::copyFileJailed | protected | function | Copies a file. | Overrides FileTransfer::copyFileJailed | |
Local::createDirectoryJailed | protected | function | Creates a directory. | Overrides FileTransfer::createDirectoryJailed | |
Local::factory | public static | function | Defines a factory method for this class. | Overrides FileTransfer::factory | 1 |
Local::isDirectory | public | function | Checks if a particular path is a directory. | Overrides FileTransfer::isDirectory | |
Local::isFile | public | function | Checks if a particular path is a file (not a directory). | Overrides FileTransfer::isFile | |
Local::removeDirectoryJailed | protected | function | Removes a directory. | Overrides FileTransfer::removeDirectoryJailed | |
Local::removeFileJailed | protected | function | Removes a file. | Overrides FileTransfer::removeFileJailed | |
Local::__construct | public | function | Constructs a Drupal\Core\FileTransfer\FileTransfer object. | Overrides FileTransfer::__construct |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.