Add missing permission options for sftp adapter (#19)

* Add missing permission options for sftp adapter * Add directoryPerm to sftp document * Remove note in sftp adapter definition builder * fix allow type to match its name * add all available options
thephpleague · Aug 27, 2019 · f68baf6 · f68baf6
1 parent 3c54279
commit f68baf6
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/docs/3-interacting-with-ftp-and-sftp-servers.md b/docs/3-interacting-with-ftp-and-sftp-servers.md
@@ -56,6 +56,9 @@ flysystem:
                 private_key: 'path/to/or/contents/of/privatekey'
                 root: '/path/to/root'
                 timeout: 10
+                directoryPerm: 0744
+                permPublic: 0700
+                permPrivate: 0744
 ```
 
 ## Next

diff --git a/src/Adapter/Builder/SftpAdapterDefinitionBuilder.php b/src/Adapter/Builder/SftpAdapterDefinitionBuilder.php
@@ -56,6 +56,15 @@ protected function configureOptions(OptionsResolver $resolver)
 
         $resolver->setDefault('timeout', 90);
         $resolver->setAllowedTypes('timeout', 'scalar');
+
+        $resolver->setDefault('directoryPerm', 0744);
+        $resolver->setAllowedTypes('directoryPerm', 'scalar');
+
+        $resolver->setDefault('permPrivate', 0700);
+        $resolver->setAllowedTypes('permPrivate', 'scalar');
+
+        $resolver->setDefault('permPublic', 0744);
+        $resolver->setAllowedTypes('permPublic', 'scalar');
     }
 
     protected function configureDefinition(Definition $definition, array $options)

diff --git a/tests/Adapter/Builder/SftpAdapterDefinitionBuilderTest.php b/tests/Adapter/Builder/SftpAdapterDefinitionBuilderTest.php
@@ -59,13 +59,19 @@ public function testOptionsBehavior()
             'root' => '/path/to/root',
             'private_key' => '/path/to/or/contents/of/privatekey',
             'timeout' => 30,
+            'directoryPerm' => 0755,
+            'permPrivate' => 0700,
+            'permPublic' => 0744,
         ]);
 
         $expected = [
             'port' => 22,
             'root' => '/path/to/root',
             'private_key' => '/path/to/or/contents/of/privatekey',
             'timeout' => 30,
+            'directoryPerm' => 0755,
+            'permPrivate' => 0700,
+            'permPublic' => 0744,
             'host' => 'ftp.example.com',
             'username' => 'username',
             'password' => 'password',

diff --git a/tests/Kernel/config/flysystem.yaml b/tests/Kernel/config/flysystem.yaml
@@ -91,6 +91,9 @@ flysystem:
                 private_key: 'path/to/or/contents/of/privatekey'
                 root: '/path/to/root'
                 timeout: 10
+                directoryPerm: 0755
+                permPrivate: 0700
+                permPublic: 0744
 
         fs_webdav:
             adapter: 'webdav'