PhpDocParser
in package
Tags
Table of Contents
Constants
- DISALLOWED_DESCRIPTION_START_TOKENS = [\PHPStan\PhpDocParser\Lexer\Lexer::TOKEN_UNION, \PHPStan\PhpDocParser\Lexer\Lexer::TOKEN_INTERSECTION]
Properties
- $config : ParserConfig
- $constantExprParser : ConstExprParser
- $doctrineConstantExprParser : ConstExprParser
- $typeParser : TypeParser
Methods
- __construct() : mixed
- parse() : PhpDocNode
- parseTag() : PhpDocTagNode
- parseTagValue() : PhpDocTagValueNode
- enrichWithAttributes() : T
- parseAssertParameter() : array{parameter: string}|array{parameter: string, property: string}|array{parameter: string, method: string}
- parseAssertTagValue() : AssertTagValueNode|AssertTagPropertyValueNode|AssertTagMethodValueNode
- parseChild() : PhpDocChildNode
- parseDeprecatedTagValue() : DeprecatedTagValueNode
- parseDoctrineArgument() : DoctrineArgument
- parseDoctrineArguments() : array<int, DoctrineArgument>
- parseDoctrineArgumentValue() : DoctrineValueType
- parseDoctrineArrayItem() : DoctrineArrayItem
- parseDoctrineArrayKey() : ConstExprIntegerNode|ConstExprStringNode|IdentifierTypeNode|ConstFetchNode
- parseDoctrineTagValue() : PhpDocTagValueNode
- parseExtendsTagValue() : PhpDocTagValueNode
- parseMethodTagValue() : MethodTagValueNode
- parseMethodTagValueParameter() : MethodTagValueParameterNode
- parseMixinTagValue() : MixinTagValueNode
- parseOptionalDescription() : string
- parseOptionalDescriptionAfterDoctrineTag() : string
- parseOptionalVariableName() : string
- parseParamClosureThisTagValue() : ParamClosureThisTagValueNode
- parseParamImmediatelyInvokedCallableTagValue() : ParamImmediatelyInvokedCallableTagValueNode
- parseParamLaterInvokedCallableTagValue() : ParamLaterInvokedCallableTagValueNode
- parseParamOutTagValue() : ParamOutTagValueNode
- parseParamTagValue() : ParamTagValueNode|TypelessParamTagValueNode
- parsePropertyTagValue() : PropertyTagValueNode
- parsePureUnlessCallableIsImpureTagValue() : PureUnlessCallableIsImpureTagValueNode
- parseRequiredVariableName() : string
- parseRequireExtendsTagValue() : RequireExtendsTagValueNode
- parseRequireImplementsTagValue() : RequireImplementsTagValueNode
- parseReturnTagValue() : ReturnTagValueNode
- parseSealedTagValue() : SealedTagValueNode
- parseSelfOutTagValue() : SelfOutTagValueNode
- parseText() : PhpDocTextNode
- parseThrowsTagValue() : ThrowsTagValueNode
- parseTypeAliasImportTagValue() : TypeAliasImportTagValueNode
- parseTypeAliasTagValue() : TypeAliasTagValueNode
- parseVarTagValue() : VarTagValueNode
Constants
DISALLOWED_DESCRIPTION_START_TOKENS
private
mixed
DISALLOWED_DESCRIPTION_START_TOKENS
= [\PHPStan\PhpDocParser\Lexer\Lexer::TOKEN_UNION, \PHPStan\PhpDocParser\Lexer\Lexer::TOKEN_INTERSECTION]
Properties
$config
private
ParserConfig
$config
$constantExprParser
private
ConstExprParser
$constantExprParser
$doctrineConstantExprParser
private
ConstExprParser
$doctrineConstantExprParser
$typeParser
private
TypeParser
$typeParser
Methods
__construct()
public
__construct(ParserConfig $config, TypeParser $typeParser, ConstExprParser $constantExprParser) : mixed
Parameters
- $config : ParserConfig
- $typeParser : TypeParser
- $constantExprParser : ConstExprParser
parse()
public
parse(TokenIterator $tokens) : PhpDocNode
Parameters
- $tokens : TokenIterator
Return values
PhpDocNodeparseTag()
public
parseTag(TokenIterator $tokens) : PhpDocTagNode
Parameters
- $tokens : TokenIterator
Return values
PhpDocTagNodeparseTagValue()
public
parseTagValue(TokenIterator $tokens, string $tag) : PhpDocTagValueNode
Parameters
- $tokens : TokenIterator
- $tag : string
Return values
PhpDocTagValueNodeenrichWithAttributes()
private
enrichWithAttributes(TokenIterator $tokens, T $tag, int $startLine, int $startIndex) : T
Parameters
- $tokens : TokenIterator
- $tag : T
- $startLine : int
- $startIndex : int
Tags
Return values
TparseAssertParameter()
private
parseAssertParameter(TokenIterator $tokens) : array{parameter: string}|array{parameter: string, property: string}|array{parameter: string, method: string}
Parameters
- $tokens : TokenIterator
Return values
array{parameter: string}|array{parameter: string, property: string}|array{parameter: string, method: string}parseAssertTagValue()
private
parseAssertTagValue(TokenIterator $tokens) : AssertTagValueNode|AssertTagPropertyValueNode|AssertTagMethodValueNode
Parameters
- $tokens : TokenIterator
Return values
AssertTagValueNode|AssertTagPropertyValueNode|AssertTagMethodValueNodeparseChild()
private
parseChild(TokenIterator $tokens) : PhpDocChildNode
Parameters
- $tokens : TokenIterator
Tags
Return values
PhpDocChildNodeparseDeprecatedTagValue()
private
parseDeprecatedTagValue(TokenIterator $tokens) : DeprecatedTagValueNode
Parameters
- $tokens : TokenIterator
Return values
DeprecatedTagValueNodeparseDoctrineArgument()
private
parseDoctrineArgument(TokenIterator $tokens) : DoctrineArgument
Parameters
- $tokens : TokenIterator
Return values
DoctrineArgumentparseDoctrineArguments()
private
parseDoctrineArguments(TokenIterator $tokens, bool $deep) : array<int, DoctrineArgument>
Parameters
- $tokens : TokenIterator
- $deep : bool
Return values
array<int, DoctrineArgument>parseDoctrineArgumentValue()
private
parseDoctrineArgumentValue(TokenIterator $tokens) : DoctrineValueType
Parameters
- $tokens : TokenIterator
Return values
DoctrineValueTypeparseDoctrineArrayItem()
private
parseDoctrineArrayItem(TokenIterator $tokens) : DoctrineArrayItem
Parameters
- $tokens : TokenIterator
Return values
DoctrineArrayItemparseDoctrineArrayKey()
private
parseDoctrineArrayKey(TokenIterator $tokens) : ConstExprIntegerNode|ConstExprStringNode|IdentifierTypeNode|ConstFetchNode
Parameters
- $tokens : TokenIterator
Return values
ConstExprIntegerNode|ConstExprStringNode|IdentifierTypeNode|ConstFetchNodeparseDoctrineTagValue()
private
parseDoctrineTagValue(TokenIterator $tokens, string $tag) : PhpDocTagValueNode
Parameters
- $tokens : TokenIterator
- $tag : string
Return values
PhpDocTagValueNodeparseExtendsTagValue()
private
parseExtendsTagValue(string $tagName, TokenIterator $tokens) : PhpDocTagValueNode
Parameters
- $tagName : string
- $tokens : TokenIterator
Return values
PhpDocTagValueNodeparseMethodTagValue()
private
parseMethodTagValue(TokenIterator $tokens) : MethodTagValueNode
Parameters
- $tokens : TokenIterator
Return values
MethodTagValueNodeparseMethodTagValueParameter()
private
parseMethodTagValueParameter(TokenIterator $tokens) : MethodTagValueParameterNode
Parameters
- $tokens : TokenIterator
Return values
MethodTagValueParameterNodeparseMixinTagValue()
private
parseMixinTagValue(TokenIterator $tokens) : MixinTagValueNode
Parameters
- $tokens : TokenIterator
Return values
MixinTagValueNodeparseOptionalDescription()
private
parseOptionalDescription(TokenIterator $tokens, bool $limitStartToken) : string
Parameters
- $tokens : TokenIterator
- $limitStartToken : bool
-
true should be used when the description immediately follows a parsed type
Return values
stringparseOptionalDescriptionAfterDoctrineTag()
private
parseOptionalDescriptionAfterDoctrineTag(TokenIterator $tokens) : string
Parameters
- $tokens : TokenIterator
Return values
stringparseOptionalVariableName()
private
parseOptionalVariableName(TokenIterator $tokens) : string
Parameters
- $tokens : TokenIterator
Return values
stringparseParamClosureThisTagValue()
private
parseParamClosureThisTagValue(TokenIterator $tokens) : ParamClosureThisTagValueNode
Parameters
- $tokens : TokenIterator
Return values
ParamClosureThisTagValueNodeparseParamImmediatelyInvokedCallableTagValue()
private
parseParamImmediatelyInvokedCallableTagValue(TokenIterator $tokens) : ParamImmediatelyInvokedCallableTagValueNode
Parameters
- $tokens : TokenIterator
Return values
ParamImmediatelyInvokedCallableTagValueNodeparseParamLaterInvokedCallableTagValue()
private
parseParamLaterInvokedCallableTagValue(TokenIterator $tokens) : ParamLaterInvokedCallableTagValueNode
Parameters
- $tokens : TokenIterator
Return values
ParamLaterInvokedCallableTagValueNodeparseParamOutTagValue()
private
parseParamOutTagValue(TokenIterator $tokens) : ParamOutTagValueNode
Parameters
- $tokens : TokenIterator
Return values
ParamOutTagValueNodeparseParamTagValue()
private
parseParamTagValue(TokenIterator $tokens) : ParamTagValueNode|TypelessParamTagValueNode
Parameters
- $tokens : TokenIterator
Return values
ParamTagValueNode|TypelessParamTagValueNodeparsePropertyTagValue()
private
parsePropertyTagValue(TokenIterator $tokens) : PropertyTagValueNode
Parameters
- $tokens : TokenIterator
Return values
PropertyTagValueNodeparsePureUnlessCallableIsImpureTagValue()
private
parsePureUnlessCallableIsImpureTagValue(TokenIterator $tokens) : PureUnlessCallableIsImpureTagValueNode
Parameters
- $tokens : TokenIterator
Return values
PureUnlessCallableIsImpureTagValueNodeparseRequiredVariableName()
private
parseRequiredVariableName(TokenIterator $tokens) : string
Parameters
- $tokens : TokenIterator
Return values
stringparseRequireExtendsTagValue()
private
parseRequireExtendsTagValue(TokenIterator $tokens) : RequireExtendsTagValueNode
Parameters
- $tokens : TokenIterator
Return values
RequireExtendsTagValueNodeparseRequireImplementsTagValue()
private
parseRequireImplementsTagValue(TokenIterator $tokens) : RequireImplementsTagValueNode
Parameters
- $tokens : TokenIterator
Return values
RequireImplementsTagValueNodeparseReturnTagValue()
private
parseReturnTagValue(TokenIterator $tokens) : ReturnTagValueNode
Parameters
- $tokens : TokenIterator
Return values
ReturnTagValueNodeparseSealedTagValue()
private
parseSealedTagValue(TokenIterator $tokens) : SealedTagValueNode
Parameters
- $tokens : TokenIterator
Return values
SealedTagValueNodeparseSelfOutTagValue()
private
parseSelfOutTagValue(TokenIterator $tokens) : SelfOutTagValueNode
Parameters
- $tokens : TokenIterator
Return values
SelfOutTagValueNodeparseText()
private
parseText(TokenIterator $tokens) : PhpDocTextNode
Parameters
- $tokens : TokenIterator
Return values
PhpDocTextNodeparseThrowsTagValue()
private
parseThrowsTagValue(TokenIterator $tokens) : ThrowsTagValueNode
Parameters
- $tokens : TokenIterator
Return values
ThrowsTagValueNodeparseTypeAliasImportTagValue()
private
parseTypeAliasImportTagValue(TokenIterator $tokens) : TypeAliasImportTagValueNode
Parameters
- $tokens : TokenIterator
Return values
TypeAliasImportTagValueNodeparseTypeAliasTagValue()
private
parseTypeAliasTagValue(TokenIterator $tokens) : TypeAliasTagValueNode
Parameters
- $tokens : TokenIterator
Return values
TypeAliasTagValueNodeparseVarTagValue()
private
parseVarTagValue(TokenIterator $tokens) : VarTagValueNode
Parameters
- $tokens : TokenIterator