Merge pull request #4 from phprtc/dev

Fixed methods visibility & and made Watcher extensible

Author: Ahmard

README.md

@@ -21,11 +21,12 @@ Watcher::create()
     ->addPath(__DIR__ . '/app')
     ->addPath(__DIR__ . '/views')
     ->onChange(function (EventInfo $eventInfo) {
-        var_dump($eventInfo->getWatchedItem()->getFullPath());
+        echo $eventInfo->getWatchedItem()->getFullPath() . PHP_EOL;
     });
 ```
 
 #### Filter
+
 - Make sure that the file whose event is being fired should not end with provided characters.
     ```php
     use RTC\Watcher\Watcher;
@@ -36,7 +37,7 @@ Watcher::create()
         ->addPath(__DIR__ . '/app')
         ->fileShouldNotEndWith(['.php'])
         ->onChange(function (EventInfo $eventInfo) {
-            var_dump($eventInfo->getWatchedItem()->getFullPath());
+            echo $eventInfo->getWatchedItem()->getFullPath() . PHP_EOL;
         });
     ```
 
@@ -50,12 +51,12 @@ Watcher::create()
         ->addPath(__DIR__ . '/app')
         ->addExtension('php')
         ->onChange(function (EventInfo $eventInfo) {
-            var_dump($eventInfo->getWatchedItem()->getFullPath());
+            echo $eventInfo->getWatchedItem()->getFullPath() . PHP_EOL;
         });
     ```
 
-
 #### Any-event
+
 Listens to any event on given path
 
 Be careful using this method.
@@ -68,12 +69,10 @@ require 'vendor/autoload.php';
 Watcher::create()
     ->addPath(__DIR__ . '/app')
     ->onAny(function (EventInfo $eventInfo) {
-        var_dump($eventInfo->getWatchedItem()->getFullPath());
+        echo date('H:i:s') . " - {$eventInfo->getName()} {$eventInfo->getWatchedItem()->getFullPath()}\n";
     });
 ```
 
-
-
 #### Swoole Server Integration
 
 ```php

src/Watcher.php

@@ -48,7 +48,7 @@ public function __construct()
      *
      * @return mixed
      */
-    public function getInotifyFD(): mixed
+    protected function getInotifyFD(): mixed
     {
         if (!isset($this->inotifyFD)) {
             $this->inotifyFD = inotify_init();
@@ -57,71 +57,13 @@ public function getInotifyFD(): mixed
         return $this->inotifyFD;
     }
 
-    /**
-     * Returns list of files currently being watched
-     *
-     * @return WatchedItem[]
-     */
-    public function getWatchedItems(): array
-    {
-        return $this->watchedItems;
-    }
-
-    /**
-     * Start watching file system changes
-     *
-     * @return void
-     */
-    public function watch(): void
-    {
-        // Register paths
-        foreach ($this->paths as $path) {
-            $this->recursivelyRegisterInotifyEvent($path);
-        }
-
-        // Set up a new event listener for inotify read events
-        SwooleEvent::add($this->getInotifyFD(), function () {
-            $inotifyEvents = inotify_read($this->getInotifyFD());
-
-            // IF WE ARE LISTENING TO 'ON_ALL_EVENTS'
-            if ($this->willWatchAny) {
-                foreach ($inotifyEvents as $inotifyEvent) {
-                    $this->inotifyPerformAdditionalOperations($inotifyEvent);
-
-                    $this->fireEvent($inotifyEvent);
-                }
-
-                return;
-            }
-
-            // INDIVIDUAL LISTENERS
-            foreach ($inotifyEvents as $inotifyEvent) {
-                $this->inotifyPerformAdditionalOperations($inotifyEvent);
-
-                // Make sure that we support this event
-                if ($inotifyEvent['mask'] == $this->event->value) {
-                    $this->fireEvent($inotifyEvent);
-                }
-            }
-
-        });
-
-        // Set to monitor and listen for read events for the given $fd
-        SwooleEvent::set(
-            $this->getInotifyFD(),
-            null,
-            null,
-            SWOOLE_EVENT_READ
-        );
-    }
-
     /**
      * Handles directory creation/deletion on the fly
      *
      * @param array $inotifyEvent
      * @return void
      */
-    private function inotifyPerformAdditionalOperations(array $inotifyEvent): void
+    protected function inotifyPerformAdditionalOperations(array $inotifyEvent): void
     {
         // Handle directory creation
         if ($inotifyEvent['mask'] == $this->maskItemCreated) {
@@ -151,7 +93,7 @@ private function inotifyPerformAdditionalOperations(array $inotifyEvent): void
      * @param string $path
      * @return void
      */
-    private function recursivelyRegisterInotifyEvent(string $path): void
+    protected function recursivelyRegisterInotifyEvent(string $path): void
     {
         if (is_dir($path)) {
             $iterator = new RecursiveDirectoryIterator($path);
@@ -176,7 +118,7 @@ private function recursivelyRegisterInotifyEvent(string $path): void
      * @param string $path
      * @return void
      */
-    private function registerInotifyEvent(string $path): void
+    protected function registerInotifyEvent(string $path): void
     {
         $descriptor = inotify_add_watch(
             $this->getInotifyFD(),
@@ -196,7 +138,7 @@ private function registerInotifyEvent(string $path): void
      * @param EventInfo $eventInfo
      * @return void
      */
-    public function removeInotifyEvent(EventInfo $eventInfo)
+    protected function removeInotifyEvent(EventInfo $eventInfo)
     {
         // Stop watching event
         inotify_rm_watch($this->getInotifyFD(), $eventInfo->getWatchDescriptor());
@@ -211,7 +153,7 @@ public function removeInotifyEvent(EventInfo $eventInfo)
      * @param array $inotifyEvent
      * @return void
      */
-    private function fireEvent(array $inotifyEvent): void
+    protected function fireEvent(array $inotifyEvent): void
     {
         $shouldFireEvent = array_key_exists($inotifyEvent['mask'], self::$constants);
 
@@ -248,6 +190,64 @@ private function fireEvent(array $inotifyEvent): void
         }
     }
 
+    /**
+     * Returns list of files currently being watched
+     *
+     * @return WatchedItem[]
+     */
+    public function getWatchedItems(): array
+    {
+        return $this->watchedItems;
+    }
+
+    /**
+     * Start watching file system changes
+     *
+     * @return void
+     */
+    public function watch(): void
+    {
+        // Register paths
+        foreach ($this->paths as $path) {
+            $this->recursivelyRegisterInotifyEvent($path);
+        }
+
+        // Set up a new event listener for inotify read events
+        SwooleEvent::add($this->getInotifyFD(), function () {
+            $inotifyEvents = inotify_read($this->getInotifyFD());
+
+            // IF WE ARE LISTENING TO 'ON_ALL_EVENTS'
+            if ($this->willWatchAny) {
+                foreach ($inotifyEvents as $inotifyEvent) {
+                    $this->inotifyPerformAdditionalOperations($inotifyEvent);
+
+                    $this->fireEvent($inotifyEvent);
+                }
+
+                return;
+            }
+
+            // INDIVIDUAL LISTENERS
+            foreach ($inotifyEvents as $inotifyEvent) {
+                $this->inotifyPerformAdditionalOperations($inotifyEvent);
+
+                // Make sure that we support this event
+                if ($inotifyEvent['mask'] == $this->event->value) {
+                    $this->fireEvent($inotifyEvent);
+                }
+            }
+
+        });
+
+        // Set to monitor and listen for read events for the given $fd
+        SwooleEvent::set(
+            $this->getInotifyFD(),
+            null,
+            null,
+            SWOOLE_EVENT_READ
+        );
+    }
+
     /**
      * Add file extension filter
      *