phpdoctypes

Documentation

Index

• type Param
• type ParamsMap
• type ParseResult
  • func Parse(doc phpdoc.Comment, actualParams []ir.Node, normalizer types.Normalizer) (result ParseResult)
• type RealPHPDocTypes
  • func ToRealType(classFQNProvider func(string) (string, bool), kphp bool, typ phpdoc.Type) *RealPHPDocTypes
• type TypeConverter

Types

type Param

type Param struct {
	Optional bool
	Typ      types.Map
}

type ParamsMap

type ParamsMap map[string]Param

type ParseResult

type ParseResult struct {
	ReturnType  types.Map
	ParamTypes  ParamsMap
	Deprecation meta.DeprecationInfo
	Inherit     bool
	Internal    bool

	Shapes   types.ShapesMap
	Closures types.ClosureMap
}

func Parse

func Parse(doc phpdoc.Comment, actualParams []ir.Node, normalizer types.Normalizer) (result ParseResult)

type RealPHPDocTypes

type RealPHPDocTypes struct {
	Types    []types.Type
	Shapes   types.ShapesMap
	Closures types.ClosureMap
	Warning  string
}

func ToRealType

func ToRealType(classFQNProvider func(string) (string, bool), kphp bool, typ phpdoc.Type) *RealPHPDocTypes

ToRealType extracts types out of the PHPDoc type string.

No normalization is performed, but some PHPDoc-specific types are simplified to be compatible with our type system.

type TypeConverter

type TypeConverter struct {
	// contains filtered or unexported fields
}