PHP download

Download the PHP package steve-moretz/file-system-watcher without Composer

On this page you can find all versions of the php package steve-moretz/file-system-watcher. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download steve-moretz/file-system-watcher
More information about steve-moretz/file-system-watcher
Files in steve-moretz/file-system-watcher

Vendor steve-moretz
Package file-system-watcher
Short Description Watch changes in the file system using PHP
License MIT
Homepage https://github.com/spatie/file-system-watcher

Keywords spatie file-system-watcher

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of steve-moretz/file-system-watcher

Informations about the package file-system-watcher

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.

Support

Php 7 | 8

Installation

You can install the package via composer:

In your project, you should have the JavaScript package chokidar installed. You can install it via npm

or Yarn

Usage

Here's how you can start watching a directory and get notified of any changes.

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 created
Watcher::EVENT_TYPE_FILE_UPDATED: a file was updated
Watcher::EVENT_TYPE_FILE_DELETED: a file was deleted
Watcher::EVENT_TYPE_DIRECTORY_CREATED: a directory was created
Watcher::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.

These are the related available methods:

onFileCreated(): accepts a closure that will get passed the new file path
onFileUpdated(): accepts a closure that will get passed the updated file path
onFileDeleted(): accepts a closure that will get passed the deleted file path
onDirectoryCreated(): accepts a closure that will get passed the created directory path
onDirectoryDeleted(): accepts a closure that will get passed the deleted directory path

Watching multiple paths

You can pass multiple paths to the paths method.

Performing multiple tasks

You can call onAnyChange, 'onFileCreated', ... multiple times. All given closures will be performed

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.

Change the speed of watcher

By default, the changes are tracked every 0.5 seconds, however you could change that.

Testing

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

Freek Van der Herten
All Contributors

Parts of this package are inspired by Laravel Octane

License

The MIT License (MIT). Please see License File for more information.

All versions of file-system-watcher with dependencies

PHP Build Version

Package Version

Version 1.0.2 Release 16. Feb 2022
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of file-system-watcher from vendor steve-moretz

Requires php Version ^7.0|^8.0
symfony/process Version ^5.2|^6.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package steve-moretz/file-system-watcher contains the following files

Loading the files please wait ....