Watch changes in the file system using PHP
This package allows you to react to all kinds of changes in the file system.
Here's how you can run code when a new file gets added.
use Spatie\Watcher\Watch;
Watch::path($directory)
->onFileCreated(function (string $newFilePath) {
// do something...
})
->start();
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
composer require spatie/file-system-watcher
In your project, you should have the JavaScript package chokidar installed. You can install it via npm
npm install chokidar
or Yarn
yarn add chokidar
Usage
Here's how you can start watching a directory and get notified of any changes.
use Spatie\Watcher\Watch;
Watch::path($directory)
->onAnyChange(function (string $type, string $path) {
if ($type === Watch::EVENT_TYPE_FILE_CREATED) {
echo "file {$path} was created";
}
})
->start();
You can pass as many directories as you like to path.
To start watching, call the start method.
Detected the type of change
The $type parameter of the closure you pass to onAnyChange can contain one of these values:
Watcher::EVENT_TYPE_FILE_CREATED: a file was createdWatcher::EVENT_TYPE_FILE_UPDATED: a file was updatedWatcher::EVENT_TYPE_FILE_DELETED: a file was deletedWatcher::EVENT_TYPE_DIRECTORY_CREATED: a directory was createdWatcher::EVENT_TYPE_DIRECTORY_DELETED: a directory was deleted
Listening for specific events
To handle file systems events of a certain type, you can make use of dedicated functions. Here's how you would listen for file creations only.
use Spatie\Watcher\Watch;
Watch::path($directory)
->onFileCreated(function (string $newFilePath) {
// do something...
});
These are the related available methods:
onFileCreated(): accepts a closure that will get passed the new file pathonFileUpdated(): accepts a closure that will get passed the updated file pathonFileDeleted(): accepts a closure that will get passed the deleted file pathonDirectoryCreated(): accepts a closure that will get passed the created directory pathonDirectoryDeleted(): accepts a closure that will get passed the deleted directory path
Watching multiple paths
You can pass multiple paths to the paths method.
use Spatie\Watcher\Watch;
Watch::paths($directory, $anotherDirectory);
Performing multiple tasks
You can call onAnyChange, 'onFileCreated', ... multiple times. All given closures will be performed
use Spatie\Watcher\Watch;
Watch::path($directory)
->onFileCreated(function (string $newFilePath) {
// do something on file creation...
})
->onFileCreated(function (string $newFilePath) {
// do something else on file creation...
})
->onAnyChange(function (string $type, string $path) {
// do something...
})
->onAnyChange(function (string $type, string $path) {
// do something else...
})
// ...
Stopping the watcher gracefully
By default, the watcher will continue indefinitely when started. To gracefully stop the watcher, you can call shouldContinue and pass it a closure. If the closure returns a falsy value, the watcher will stop. The given closure will be executed every 0.5 second.
use Spatie\Watcher\Watch;
Watch::path($directory)
->shouldContinue(function () {
// return true or false
})
// ...
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
Parts of this package are inspired by Laravel Octane
License
The MIT License (MIT). Please see License File for more information.
.
2 Sep 3, 2022
1.9k Jan 1, 2023
111 May 19, 2022
40 Aug 20, 2022
1 Oct 12, 2021
2 Nov 3, 2021
192 Dec 17, 2022
541 Dec 30, 2022
31 Oct 6, 2022
547 Dec 28, 2022
1.2k Jan 7, 2023
1 Jan 18, 2022
4 Jul 31, 2022
1 Feb 3, 2022
4 Apr 28, 2022
70 Dec 22, 2022
751 Jan 8, 2023
772 Jan 8, 2023