Class Method¶

Class \Klitsche\Dog\Elements\Method

implements \Klitsche\Dog\Elements\ElementInterface
implements \Klitsche\Dog\Elements\FqsenAwareInterface
implements \Klitsche\Dog\Elements\DocBlockAwareInterface
implements \Klitsche\Dog\Elements\VisibilityAwareInterface
implements \Klitsche\Dog\Elements\ProjectAwareInterface
implements \Klitsche\Dog\Elements\ArgumentsAwareInterface
implements \Klitsche\Dog\Enrichers\DataAwareInterface
uses \Klitsche\Dog\Elements\DocBlockTrait
uses \Klitsche\Dog\Elements\VisibilityTrait
uses \Klitsche\Dog\Elements\ProjectTrait
uses \Klitsche\Dog\Elements\FqsenTrait
uses \Klitsche\Dog\Enrichers\DataTrait

Constants¶

TYPE¶

public TYPE = 'Method'

Methods¶

__construct()¶

public __construct ( 
    \Klitsche\Dog\ProjectInterface $project, 
    \Klitsche\Dog\Elements\ElementInterface $owner, 
    ?\phpDocumentor\Reflection\Php\Method $php, 
    ?\phpDocumentor\Reflection\DocBlock\Tags\Method $tag
 ):

Parameters: project \Klitsche\Dog\ProjectInterface; owner \Klitsche\Dog\Elements\ElementInterface; php ?\phpDocumentor\Reflection\Php\Method; tag ?\phpDocumentor\Reflection\DocBlock\Tags\Method

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\Method

Returns: ?\phpDocumentor\Reflection\Php\Method

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

getTag()¶

public getTag (  ): ?\phpDocumentor\Reflection\DocBlock\Tags\Method

Returns: ?\phpDocumentor\Reflection\DocBlock\Tags\Method

getVisibility()¶

public getVisibility (  ): ?\phpDocumentor\Reflection\Php\Visibility

Returns: ?\phpDocumentor\Reflection\Php\Visibility

hasDocBlock()¶

public hasDocBlock (  ): bool

Returns: bool

hasTag()¶

public hasTag ( 
    string $name
 ): bool

Parameters: name string
Returns: bool

isAbstract()¶

public isAbstract (  ): bool

Returns: bool

isFinal()¶

public isFinal (  ): bool

Returns: bool

isInternal()¶

public isInternal (  ): bool

Returns: bool

isPrivate()¶

public isPrivate (  ): bool

Returns: bool

isProtected()¶

public isProtected (  ): bool

Returns: bool

isPublic()¶

public isPublic (  ): bool

Returns: bool

isStatic()¶

public isStatic (  ): 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: 82.61% (76 / 92)
❤️ Methods: 42.11% (8 / 19)