feat: added File mode consts

ambimax · Nov 2, 2022 · bb4fe16 · bb4fe16
1 parent 5670633
commit bb4fe16
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/src/File.php b/src/File.php
@@ -8,6 +8,10 @@
 
 class File implements FileInterface
 {
+    public const MODE_READ = 'r';
+    public const MODE_READ_PLUS = 'r+';
+    public const MODE_WRITE = 'w';
+    public const MODE_WRITE_PLUS = 'w+';
     /**
      * @var resource
      */
@@ -16,6 +20,9 @@ class File implements FileInterface
     protected string $filePath;
     protected string $mode;
 
+    /**
+     * @param self::MODE_* $mode
+     */
     public function __construct(string $filePath, string $mode)
     {
         $this->openStream($filePath, $mode);

diff --git a/src/Remote/SftpFile.php b/src/Remote/SftpFile.php
@@ -7,7 +7,6 @@
 use Ambimax\File\File;
 use phpseclib3\Net\SFTP;
 use phpseclib3\Net\SFTP\Stream;
-use RuntimeException;
 
 class SftpFile extends File
 {
@@ -16,6 +15,9 @@ class SftpFile extends File
     protected string $password;
     protected SFTP $sftp;
 
+    /**
+     * @param File::MODE_* $mode
+     */
     public function __construct(string $hostname, string $username, string $password, string $filePath, string $mode)
     {
         $this->hostname = $hostname;
@@ -38,7 +40,7 @@ protected function openStream(string $filePath, string $mode): void
             $mode);
 
         if (false === $tmpFileHandle) {
-            throw new RuntimeException(sprintf('Could not open file \'%s\'.', $filePath));
+            throw new \RuntimeException(sprintf('Could not open file \'%s\'.', $filePath));
         }
 
         $this->fileHandle = $tmpFileHandle;