cydrickn/php-watcher

简单的文件监视器

v1.0.3 2022-08-26 14:31 UTC

This package is auto-updated.

Last update: 2024-08-26 19:05:01 UTC


README

使用PHP编写的简单目录和文件监视器。

安装

composer require cydrickn/php-watcher

用法

要使用此包,您只需初始化监视器并调用tick函数

<?php

require_once './vendor/autoload.php';

$watcher = new \Cydrickn\PHPWatcher\Watcher(
    [__DIR__],
    [__DIR__ . '/vendor/'],
    function (array $changes) {
        echo json_encode($changes) . PHP_EOL;
    }
);

$watcher->tick();

\Cydrickn\PHPWatcher\Watcher::__construct

\Cydrickn\PHPWatcher\Watcher::__construct - 创建代表监视器的实例

描述

public \Cydrickn\PHPWatcher\Watcher::__construct(
    array $watchFor,
    array $excludes,
    callable $handler,
    int $interval = 1000
)

参数

watchFor

监视器将监视的文件和文件夹列表。

对于文件夹,这包括其子文件夹。

excludes

将排除在监视之外的文件和文件夹列表。

对于文件夹,这包括其子文件夹。

handler

一个函数,当有变化时会调用。

interval

这是它将等待多长时间才进行文件/文件夹检查的延迟。默认为1000毫秒。

\Cydrickn\PHPWatcher\Watcher::checkChanges

\Cydrickn\PHPWatcher\Watcher::checkChanges - 检查变化

描述

public \Cydrickn\PHPWatcher\Watcher::checkChanges(): void

\Cydrickn\PHPWatcher\Watcher::tick

\Cydrickn\PHPWatcher\Watcher::tick - 开始监视文件

描述

public \Cydrickn\PHPWatcher\Watcher::tick(
    ?callable $handler = null
): void

参数

handler

用于监视文件的调用函数,默认为null。

一旦handler为null,它将使用默认handler。

有两个默认handler。

  • Swoole\Timer - 当您的服务器启用swoole时才会使用
  • do while - 如果swoole未启用

一旦您传递自己的handler,这将传递两个参数

  • 第一个参数是checkChanges函数
  • 第二个是间隔