olivebbs/getch

Implements _getch and _ungetch for windows and linux using ffi

This package's canonical repository appears to be gone and the package has been frozen as a result.

1.6.0 2023-02-10 04:49 UTC

Requires

• php: >=8.0
• ext-ffi: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.14
• phpunit/phpunit: ^9.5

Conflicts

• sikofitt/getch: *

MPL-2.0

• R. Eric Wheeler

• console
• linux
• windows
• hotkey
• getch
• conio
• conio.h
• termios

README

This simply uses the FFI extension to enable _getch and _ungetch in Windows and linux.

$ composer require olivebbs/getch

 use Olive\Console\Getch;
 $g = new Getch($linuxLibrary = null); // can also be a library that implements a function called _getch;
                                       // by default uses the bundled Resources/libgetch.so
                                       // on windows uses the built in _getch function.
 $ord = $g->getch();
 print \chr($ord);
 
 $ord = $g->ungetch('A');
 $res = $g->getch();
 $ord === $res // 65

Note that if you want to put a word into the STDIN stack, you need to do it in reverse.

    foreach(\str_split(\strrev('Hello World!')) as $char) {
        ungetch($char);
    }

    $result = '';

    do {
        $ord = getch();
        $result .= \chr($ord);
   } while($ord !== ord('!'));

   print $result; // Hello World!

There are also helper functions called getch() and ungetch();

use function Olive\Console\getch;
$ord = getch($linuxLibrary = null);
print \chr($ord);

$ord = ungetch('B');
$res = getch();
 $ord === $res // 66

Tests

vendor/bin/phpunit