Download the PHP package webservco/command without Composer
On this page you can find all versions of the php package webservco/command. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download webservco/command
More information about webservco/command
Files in webservco/command
Package command
Short Description A PHP component/library. Helpers for command line scripts, including an option parser, output that also goes to the log, and a counter for processed items.
License MIT
Homepage https://webserv.co
Informations about the package command
webservco/command
A PHP component/library. Please see webservco/sandbox for an example project using these types of components.
Helpers for command line scripts, including an option parser, output that also goes to the log, and a counter for processed items.
- Related:
webservco/application-default(runs a command with error handling and timing),webservco/dependency-container(provides output services per log channel)
Installation
Usage
A command implements CommandRunnerInterface.
An example command from the webservco/sandbox project:
Create the output service from a PSR-3 logger:
Contracts
| Interface | Implementation | Purpose |
|---|---|---|
Contract\CommandRunnerInterface |
your command | run() does the work. |
Contract\CommandFactoryInterface |
your factory | Creates the command with its dependencies. |
Contract\OptionsParserInterface |
Service\OptionsParser |
Typed access to long command line options. |
Contract\OutputInterface |
Service\OutputWithLogService |
echo() prints, write() prints a line and logs it. |
Contract\OutputFactoryInterface |
Factory\OutputServiceFactory |
Creates the output service for a logger. |
Contract\ItemsProcessingReportInterface |
Service\ItemsProcessingReportService |
Counts total and processed items. |
Contract\ItemsProcessingReportConsumerInterface |
Service\AbstractItemsProcessingReportConsumer |
Base for services that report on what they processed. |
Namespaces are relative to WebServCo\Command\.
Notes
OptionsParser reads the real command line with getopt() as soon as it is created, and only knows long options (--name). Use name: for options that need a value and name for flags.
getBoolValue() returns true when the flag is present. getStringValue() throws an OutOfBoundsException when the option is missing, and getNullableStringValue() returns null instead.
Development
License
MIT