jeckel/demotools

Tools for demo script

, _(*1)

DemoTools

Suite of tools for demo scripts, _(*2)

Requirements

This tools worj only with PHP7+ for now., _(*3)

It's using ANSI codes for color management., _(*4)

Color

The Color interface define some constants to use in terminal messages., _(*5)

Terminal

The Terminal static class provide some methods to interact with the user with the terminal :, _(*6)

• cls: Clear screen
• clear: Clear screen (alias of cls)
• pause: Wait for user to press a key
• readUserEntry: Read user entry (with an optional question)
• printTitle: Print a title
• menu: display a menu, and return the selected item
• printColoredLine: print a line with a defined color
• printSuccess: print a success message (in green by default)
• printFailure: print a failure message (in red by default)
• printR: print a dump of all given parameters

cls and clear

Usage:, _(*7)

Terminal::cls():

// or

Terminal::clear();

pause

Usage:, _(*8)

Terminal::pause(); // Display "Press any key to continue..." by default

// or

Terminal::pause('Press a key for next');

readUserEntry

Usage:, _(*9)

$username = Terminal::readUserEntry('Enter your username:');

menu

Usage:, _(*10)

$menuItems = [
    1 => 'Add user',
    2 => 'List users',
    3 => 'Remove user',
    9 => 'Exit'
];

$selectedItem = Terminal::menu($menuItems, 'Manage users:');

Will display:, _(*11)

Manage users:
 - [1] Add user
 - [2] List users
 - [3] Remove user
 - [9] Exit
Your choice: 9

printColoredLine

Usage:, _(*12)

Terminal::printColoredLine('It works', Color::GREEN);

printSuccess

Usage:, _(*13)

Terminal::printSuccess(); // Will display 'success' in green

// or

Terminal::printSuccess('done'); // Will display 'done' in green

// or

Terminal::printSuccess('done', Color::BLUE) // Will display 'done' in blue

printFailure

Usage:, _(*14)

Terminal::printFailure(); // Will display 'failure' in red

// or

Terminal::printFailure('It failed'); // Will display 'It failed' in red

// or

Terminal::printFailure('It failed', Color::BLUE) // Will display 'It failed' in blue

printR

Used to debug values., _(*15)

Usage:, _(*16)

Terminal::printR($value1, $value2, $value3);

Menu

Menu is a class used to create an interractive menu. You just need to pass an array of callables:, _(*17)

Usage:, _(*18)

$items = [
    'Display Hello' = function() { echo 'Hello'; },
    'Use callback' = 'MyClass::MyFunction'
];

(new Menu($items))->loop('Choose an option');

It will always add an exit option to the given menu., _(*19)