Download the PHP package khalyomede/command-builder without Composer
On this page you can find all versions of the php package khalyomede/command-builder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download khalyomede/command-builder
More information about khalyomede/command-builder
Files in khalyomede/command-builder
Package command-builder
Short Description Create executable strings using a fluent API.
License MIT
Informations about the package command-builder
command-builder
A PHP class to build executable with using fluent API.
Summary
- About
- Features
- Installation
- Examples
- Compatibility table
- Tests
About
I need to have a fluent way to call my executable. I did not found any other command builder providing such interface that was updated recently or provide a large test coverage.
Features
- Use a fluent API to construct the string to be executed
- Class-based
- Support arguments, long/short options and flags
- Preserves order of elements
- Does not handle executing the command
Installation
Install the package using Composer:
Examples
- 1. Create a simple command
- 2. Add an argument
- 3. Add a flag
- 4. Add an option
- 5. Configure the standard
- 6. Get the number of arguments
- 7. Get the number of flags
- 8. Get the number of options
- 9. Check if a flag has been added
- 10. Check if an option has been added
1. Create a simple command
In this example, we will just pass a command name, without arguments/options/flags.
2. Add an argument
In this example, we will add an argument to our command.
3. Add a flag
In this example, we will add a "long" flag to the command.
And this is how to add a "short" flag.
4. Add an option
You can add options to your command.
If your option contains spaces, it will automatically be escaped using double quotes.
And if your option contains spaces and doubles quotes, they will also be escaped.
You can also use "short" option.
5. Configure the standard
You can specify the standard used for the option. By default, it is set to "GNU".
You can also use constants if you prefer
6. Get the number of arguments
You can know how many arguments were added to the command.
7. Get the number of flags
You can know the number of flags added to your command.
8. Get the number of options
You can know the number of options added to your command.
9. Check if a flag has been added
You can know if a flag has been added already.
10. Check if an option has been added
You can know if an option has been added or not.
Compatibility table
This is the compatibility for this version only. To check the compatibility with other version of this package, please browse the version of your choice.
PHP Version | Compatibility |
---|---|
8.1.* | ✔️ |
8.0.* | ✔️ |
7.4.* | ✔️ |