Callback during sync for Hazaar\File\Dir #203

New issue

Closed

opened 2020-09-29 07:41:06 +00:00 by jamie · 3 comments

jamie commented

2020-09-29 07:41:06 +00:00

(Migrated from git.hazaar.io)

Problem

The Hazaar\File\Dir class has a sync function that will sync files from one directory to another. This works across media backends as well. Because of this, the process an take some time and may be prone to communications errors on remote storage backends such as Dropbox and SharePoint.

Solution

To help eleviate these issues and allow a bit more customisation when using the sync function, I would like to be able to supply a callback function as an argument. This callback is triggered for various events such as file copy start/finish, dir copy start/finish and any errors. The callback can also be passed the source/target file/directory as well as the exception/error that occurred. The reason we wouldn't want to throw an exception internally is because we may want to carry on copying files even if an error occurs, or even get the sync to retry.

Returns

true, null or void - Everything is fine and the sync should carry on.
false - Then the sync did something wrong and should retry.

**Problem** The `Hazaar\File\Dir` class has a `sync` function that will sync files from one directory to another. This works across media backends as well. Because of this, the process an take some time and may be prone to communications errors on remote storage backends such as Dropbox and SharePoint. **Solution** To help eleviate these issues and allow a bit more customisation when using the sync function, I would like to be able to supply a callback function as an argument. This callback is triggered for various events such as file copy start/finish, dir copy start/finish and any errors. The callback can also be passed the source/target file/directory as well as the exception/error that occurred. The reason we wouldn't want to throw an exception internally is because we may want to carry on copying files even if an error occurs, or even get the sync to retry. **Returns** * `true`, `null` or `void` - Everything is fine and the sync should carry on. * `false` - Then the sync did something wrong and should retry.

jamie commented

2020-09-29 07:41:10 +00:00

(Migrated from git.hazaar.io)

created merge request !96 to address this issue