danog/file
1
0
Fork 0
mirror of https://github.com/danog/file.git synced 2024-11-26 20:04:51 +01:00
Code Issues Projects Releases Wiki Activity

Improve exception documentation

Browse Source
This commit is contained in:
Niklas Keller 2022-02-08 22:20:28 +01:00
parent 067229676b
commit 6fc18e8f1d
2 changed files with 37 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/Filesystem.php
View File

@ -240,6 +240,8 @@ final class Filesystem
* @fails \Amp\Files\FilesystemException If the operation fails.
*
* @return string
*
* @throws FilesystemException
*/
public function resolveSymlink(string $path): string
{
@ -251,7 +253,8 @@ final class Filesystem
*
* @param string $from
* @param string $to
* @fails \Amp\Files\FilesystemException If the operation fails.
*
* @throws FilesystemException If the operation fails.
*/
public function move(string $from, string $to): void
{
@ -262,7 +265,8 @@ final class Filesystem
* Delete a file.
*
* @param string $path
* @fails \Amp\Files\FilesystemException If the operation fails.
*
* @throws FilesystemException If the operation fails.
*/
public function deleteFile(string $path): void
{
@ -273,8 +277,9 @@ final class Filesystem
* Create a directory.
*
* @param string $path
* @param int $mode
* @fails \Amp\Files\FilesystemException If the operation fails.
* @param int $mode
*
* @throws FilesystemException If the operation fails.
*/
public function createDirectory(string $path, int $mode = 0777): void
{
@ -285,8 +290,9 @@ final class Filesystem
* Create a directory recursively.
*
* @param string $path
* @param int $mode
* @fails \Amp\Files\FilesystemException If the operation fails.
* @param int $mode
*
* @throws FilesystemException If the operation fails.
*/
public function createDirectoryRecursively(string $path, int $mode = 0777): void
{
@ -297,7 +303,8 @@ final class Filesystem
* Delete a directory.
*
* @param string $path
* @fails \Amp\Files\FilesystemException If the operation fails.
*
* @throws FilesystemException If the operation fails.
*/
public function deleteDirectory(string $path): void
{
@ -312,6 +319,8 @@ final class Filesystem
* @param string $path
*
* @return list<string>
*
* @throws FilesystemException If the operation fails.
*/
public function listFiles(string $path): array
{
@ -322,7 +331,7 @@ final class Filesystem
* Change permissions of a file or directory.
*
* @param string $path
* @param int $mode
* @param int $mode
* @fails \Amp\Files\FilesystemException If the operation fails.
*/
public function changePermissions(string $path, int $mode): void
@ -333,7 +342,7 @@ final class Filesystem
/**
* Change ownership of a file or directory.
*
* @param string $path
* @param string $path
* @param int|null $uid null to ignore
* @param int|null $gid null to ignore
* @fails \Amp\Files\FilesystemException If the operation fails.
@ -348,7 +357,7 @@ final class Filesystem
*
* If the file does not exist it will be created automatically.
*
* @param string $path
* @param string $path
* @param int|null $modificationTime The touch time. If $time is not supplied, the current system time is used.
* @param int|null $accessTime The access time. If not supplied, the modification time is used.
* @fails \Amp\Files\FilesystemException If the operation fails.

20
src/FilesystemDriver.php
View File

@ -19,7 +19,7 @@ interface FilesystemDriver
/**
* Get file status; also known as stat operation.
*
* If the requested path does not exist the resulting Promise will resolve to NULL.
* If the requested path does not exist, it returns {@code null}.
*
* @param string $path The file system path to stat.
*
@ -34,7 +34,7 @@ interface FilesystemDriver
*
* @param string $path The file system path to stat.
*
* @return array|null A promise resolving to an associative array upon successful resolution.
* @return array|null An associative array upon successful completion.
*/
public function getLinkStatus(string $path): ?array;
@ -101,6 +101,8 @@ interface FilesystemDriver
*
* @param string $path
* @param int $mode
*
* @throws FilesystemException If the operation fails.
*/
public function createDirectoryRecursively(string $path, int $mode = 0777): void;
@ -108,6 +110,8 @@ interface FilesystemDriver
* Delete a directory.
*
* @param string $path
*
* @throws FilesystemException If the operation fails.
*/
public function deleteDirectory(string $path): void;
@ -119,6 +123,8 @@ interface FilesystemDriver
* @param string $path
*
* @return list<string>
*
* @throws FilesystemException If the operation fails.
*/
public function listFiles(string $path): array;
@ -127,6 +133,8 @@ interface FilesystemDriver
*
* @param string $path
* @param int $mode
*
* @throws FilesystemException If the operation fails.
*/
public function changePermissions(string $path, int $mode): void;
@ -136,6 +144,8 @@ interface FilesystemDriver
* @param string $path
* @param int|null $uid
* @param int|null $gid
*
* @throws FilesystemException If the operation fails.
*/
public function changeOwner(string $path, ?int $uid, ?int $gid): void;
@ -148,6 +158,8 @@ interface FilesystemDriver
* @param int|null $modificationTime The touch time. If $time is not supplied, the current system time is used.
* @param int|null $accessTime The access time. If $atime is not supplied, value passed to the $time parameter is
* used.
*
* @throws FilesystemException If the operation fails.
*/
public function touch(string $path, ?int $modificationTime, ?int $accessTime): void;
@ -157,6 +169,8 @@ interface FilesystemDriver
* @param string $path The file path from which to buffer contents.
*
* @return string A promise resolving to a string upon successful resolution.
*
* @throws FilesystemException If the operation fails.
*/
public function read(string $path): string;
@ -165,6 +179,8 @@ interface FilesystemDriver
*
* @param string $path The file path to which to $contents should be written.
* @param string $contents The data to write to the specified $path.
*
* @throws FilesystemException If the operation fails.
*/
public function write(string $path, string $contents): void;
}