Skip to content

Class Function_

Class \Klitsche\Dog\Elements\Function_

Constants

TYPE

public TYPE = 'Function'

Methods

__construct()

public __construct ( 
    \Klitsche\Dog\ProjectInterface $project, 
    \Klitsche\Dog\Elements\ElementInterface $owner, 
    \phpDocumentor\Reflection\Php\Function_ $php
 ):
Parameters
project \Klitsche\Dog\ProjectInterface
owner \Klitsche\Dog\Elements\ElementInterface
php \phpDocumentor\Reflection\Php\Function_

getArguments()

public getArguments (  ): \Klitsche\Dog\Elements\Argument[]
Returns
\Klitsche\Dog\Elements\Argument[]

getData()

public getData ( 
    string $id
 ): mixed
Parameters
id string
Returns
mixed Null if data is not set

getDocBlock()

public getDocBlock (  ): ?\phpDocumentor\Reflection\DocBlock
Returns
?\phpDocumentor\Reflection\DocBlock

getElementType()

public getElementType (  ): string
Returns
string

getFile()

public getFile (  ): \Klitsche\Dog\Elements\File
Returns
\Klitsche\Dog\Elements\File

getFqsen()

public getFqsen (  ): \phpDocumentor\Reflection\Fqsen
Returns
\phpDocumentor\Reflection\Fqsen

getId()

public getId (  ): string
Returns
string

getLocation()

public getLocation (  ): ?\phpDocumentor\Reflection\Location
Returns
?\phpDocumentor\Reflection\Location

getName()

public getName (  ): ?string
Returns
?string

getNamespace()

public getNamespace (  ): \phpDocumentor\Reflection\Fqsen
Returns
\phpDocumentor\Reflection\Fqsen

getOwner()

public getOwner (  ): ?\Klitsche\Dog\Elements\ElementInterface
Returns
?\Klitsche\Dog\Elements\ElementInterface

getPhp()

public getPhp (  ): ?\phpDocumentor\Reflection\Php\Function_
Returns
?\phpDocumentor\Reflection\Php\Function_

getProject()

public getProject (  ): \Klitsche\Dog\ProjectInterface
Returns
\Klitsche\Dog\ProjectInterface

getReturnDescription()

public getReturnDescription (  ): ?string
Returns
?string

getReturnType()

public getReturnType (  ): ?\phpDocumentor\Reflection\Type
Returns
?\phpDocumentor\Reflection\Type

hasDocBlock()

public hasDocBlock (  ): bool
Returns
bool

hasTag()

public hasTag ( 
    string $name
 ): bool
Parameters
name string
Returns
bool

isInternal()

public isInternal (  ): bool
Returns
bool

setData()

public setData ( 
    string $id, 
    mixed $value
 ): void
Parameters
id string
value mixed

setProject()

public setProject ( 
    \Klitsche\Dog\ProjectInterface $project
 ): void
Parameters
project \Klitsche\Dog\ProjectInterface

Test Coverage 💛

  • 💛 Lines: 88.89% (32 / 36)
  • 💛 Methods: 71.43% (10 / 14)