PHP code example of dealnews / console

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

dealnews / console example snippets

#!/bin/env php


/**
 * This is a test app called test.php
 */

use \DealNews\Console\Console;

$console = new Console(
    array(
        "copyright" => array(
            "owner" => "DealNews.com, Inc.",
            "year" => "1997-".date("Y")
        ),
        "help" => array(
            "header" => "This is a test app"
        )
    ),
    array(
        "s" => array(
            "description" => "Some option called -s",
            "param" => "SPARAM",
            "optional" => Console::ONE_REQUIRED
        ),
        "e" => array(
            "description" => "Some option called -e",
            "param" => "EPARAM",
            "optional" => Console::ONE_REQUIRED
        ),
        "long" => array(
            "description" => "Some long option called --long",
            "param" => "LONG",
            "optional" => Console::OPTIONAL
        ),
    )
);

$console->run();

if($console->verbosity >= Console::VERBOSITY_VERBOSE){
    // Write stuff out
}

// Or use the console's write method and let it decide
$console->write("Normal output");
$console->write("Normal output", Console::VERBOSITY_NORMAL);
$console->write("Verbose output", Console::VERBOSITY_VERBOSE);
$console->write("Info output", Console::VERBOSITY_INFO);
$console->write("Debug output", Console::VERBOSITY_DEBUG);

// You can use two methods to check options
$eValue = $console->getOpt("e");
if($eValue){
    // do stuff for e
}
// or simply use the object
if($console->long){
    // do stuff for long
}

// check there is no other PID running this script. By default, the
// command line arguments are used to build a unique PID file name.
// You can disable this by passing false. You can also, pass in a
// second parameter that is a unique id for this script that will
// be used to create the pid file name.
$status = $console->checkPid();
if($status !== Console::PID_OK){
    /**
     * We could do more here for the other statuses as well.
     * PID_OTHER_RUNNING
     * PID_OTHER_NOT_RUNNING
     * PID_OTHER_UNKNOWN
     */
    fputs(STDERR, "A PID file already exists for this script");
    exit(1);
}

// Show the status of some progress
// Includes elapsed time and estimated time to completion
use \DealNews\Console\Status;
$total = 100000;
for ($x=1; $x<=$total; $x++){
    Status::progress($x, $total);
    usleep(100);
}

// Unsure how long something will run? Just show a spinner
use \DealNews\Console\Status;
$total = rand(10000, 30000);
for ($x=1; $x<=$total; $x++) {
    Status::spinner();
    usleep(100);
}
// clear the line after the spinner is done
Status::clearLine();

use \DealNews\Console\Interact;
if (Interact::isInteractive()) {
    // do stuff on the console like show status and ask questions
}

use \DealNews\Console\Interact;
$answer = Interact::prompt("What is the secret word?", true);
if ($answer == "secret") {
    $console->write("Yay! You got it!");
} else {
    $console->write("Boo! That is wrong!");
}

use \DealNews\Console\Interact;
if (!Interact::confirm("Do you want to continue?")) {
    exit(0);
}