Documentation

PhpDocParser
in package

Tags
phpstan-import-type

ValueType from Doctrine\DoctrineArgument as DoctrineValueType

Table of Contents

DISALLOWED_DESCRIPTION_START_TOKENS  = [PHPStanPhpDocParserLexerLexer::TOKEN_UNION, PHPStanPhpDocParserLexerLexer::TOKEN_INTERSECTION]
$constantExprParser  : ConstExprParser
$doctrineConstantExprParser  : ConstExprParser
$parseDoctrineAnnotations  : bool
$preserveTypeAliasesWithInvalidTypes  : bool
$requireWhitespaceBeforeDescription  : bool
$textBetweenTagsBelongsToDescription  : bool
$typeParser  : TypeParser
$useIndexAttributes  : bool
$useLinesAttributes  : bool
__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
parseRequiredVariableName()  : string
parseRequireExtendsTagValue()  : RequireExtendsTagValueNode
parseRequireImplementsTagValue()  : RequireImplementsTagValueNode
parseReturnTagValue()  : ReturnTagValueNode
parseSelfOutTagValue()  : SelfOutTagValueNode
parseText()  : PhpDocTextNode
parseThrowsTagValue()  : ThrowsTagValueNode
parseTypeAliasImportTagValue()  : TypeAliasImportTagValueNode
parseTypeAliasTagValue()  : TypeAliasTagValueNode
parseVarTagValue()  : VarTagValueNode

Constants

DISALLOWED_DESCRIPTION_START_TOKENS

private mixed DISALLOWED_DESCRIPTION_START_TOKENS = [PHPStanPhpDocParserLexerLexer::TOKEN_UNION, PHPStanPhpDocParserLexerLexer::TOKEN_INTERSECTION]

Properties

$parseDoctrineAnnotations

private bool $parseDoctrineAnnotations

$preserveTypeAliasesWithInvalidTypes

private bool $preserveTypeAliasesWithInvalidTypes

$requireWhitespaceBeforeDescription

private bool $requireWhitespaceBeforeDescription

$textBetweenTagsBelongsToDescription

private bool $textBetweenTagsBelongsToDescription

Methods

__construct()

public __construct(TypeParser $typeParser, ConstExprParser $constantExprParser[, bool $requireWhitespaceBeforeDescription = false ][, bool $preserveTypeAliasesWithInvalidTypes = false ][, array{lines?: bool, indexes?: bool} $usedAttributes = [] ][, bool $parseDoctrineAnnotations = false ][, bool $textBetweenTagsBelongsToDescription = false ]) : mixed
Parameters
$typeParser : TypeParser
$constantExprParser : ConstExprParser
$requireWhitespaceBeforeDescription : bool = false
$preserveTypeAliasesWithInvalidTypes : bool = false
$usedAttributes : array{lines?: bool, indexes?: bool} = []
$parseDoctrineAnnotations : bool = false
$textBetweenTagsBelongsToDescription : bool = false
Return values
mixed —

enrichWithAttributes()

private enrichWithAttributes(TokenIterator $tokens, T $tag, int $startLine, int $startIndex) : T
Parameters
$tokens : TokenIterator
$tag : T
$startLine : int
$startIndex : int
Tags
template

T of Ast\Node

Return values
T —

parseAssertParameter()

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} —

parseOptionalDescription()

private parseOptionalDescription(TokenIterator $tokens[, bool $limitStartToken = false ]) : string
Parameters
$tokens : TokenIterator
$limitStartToken : bool = false
Return values
string —

Search results