Webmozart\Console\Api\Args\Format\ArgsFormatBuilder::hasOptionalArgument PHP Method

hasOptionalArgument() public method

Returns whether the builder contains an optional argument.
public hasOptionalArgument ( boolean $includeBase = true ) : boolean
$includeBase boolean Whether to include arguments in the base format in the search.
return boolean Returns `true` if the builder contains an optional argument and `false` otherwise.
    public function hasOptionalArgument($includeBase = true)
    {
        Assert::boolean($includeBase, 'The parameter $includeBase must be a boolean. Got: %s');
        if ($this->hasOptionalArg) {
            return true;
        }
        if ($includeBase && $this->baseFormat) {
            return $this->baseFormat->hasOptionalArgument();
        }
        return false;
    }

Usage Example

 /**
  * @expectedException \InvalidArgumentException
  */
 public function testHasOptionalArgumentFailsIfIncludeBaseNoBoolean()
 {
     $this->builder->hasOptionalArgument(1234);
 }