A basic Options parser and command-line arguments handling a library for PHP.
The library can be installed using ncc:
# n64
ncc package install -p "nosial/libs.opts=latest@n64"
# github
ncc package install -p "nosial/libs.opts=latest@github"or by adding the following to your project.json file under
the build.dependencies section:
{
"name": "net.nosial.optslib",
"version": "latest",
"source_type": "remote",
"source": "nosial/libs.opts=latest@n64"
}If you don't have the n64 source configured you can add it by running the following command:
ncc repository add --name n64 --type gitlab --host git.n64.ccThe library can be compiled from source using ncc:
ncc build --config releaseor by running the following command:
make releaseThe library can be tested using PhpUnit with the phpunit.xml file that is already included in the repository.
This requires that you have PhpUnit installed & the library has been compiled and installed on the local system.
phpunitThe usage of this library is very simple, there are two functions that you can use to parse options.
Can be used to parse a single argument string/array, this is useful for parsing command line arguments. The second argument is the maximum number of arguments that can be parsed, this is to prevent infinite loops.
<?php
require_once('ncc');
import('net.nosial.optslib', 'latest');
$input = '--foo --bar="test" -y --username test';
$parsed = \OptsLib\Parse::parseArgument($input);
echo $parsed['foo']; // true
echo $parsed['bar']; // "test"
echo $parsed['y']; // true
echo $parsed['username']; // "test"This method is used to access the $argv array
if it's not set, an empty array is returned.
<?php
require_once('ncc');
import('net.nosial.optslib', 'latest');
$arguments = \OptsLib\Parse::getArguments();
echo $arguments['output-file']; // "test.txt"
echo $arguments['input-file']; // "test.txt"
echo $arguments['log']; // "verbose"Optionally, if you want arguments after a specific argument/option to be parsed, you can pass the argument name as the first argument.
This is ideal if you are using a command line tool that has a sub-command, for example:
$ mytool subcommand --foo --bar="test" -y --username testIn this case, you can pass the subcommand argument to the
getArguments() method to parse the arguments after it.
<?php
require_once('ncc');
import('net.nosial.optslib', 'latest');
$arguments = \OptsLib\Parse::getArguments('subcommand');
echo $arguments['foo']; // true
echo $arguments['bar']; // "test"
echo $arguments['y']; // true
echo $arguments['username']; // "test"OptsLib also provides some additional functionality that can be used to modify the way arguments are parsed.
This method is used to return the regex pattern used to parse the arguments, it can be used to parse arguments manually.
The default used is
/(?(?=-)-(?(?=-)-(?'bigflag'[^\\s=]+)|(?'smallflag'\\S))(?:\\s*=\\s*|\\s+)(?(?!-)(?(?=[\\\"\\'])((?<![\\\\])['\"])(?'string'(?:.(?!(?<![\\\\])\\3))*.?)\\3|(?'value'\\S+)))(?:\\s+)?|(?'unmatched'\\S+))/This method is used to set the regex pattern used to parse the arguments, you can modify the default pattern to suit your needs.
<?php
require_once('ncc');
import('net.nosial.optslib', 'latest');
\OptsLib\Parse::setRegex('/(?(?=-)-(?(?=-)-(?'bigflag'[^\\s=]+)|(?'smallflag'\\S))(?:\\s*=\\s*|\\s+)(?(?!-)(?(?=[\\\"\\'])((?<![\\\\])['\"])(?'string'(?:.(?!(?<![\\\\])\\3))*.?)\\3|(?'value'\\S+)))(?:\\s+)?|(?'unmatched'\\S+))/');
For a list of changes, see the CHANGELOG.md file.
This library is licensed under the MIT license, see the LICENSE file for more information.
The logo was created by Boxicons and is licensed under the MIT license
If you want to contribute to this project, you can do so by creating a merge request on the GitLab repository.