README

• Tail
  • Installation
  • Usage
    • Starting line
    • N lines from the end
    • Following new lines
      • Sleep duration
      • Follow timeout
      • Follow until a process dies

Installation

Install tail via Composer:

composer require ali-eltaweel/tail

Usage

$tail = new Files\Tail();

foreach ($tail->tail('path/to/file.txt') as $line) {

  echo $line;
}

The previous loop will iterate over all lines in the specified file.

Starting line

foreach ($tail->tail('path/to/file.txt', startLine: 3) as $line) {

  echo $line;
}

note: You can either specify $startLine or $line not both.

N lines from the end

foreach ($tail->tail('path/to/file.txt', lines: 5) as $line) {

  echo $line;
}

note: You can either specify $startLine or $line not both.

Following new lines

foreach ($tail->tail('path/to/file.txt', follow: true) as $line) {

  echo $line;
}

Sleep duration

foreach ($tail->tail('path/to/file.txt', follow: true, sleepMicros: 1_000_000) as $line) {

  echo $line;
}

Follow timeout

foreach ($tail->tail('path/to/file.txt', follow: true, timeoutMicros: 60_000_000) as $line) {

  echo $line;
}

Follow until a process dies

foreach ($tail->tail('path/to/file.txt', follow: true, pid: 123) as $line) {

  echo $line;
}