Documentation

FuncInfo
in package

Table of Contents

$alias  : FunctionName|null
$aliasType  : string|null
$args  : array<string|int, ArgInfo>
$classFlags  : int
$cond  : string|null
$flags  : int
$isDeprecated  : bool
$name  : FunctionOrMethodName
$numRequiredArgs  : int
$return  : ReturnInfo
$verify  : bool
__construct()  : mixed
discardInfoForOldPhpVersions()  : void
equalsApartFromName()  : bool
getArgInfoName()  : string
getDeclaration()  : string|null
getDeclarationKey()  : string
getFunctionEntry()  : string
getMethodSynopsisDocument()  : string|null
getMethodSynopsisElement()  : DOMElement|null
getModifierNames()  : array<string|int, string>
hasParamWithUnknownDefaultValue()  : bool
isFinalMethod()  : bool
isInstanceMethod()  : bool
isMethod()  : bool
appendMethodSynopsisTypeToElement()  : mixed
getFlagsAsArginfoString()  : string

Properties

$aliasType

public string|null $aliasType

$isDeprecated

public bool $isDeprecated

$numRequiredArgs

public int $numRequiredArgs

Methods

__construct()

public __construct(FunctionOrMethodName $name, int $classFlags, int $flags, string|null $aliasType, FunctionOrMethodName|null $alias, bool $isDeprecated, bool $verify, array<string|int, mixed> $args, ReturnInfo $return, int $numRequiredArgs, string|null $cond) : mixed
Parameters
$name : FunctionOrMethodName
$classFlags : int
$flags : int
$aliasType : string|null
$alias : FunctionOrMethodName|null
$isDeprecated : bool
$verify : bool
$args : array<string|int, mixed>
$return : ReturnInfo
$numRequiredArgs : int
$cond : string|null
Return values
mixed —

discardInfoForOldPhpVersions()

public discardInfoForOldPhpVersions() : void
Return values
void —

equalsApartFromName()

public equalsApartFromName(FuncInfo $other) : bool
Parameters
$other : FuncInfo
Return values
bool —

getArgInfoName()

public getArgInfoName() : string
Return values
string —

getDeclaration()

public getDeclaration() : string|null
Return values
string|null —

getDeclarationKey()

public getDeclarationKey() : string
Return values
string —

getFunctionEntry()

public getFunctionEntry() : string
Return values
string —

getMethodSynopsisDocument()

public getMethodSynopsisDocument(array<string|int, FuncInfo> $funcMap, array<string|int, FuncInfo> $aliasMap) : string|null
Parameters
$funcMap : array<string|int, FuncInfo>
$aliasMap : array<string|int, FuncInfo>
Tags
throws
Exception
Return values
string|null —

getMethodSynopsisElement()

public getMethodSynopsisElement(array<string|int, FuncInfo> $funcMap, array<string|int, FuncInfo> $aliasMap, DOMDocument $doc) : DOMElement|null
Parameters
$funcMap : array<string|int, FuncInfo>
$aliasMap : array<string|int, FuncInfo>
$doc : DOMDocument
Tags
throws
Exception
Return values
DOMElement|null —

getModifierNames()

public getModifierNames() : array<string|int, string>
Return values
array<string|int, string> —

hasParamWithUnknownDefaultValue()

public hasParamWithUnknownDefaultValue() : bool
Return values
bool —

isFinalMethod()

public isFinalMethod() : bool
Return values
bool —

isInstanceMethod()

public isInstanceMethod() : bool
Return values
bool —

isMethod()

public isMethod() : bool
Return values
bool —

appendMethodSynopsisTypeToElement()

private appendMethodSynopsisTypeToElement(DOMDocument $doc, DOMElement $elementToAppend, Type $type) : mixed
Parameters
$doc : DOMDocument
$elementToAppend : DOMElement
$type : Type
Return values
mixed —

getFlagsAsArginfoString()

private getFlagsAsArginfoString() : string
Return values
string —

Search results