No Exception when defining type on flag

[pixlmint]

This just took me forever to debug and I had to dig way too deep into the Code to figure out what the issue was.

I had this Code:

$webRequestSpecs->add('p|path', 'Path to request')
    ->isa('string');

And I kept getting this error: Invalid value for -p, --path. Requires a type String. even though I was passing the string it was looking for. What I managed to figure out after ~2 hours of debugging, was that my argument was being registered as a flag instead of a regular Argument, the thing that was missing was a colon (:) in the spec string.

However, because I added the ->isa('string'), it was still doing the type checking - but because it's a flag, there isn't any value to check for.

In my opinion, my ->isa('string') should have thrown an exception, since flags per definition cannot have types.

[peter279k]

Hi @pixlmint, could you provide some details about this issue?

Please provide the GetOptionKit version you use and the whole problematic codes.

And it can be very helpful for us to reproduce this. Thanks :).

[pixlmint]

Sure, here's the php file:

<?php

include "/var/www/html/vendor/autoload.php";

use GetOptionKit\OptionCollection;
use GetOptionKit\OptionPrinter\ConsoleOptionPrinter;
use GetOptionKit\ContinuousOptionParser;
use PixlMint\CMS\CmsCore;

$appSpecs = new OptionCollection;

$webRequestSpecs = new OptionCollection;
$webRequestSpecs->add('p|path', 'Path to request')
    ->isa('string');

$subcommandSpecs = [
    'web:request' => $webRequestSpecs,
];

$printer = new ConsoleOptionPrinter();
echo $printer->render($appSpecs);

echo "web:request\n";
echo $printer->render($webRequestSpecs);

$parser = new ContinuousOptionParser($appSpecs);

$appOptions = $parser->parse(explode(' ', 'command web:request --path testpath'));

$subcommandOptions = [];
$arguments = [];

while (!$parser->isEnd()) {
    $subcommand = $parser->getCurrentArgument();
    printf("Now parsing '%s'\n", $subcommand);
    if (key_exists($subcommand, $subcommandSpecs)) {
        $parser->advance();
        $parser->setSpecs($subcommandSpecs[$subcommand]);
        $subcommandOptions[$subcommand] = $parser->continueParse();
    } else {
        $arguments[] = $parser->advance();
    }
}

print("Arguments:\n");
print_r($arguments);

print("subcommand options:\n");
print_r($subcommandOptions);

And here's the output I get:

web:request
        -p, --path=<string>
                Path to request
Now parsing 'web:request'

Fatal error: Uncaught GetOptionKit\Exception\InvalidOptionValueException: Invalid value for -p, --path. Requires a type String. in /var/www/html/vendor/corneltek/getoptionkit/src/Option.php:272
Stack trace:
#0 /var/www/html/vendor/corneltek/getoptionkit/src/Option.php(309): GetOptionKit\Option->_preprocessValue(true)
#1 /var/www/html/vendor/corneltek/getoptionkit/src/OptionParser.php(48): GetOptionKit\Option->setValue(true)
#2 /var/www/html/vendor/corneltek/getoptionkit/src/ContinuousOptionParser.php(193): GetOptionKit\OptionParser->consumeOptionToken(Object(GetOptionKit\Option), Object(GetOptionKit\Argument), Object(GetOptionKit\Argument))
#3 /var/www/html/vendor/corneltek/getoptionkit/src/ContinuousOptionParser.php(136): GetOptionKit\ContinuousOptionParser->parse(Array)
#4 /var/www/html/pixl-cms/src/console.php(41): GetOptionKit\ContinuousOptionParser->continueParse()
#5 {main}
  thrown in /var/www/html/vendor/corneltek/getoptionkit/src/Option.php on line 272