\phpDocumentor\Plugin\Core\Descriptor\Validator\FunctionsAreAllArgumentsValid

validate()

validate(\phpDocumentor\Reflection\BaseReflector  $element) : \phpDocumentor\Descriptor\Validator\Error|null

Validates whether the given Reflector's arguments match the business rules of phpDocumentor.

Parameters

Throws

\UnexpectedValueException

if no DocBlock is associated with the given Reflector.

Returns

validateArguments()

validateArguments(\phpDocumentor\Reflection\FunctionReflector  $element) : \phpDocumentor\Descriptor\Validator\Error|null

Returns an error if the given Reflector's arguments do not match expectations.

Parameters

Returns

isArgumentInDocBlock()

isArgumentInDocBlock(integer  $index, \phpDocumentor\Reflection\FunctionReflector\ArgumentReflector  $argument, \phpDocumentor\Reflection\BaseReflector  $element, array<mixed,\phpDocumentor\Reflection\DocBlock\Tag>  $params) : boolean

Validates whether an argument is mentioned in the docblock.

Parameters

Returns

whether an issue occurred.

doesArgumentNameMatchParam()

doesArgumentNameMatchParam(\phpDocumentor\Reflection\DocBlock\Tag\ParamTag  $param, \phpDocumentor\Reflection\FunctionReflector\ArgumentReflector  $argument, \phpDocumentor\Reflection\BaseReflector  $element) : \phpDocumentor\Descriptor\Validator\Error|null

Validates whether the name of the argument is the same as that of the param tag.

If the param tag does not contain a name then this method will set it based on the argument.

Parameters

Returns

whether an issue occurred

doesArgumentTypehintMatchParam()

doesArgumentTypehintMatchParam(\phpDocumentor\Reflection\DocBlock\Tag\ParamTag  $param, \phpDocumentor\Reflection\FunctionReflector\ArgumentReflector  $argument, \phpDocumentor\Reflection\BaseReflector  $element) : \phpDocumentor\Descriptor\Validator\Error|null

Checks the typehint of the argument versus the @param tag.

If the argument has no typehint we do not check anything. When multiple type are given then the typehint needs to be one of them.

Parameters

Returns