alfhen/php-shell

Package with tools for creating php shell scripts

v0.1.4 2016-01-03 22:30 UTC

This package is auto-updated.

Last update: 2024-10-12 22:30:53 UTC


README

Tools for creating php shell scripts

Installation

composer require alfhen/php-shell

Usage

CliArgsParser:

When creating a php shell script you can use the CliArgsParser to parse arguments passed to your shell scripts. The parser expects arguments to be passed in following format --argument='' note you should not write <> but just the raw value inside the quotes. Each argument should be separated with a space.

  // an array of the required argument keys, is not required
  $requiredAguments = ['argument_one', 'argument_two'];

  // get arguments as an associative array
  $parsedArguments = Alfhen\PhpShell\CliArgsParser::getArguments($requiredAguments);

CliLogger:

CliLogger is a tool that helps you print nicely formated lines to the terminal/console. It comes with three built in types: Info, Error and Success. It can be used as such:

Alfhen\PhpShell\CliLogger::info('This is an info message');

Alfhen\PhpShell\CliLogger::error('This is an error message');

Alfhen\PhpShell\CliLogger::success('This is a success message');

Happy coding and thanks for using the tools