zeptech / fun-box
Function collection
dev-master
2014-07-10 14:12 UTC
Requires
- php: >=5.4.0
- zeptech/utility: dev-master
This package is not auto-updated.
Last update: 2024-10-26 14:32:45 UTC
README
A set of useful utility functions.
Install
Install via Composer:
{
"require": {
"zeptech/fun-box": "dev-master"
}
}
Initialization
In order to use functions Fun Box must be initialized because php doesn't
provide function autoloading. Once initialized, functions are included using the
ensureFn
function.
<?php
// ... Initialize composer
FunBox::init();
ensureFn('passwordPrompt');
// ...
if ($interactive) {
$pw = passwordPrompt();
}
Functions
List of functions provided by Fun Box
announceWait
Output a countdown to the command line.
announceWait($waitTime, $message = 'Commencing');
- @param waitTime integer Number of seconds to count down before continuing.
- @param message string What will happen when the countdown is complete.
passwordPrompt
Prompt the user for a password from the command line.
passwordPrompt($prompt = 'password: ');
- @param prompt string The prompt for the user.