watcher/watcher

A simple watcher library written by PHP.

0.5.1 2017-02-04 12:49 UTC

Requires

• php: >=5.5 | >=7.0
• psr/log: ^1.0

Requires (Dev)

• phpunit/phpunit: >=4.8 <=5.7
• pimple/pimple: ^3.0
• squizlabs/php_codesniffer: ^2.7

Suggests

• ext-inotify: Linux kernel subsystem, reports fs changes to applications.

MIT License

• MilesChou

README

A simple watcher library written by PHP.

Usage

Install using Composer

$ composer require mileschou/watcher

Watch file

Example of watch file

<?php

use Watcher\Watcher;

$watcher = new Watcher();
$watcher->setFile('file1', '/path/to/file');

$watcher->watch(function($alias, $file, $isInit) {
    if ($isInit) {
        return;
    }
    
    echo $file . ' is Changed';
});

Run once

Example of run one time.

<?php

use Watcher\Watcher;

$watcher = new Watcher();
$watcher->setFile('file1', '/path/to/file');

$watcher->run(function($alias, $file) {
    echo 'Show ' . $file;
});

Container

You can using simple container, default will trans to ArrayObject

<?php

use Watcher\Watcher;

$container = ['something'];

$watcher = new Watcher($container);
$watcher->setFile('file1', '/path/to/file');

$watcher->run(function($alias, $file) {
    /** @var ArrayObject $this */
    $data = $this->getArrayCopy();
    
    echo 'Container data is ' . $data[0]; // Will see 'something'
});

Or using other container library.

<?php

use Watcher\Watcher;

$container = new \Pimple\Container();
$container['some-key'] = 'some-value';

$watcher = new Watcher($container);
$watcher->setFile('file1', '/path/to/file');

$watcher->run(function($alias, $file) {
    /** @var \Pimple\Container $this */
    $data = $this['some-key'];
    
    echo 'Pimple container data is ' . $data; // Will see 'some-value'
});

Strategy

Here are two Strategy can use

<?php

use Watcher\Strategy;
use Watcher\Watcher;

// Use inotify extension, it will throw exception if you do not installed
$strategy = new Strategy\Inotify();

// Use file system 
$strategy = new Strategy\FileSystem();

$watcher = new Watcher();
$watcher->setStrategy($strategy);

I guess that using inotify is faster. Actually, I don't know how to test performance.