Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krowinski/php-inotify
Monitor files and folders in real time using inotify. Wraps php inotify module into object and dispatch them using event dispatcher.
https://github.com/krowinski/php-inotify
dispatch filesystem inotify php php-inotify
Last synced: 1 day ago
JSON representation
Monitor files and folders in real time using inotify. Wraps php inotify module into object and dispatch them using event dispatcher.
- Host: GitHub
- URL: https://github.com/krowinski/php-inotify
- Owner: krowinski
- License: mit
- Created: 2019-08-11T09:29:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-20T19:29:38.000Z (almost 2 years ago)
- Last Synced: 2024-11-03T06:09:07.390Z (11 days ago)
- Topics: dispatch, filesystem, inotify, php, php-inotify
- Language: PHP
- Homepage:
- Size: 23.4 KB
- Stars: 20
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
php-inotify
=========
[](https://scrutinizer-ci.com/g/krowinski/php-inotify/build-status/master)
[](https://scrutinizer-ci.com/g/krowinski/php-inotify/?branch=master)
[](https://scrutinizer-ci.com/g/krowinski/php-inotify/?branch=master)
[](https://github.com/krowinski/php-inotify/actions/workflows/tests.yml)
Why
=========
In cases when you need to scan dir to find new files or files modifications,
you probably will create some script and implements pulling mechanism.
That is good for small systems with less files but not efficient enough for big one.
And that why we got inotify mechanism that generate event on file|dir changes
like create, delete, change and many more that we can listen to.
More info in php manual. [here](https://www.php.net/manual/en/book.inotify.php)
Installation
=========
```bash
composer require krowinski/php-inotify
```
Installing inotify extension for php
=========
To listen on event we need php extension called inotify.
In most cases you just need to install using pecl
(example in [dockerfile](https://github.com/krowinski/php-inotify/blob/master/Dockerfile))
Example
=========
You can find example in
[example.php](https://github.com/krowinski/php-inotify/blob/master/example/example.php)
and events that you can listen to [InotifyEventCodeEnum.php](https://github.com/krowinski/php-inotify/blob/master/src/Inotify/InotifyEventCodeEnum.php)
Event implement Arrayable, JsonSerializable and __toString.
```php
Array
(
[id] => 1
[eventCode] => 256
[eventDescription] => ON_CREATE - File or directory created in watched directory
[uniqueId] => 0
[fileName] => 2
[pathName] => /tmp
[customName] => test
[pathWithFile] => /tmp/2
[timestamp] => 1565610455
)
Array
(
[id] => 1
[eventCode] => 32
[eventDescription] => ON_OPEN - File was opened
[uniqueId] => 0
[fileName] => 2
[pathName] => /tmp
[customName] => test
[pathWithFile] => /tmp/2
[timestamp] => 1565610455
)
Array
(
[id] => 1
[eventCode] => 4
[eventDescription] => ON_ATTRIB - Metadata changed (e.g. permissions, mtime, etc.)
[uniqueId] => 0
[fileName] => 2
[pathName] => /tmp
[customName] => test
[pathWithFile] => /tmp/2
[timestamp] => 1565610455
)
Array
(
[id] => 1
[eventCode] => 8
[eventDescription] => ON_CLOSE_WRITE - File opened for writing was closed
[uniqueId] => 0
[fileName] => 2
[pathName] => /tmp
[customName] => test
[pathWithFile] => /tmp/2
[timestamp] => 1565610455
)
Array
(
[id] => 1
[eventCode] => 512
[eventDescription] => ON_DELETE - File or directory deleted in watched directory
[uniqueId] => 0
[fileName] => 2
[pathName] => /tmp
[customName] => test
[pathWithFile] => /tmp/2
[timestamp] => 1565610456
)
```
Where:
```
[id] => watch descriptor
[eventCode] => bit mask of events
[eventDescription] => human readable event description (can be UNKNOWN if not found in InotifyEventCodeEnum)
[uniqueId] => is a unique id to connect related events (e.g. IN_MOVE_FROM and IN_MOVE_TO)
[fileName] => name of a file (e.g. if a file was modified in a watched directory)
[pathName] => watched resource you give in configuration
[customName] => custom resource name for external parsing like "form-upload-dir" etc
[pathWithFile] => helper that contact pathName and fileName
[timestamp] => ...
```