arefshojaei/php-x

PHP Console application

1.6.0 2025-04-02 18:18 UTC

Requires

• php: ^8.0

Requires (Dev)

• phpunit/phpunit: ^10

MIT

• ArefShojaei

• php
• cli
• console
• command
• cmd

README

<?php

use PhpX\Components\Console\App;

$app = new App;

$app->command("welcome", function() {
    return "Welcome command!";
});

$app->launch();

Installation

Using Composer

composer create-project arefshojaei/php-x

Using GIT

git clone https://github.com/ArefShojaei/PhpX

Add Provider that run before exact command

# First method
$app->use(function() { ... });

# Second method
use PhpX\Components\Console\Provider;

class ExampleProvider extends Provider {
    public function handle() { ... }
}

$app->use(new ExampleProvider);

Add Command

# First method
$app->command("help", function() { ... });

# Second method
use PhpX\Components\Console\Command;

class ExampleCommand extends Command {
    public function exec() { ... }
}

$app->command("help", new ExampleCommand);

Get command params

• [COMMAND] "users { id }"
• [COMMAND] "help --{ command }"
• [COMMAND] "link { url } { format }"

$app->command("users {id}", function($id) { ... });

$app->command("help {command}", function($command) { ... });

$app->command("link {url} {format}", function($url, $format) { ... });

Console Utility to show message with color

use PhpX\Utils\Console\Console;

echo Console::log("My message") . PHP_EOL; # [LOG] My message
echo Console::info("My message") . PHP_EOL; # [INFO] My message
echo Console::success("My message") . PHP_EOL; # [SUCCESS] My message
echo Console::warn("My message") . PHP_EOL; # [WARN] My message
echo Console::error("My message") . PHP_EOL; # [ERROR] My message

View Utility to show table content

use PhpX\Utils\View\ViewBuilder;

$app->command("welcome", function() {
    return (new ViewBuilder)
        ->addHeader()
        ->addCell(title: "Cell")
        ->addSeparator()
        ->addFooter()
        ->build();
});