feature#9150 [Filesystem] introduced new Exception base classes (fabpot)
This PR was merged into the master branch. Discussion ---------- [Filesystem] introduced new Exception base classes The Filesystem class now throws a ```FileNotFoundException``` if a file could not be found, rather than an basic ```IOException```. The new exception is still a child of the ```IOException```, this way it doesn' t breack BC. The ```IOException``` now also takes as the first argument an path to the file of interest, which can be used via the ```getPath()``` method. The switch to the FilesystemInterface will allow you to have an implementation accessing S3 or Dropbox, etc. and still inject it into a classes, which are requiring the Filesystem. | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | ~ | Doc PR | symfony/symfony-docs#2947 Commits -------c2e43d0
[Filesystem] removed getPath() on Exceptions and cleaned up CS and error messages785080a
[Filesystem] introduced new Exception base classes
This commit is contained in:
commit
331043f421
@ -20,5 +20,4 @@ namespace Symfony\Component\Filesystem\Exception;
|
|||||||
*/
|
*/
|
||||||
interface ExceptionInterface
|
interface ExceptionInterface
|
||||||
{
|
{
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This file is part of the Symfony package.
|
||||||
|
*
|
||||||
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Symfony\Component\Filesystem\Exception;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exception class thrown when a file couldn't be found
|
||||||
|
*
|
||||||
|
* @author Fabien Potencier <fabien@symfony.com>
|
||||||
|
* @author Christian Gärtner <christiangaertner.film@googlemail.com>
|
||||||
|
*/
|
||||||
|
class FileNotFoundException extends IOException
|
||||||
|
{
|
||||||
|
public function __construct($message = null, $code = 0, \Exception $previous = null, $path = null)
|
||||||
|
{
|
||||||
|
if (null === $message) {
|
||||||
|
if (null === $path) {
|
||||||
|
$message = 'File could not be found.';
|
||||||
|
} else {
|
||||||
|
$message = sprintf('File "%s" could not be found.', $path);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
parent::__construct($message, $code, $previous, $path);
|
||||||
|
}
|
||||||
|
}
|
@ -15,10 +15,27 @@ namespace Symfony\Component\Filesystem\Exception;
|
|||||||
* Exception class thrown when a filesystem operation failure happens
|
* Exception class thrown when a filesystem operation failure happens
|
||||||
*
|
*
|
||||||
* @author Romain Neutron <imprec@gmail.com>
|
* @author Romain Neutron <imprec@gmail.com>
|
||||||
|
* @author Christian Gärtner <christiangaertner.film@googlemail.com>
|
||||||
|
* @author Fabien Potencier <fabien@symfony.com>
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class IOException extends \RuntimeException implements ExceptionInterface
|
class IOException extends \RuntimeException implements IOExceptionInterface
|
||||||
{
|
{
|
||||||
|
private $path;
|
||||||
|
|
||||||
|
public function __construct($message, $code = 0, \Exception $previous = null, $path = null)
|
||||||
|
{
|
||||||
|
$this->path = $path;
|
||||||
|
|
||||||
|
parent::__construct($message, $code, $previous);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
|
public function getPath()
|
||||||
|
{
|
||||||
|
return $this->path;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -0,0 +1,27 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This file is part of the Symfony package.
|
||||||
|
*
|
||||||
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Symfony\Component\Filesystem\Exception;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* IOException interface for file and input/output stream releated exceptions thrown by the component.
|
||||||
|
*
|
||||||
|
* @author Christian Gärtner <christiangaertner.film@googlemail.com>
|
||||||
|
*/
|
||||||
|
interface IOExceptionInterface extends ExceptionInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Returns the associated path for the exception
|
||||||
|
*
|
||||||
|
* @return string The path.
|
||||||
|
*/
|
||||||
|
public function getPath();
|
||||||
|
}
|
@ -12,6 +12,7 @@
|
|||||||
namespace Symfony\Component\Filesystem;
|
namespace Symfony\Component\Filesystem;
|
||||||
|
|
||||||
use Symfony\Component\Filesystem\Exception\IOException;
|
use Symfony\Component\Filesystem\Exception\IOException;
|
||||||
|
use Symfony\Component\Filesystem\Exception\FileNotFoundException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Provides basic utility to manipulate the file system.
|
* Provides basic utility to manipulate the file system.
|
||||||
@ -31,12 +32,13 @@ class Filesystem
|
|||||||
* @param string $targetFile The target filename
|
* @param string $targetFile The target filename
|
||||||
* @param boolean $override Whether to override an existing file or not
|
* @param boolean $override Whether to override an existing file or not
|
||||||
*
|
*
|
||||||
|
* @throws FileNotFoundException When orginFile doesn't exist
|
||||||
* @throws IOException When copy fails
|
* @throws IOException When copy fails
|
||||||
*/
|
*/
|
||||||
public function copy($originFile, $targetFile, $override = false)
|
public function copy($originFile, $targetFile, $override = false)
|
||||||
{
|
{
|
||||||
if (stream_is_local($originFile) && !is_file($originFile)) {
|
if (stream_is_local($originFile) && !is_file($originFile)) {
|
||||||
throw new IOException(sprintf('Failed to copy %s because file not exists', $originFile));
|
throw new FileNotFoundException(sprintf('Failed to copy "%s" because file does not exist.', $originFile), 0, null, $originFile);
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->mkdir(dirname($targetFile));
|
$this->mkdir(dirname($targetFile));
|
||||||
@ -57,7 +59,7 @@ class Filesystem
|
|||||||
unset($source, $target);
|
unset($source, $target);
|
||||||
|
|
||||||
if (!is_file($targetFile)) {
|
if (!is_file($targetFile)) {
|
||||||
throw new IOException(sprintf('Failed to copy %s to %s', $originFile, $targetFile));
|
throw new IOException(sprintf('Failed to copy "%s" to "%s".', $originFile, $targetFile), 0, null, $originFile);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -78,7 +80,7 @@ class Filesystem
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (true !== @mkdir($dir, $mode, true)) {
|
if (true !== @mkdir($dir, $mode, true)) {
|
||||||
throw new IOException(sprintf('Failed to create %s', $dir));
|
throw new IOException(sprintf('Failed to create "%s".', $dir), 0, null, $dir);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -115,7 +117,7 @@ class Filesystem
|
|||||||
foreach ($this->toIterator($files) as $file) {
|
foreach ($this->toIterator($files) as $file) {
|
||||||
$touch = $time ? @touch($file, $time, $atime) : @touch($file);
|
$touch = $time ? @touch($file, $time, $atime) : @touch($file);
|
||||||
if (true !== $touch) {
|
if (true !== $touch) {
|
||||||
throw new IOException(sprintf('Failed to touch %s', $file));
|
throw new IOException(sprintf('Failed to touch "%s".', $file), 0, null, $file);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -140,17 +142,17 @@ class Filesystem
|
|||||||
$this->remove(new \FilesystemIterator($file));
|
$this->remove(new \FilesystemIterator($file));
|
||||||
|
|
||||||
if (true !== @rmdir($file)) {
|
if (true !== @rmdir($file)) {
|
||||||
throw new IOException(sprintf('Failed to remove directory %s', $file));
|
throw new IOException(sprintf('Failed to remove directory "%s".', $file), 0, null, $file);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
// https://bugs.php.net/bug.php?id=52176
|
// https://bugs.php.net/bug.php?id=52176
|
||||||
if (defined('PHP_WINDOWS_VERSION_MAJOR') && is_dir($file)) {
|
if (defined('PHP_WINDOWS_VERSION_MAJOR') && is_dir($file)) {
|
||||||
if (true !== @rmdir($file)) {
|
if (true !== @rmdir($file)) {
|
||||||
throw new IOException(sprintf('Failed to remove file %s', $file));
|
throw new IOException(sprintf('Failed to remove file "%s".', $file), 0, null, $file);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
if (true !== @unlink($file)) {
|
if (true !== @unlink($file)) {
|
||||||
throw new IOException(sprintf('Failed to remove file %s', $file));
|
throw new IOException(sprintf('Failed to remove file "%s".', $file), 0, null, $file);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -174,7 +176,7 @@ class Filesystem
|
|||||||
$this->chmod(new \FilesystemIterator($file), $mode, $umask, true);
|
$this->chmod(new \FilesystemIterator($file), $mode, $umask, true);
|
||||||
}
|
}
|
||||||
if (true !== @chmod($file, $mode & ~$umask)) {
|
if (true !== @chmod($file, $mode & ~$umask)) {
|
||||||
throw new IOException(sprintf('Failed to chmod file %s', $file));
|
throw new IOException(sprintf('Failed to chmod file "%s".', $file), 0, null, $file);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -196,11 +198,11 @@ class Filesystem
|
|||||||
}
|
}
|
||||||
if (is_link($file) && function_exists('lchown')) {
|
if (is_link($file) && function_exists('lchown')) {
|
||||||
if (true !== @lchown($file, $user)) {
|
if (true !== @lchown($file, $user)) {
|
||||||
throw new IOException(sprintf('Failed to chown file %s', $file));
|
throw new IOException(sprintf('Failed to chown file "%s".', $file), 0, null, $file);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
if (true !== @chown($file, $user)) {
|
if (true !== @chown($file, $user)) {
|
||||||
throw new IOException(sprintf('Failed to chown file %s', $file));
|
throw new IOException(sprintf('Failed to chown file "%s".', $file), 0, null, $file);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -223,11 +225,11 @@ class Filesystem
|
|||||||
}
|
}
|
||||||
if (is_link($file) && function_exists('lchgrp')) {
|
if (is_link($file) && function_exists('lchgrp')) {
|
||||||
if (true !== @lchgrp($file, $group)) {
|
if (true !== @lchgrp($file, $group)) {
|
||||||
throw new IOException(sprintf('Failed to chgrp file %s', $file));
|
throw new IOException(sprintf('Failed to chgrp file "%s".', $file), 0, null, $file);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
if (true !== @chgrp($file, $group)) {
|
if (true !== @chgrp($file, $group)) {
|
||||||
throw new IOException(sprintf('Failed to chgrp file %s', $file));
|
throw new IOException(sprintf('Failed to chgrp file "%s".', $file), 0, null, $file);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -247,11 +249,11 @@ class Filesystem
|
|||||||
{
|
{
|
||||||
// we check that target does not exist
|
// we check that target does not exist
|
||||||
if (!$overwrite && is_readable($target)) {
|
if (!$overwrite && is_readable($target)) {
|
||||||
throw new IOException(sprintf('Cannot rename because the target "%s" already exist.', $target));
|
throw new IOException(sprintf('Cannot rename because the target "%s" already exists.', $target), 0, null, $target);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (true !== @rename($origin, $target)) {
|
if (true !== @rename($origin, $target)) {
|
||||||
throw new IOException(sprintf('Cannot rename "%s" to "%s".', $origin, $target));
|
throw new IOException(sprintf('Cannot rename "%s" to "%s".', $origin, $target), 0, null, $target);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -291,7 +293,8 @@ class Filesystem
|
|||||||
throw new IOException('Unable to create symlink due to error code 1314: \'A required privilege is not held by the client\'. Do you have the required Administrator-rights?');
|
throw new IOException('Unable to create symlink due to error code 1314: \'A required privilege is not held by the client\'. Do you have the required Administrator-rights?');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
throw new IOException(sprintf('Failed to create symbolic link from %s to %s', $originDir, $targetDir));
|
|
||||||
|
throw new IOException(sprintf('Failed to create symbolic link from "%s" to "%s".', $originDir, $targetDir), 0, null, $targetDir);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -389,7 +392,7 @@ class Filesystem
|
|||||||
} elseif (is_dir($file)) {
|
} elseif (is_dir($file)) {
|
||||||
$this->mkdir($target);
|
$this->mkdir($target);
|
||||||
} else {
|
} else {
|
||||||
throw new IOException(sprintf('Unable to guess "%s" file type.', $file));
|
throw new IOException(sprintf('Unable to guess "%s" file type.', $file), 0, null, $file);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
if (is_link($file)) {
|
if (is_link($file)) {
|
||||||
@ -399,7 +402,7 @@ class Filesystem
|
|||||||
} elseif (is_file($file)) {
|
} elseif (is_file($file)) {
|
||||||
$this->copy($file, $target, isset($options['override']) ? $options['override'] : false);
|
$this->copy($file, $target, isset($options['override']) ? $options['override'] : false);
|
||||||
} else {
|
} else {
|
||||||
throw new IOException(sprintf('Unable to guess "%s" file type.', $file));
|
throw new IOException(sprintf('Unable to guess "%s" file type.', $file), 0, null, $file);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -427,20 +430,6 @@ class Filesystem
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param mixed $files
|
|
||||||
*
|
|
||||||
* @return \Traversable
|
|
||||||
*/
|
|
||||||
private function toIterator($files)
|
|
||||||
{
|
|
||||||
if (!$files instanceof \Traversable) {
|
|
||||||
$files = new \ArrayObject(is_array($files) ? $files : array($files));
|
|
||||||
}
|
|
||||||
|
|
||||||
return $files;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Atomically dumps content into a file.
|
* Atomically dumps content into a file.
|
||||||
*
|
*
|
||||||
@ -456,16 +445,30 @@ class Filesystem
|
|||||||
if (!is_dir($dir)) {
|
if (!is_dir($dir)) {
|
||||||
$this->mkdir($dir);
|
$this->mkdir($dir);
|
||||||
} elseif (!is_writable($dir)) {
|
} elseif (!is_writable($dir)) {
|
||||||
throw new IOException(sprintf('Unable to write to the "%s" directory.', $dir));
|
throw new IOException(sprintf('Unable to write to the "%s" directory.', $dir), 0, null, $dir);
|
||||||
}
|
}
|
||||||
|
|
||||||
$tmpFile = tempnam($dir, basename($filename));
|
$tmpFile = tempnam($dir, basename($filename));
|
||||||
|
|
||||||
if (false === @file_put_contents($tmpFile, $content)) {
|
if (false === @file_put_contents($tmpFile, $content)) {
|
||||||
throw new IOException(sprintf('Failed to write file "%s".', $filename));
|
throw new IOException(sprintf('Failed to write file "%s".', $filename), 0, null, $filename);
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->rename($tmpFile, $filename, true);
|
$this->rename($tmpFile, $filename, true);
|
||||||
$this->chmod($filename, $mode);
|
$this->chmod($filename, $mode);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param mixed $files
|
||||||
|
*
|
||||||
|
* @return \Traversable
|
||||||
|
*/
|
||||||
|
private function toIterator($files)
|
||||||
|
{
|
||||||
|
if (!$files instanceof \Traversable) {
|
||||||
|
$files = new \ArrayObject(is_array($files) ? $files : array($files));
|
||||||
|
}
|
||||||
|
|
||||||
|
return $files;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
46
src/Symfony/Component/Filesystem/Tests/ExceptionTest.php
Normal file
46
src/Symfony/Component/Filesystem/Tests/ExceptionTest.php
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This file is part of the Symfony package.
|
||||||
|
*
|
||||||
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view the LICENSE
|
||||||
|
* file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Symfony\Component\Filesystem\Tests;
|
||||||
|
|
||||||
|
use Symfony\Component\Filesystem\Exception\IOException;
|
||||||
|
use Symfony\Component\Filesystem\Exception\FileNotFoundException;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test class for Filesystem.
|
||||||
|
*/
|
||||||
|
class ExceptionTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
public function testGetPath()
|
||||||
|
{
|
||||||
|
$e = new IOException('', 0, null, '/foo');
|
||||||
|
$this->assertEquals('/foo', $e->getPath(), 'The pass should be returned.');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testGeneratedMessage()
|
||||||
|
{
|
||||||
|
$e = new FileNotFoundException(null, 0, null, '/foo');
|
||||||
|
$this->assertEquals('/foo', $e->getPath());
|
||||||
|
$this->assertEquals('File "/foo" could not be found.', $e->getMessage(), 'A message should be generated.');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testGeneratedMessageWithoutPath()
|
||||||
|
{
|
||||||
|
$e = new FileNotFoundException();
|
||||||
|
$this->assertEquals('File could not be found.', $e->getMessage(), 'A message should be generated.');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testCustomMessage()
|
||||||
|
{
|
||||||
|
$e = new FileNotFoundException('bar', 0, null, '/foo');
|
||||||
|
$this->assertEquals('bar', $e->getMessage(), 'A custom message should be possible still.');
|
||||||
|
}
|
||||||
|
}
|
Reference in New Issue
Block a user