watcher/watcher

A simple watcher library written by PHP.

Watcher

, _(*1)

A simple watcher library written by PHP., _(*2)

Usage

Install using Composer, _(*3)

$ composer require mileschou/watcher

Watch file

Example of watch file, _(*4)

<?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., _(*5)

<?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, _(*6)

<?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., _(*7)

<?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, _(*8)

<?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., _(*9)