Updating API doc to reflect directory operations #1097
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Given thephpleague#117, at least since 2014 the docs were missing clearer information on whether it's possible to delete/rename/move directories as well as files.
| `$to` | new location | `string` | ||
| `$response` | success boolean | `bool` | ||
|
|
||
| --- | ||
|
|
||
| ## Copy Files |
There was a problem hiding this comment.
We should add a note here that this is not consistent behaviour across adapters (for local it works, for AWS it doesn't for example.
|
Not sure if this got reverted / changed in new versions, but the current docs do not make clear if move can be used on directories: https://flysystem.thephpleague.com/docs/usage/filesystem-api/: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Given #117, at least since 2014 the docs were missing clearer information on whether it's possible to delete/rename/move directories as well as files.