Class Interface_¶
Class \Klitsche\Dog\Elements\Interface_
- implements \Klitsche\Dog\Elements\ElementInterface
- implements \Klitsche\Dog\Elements\FqsenAwareInterface
- implements \Klitsche\Dog\Elements\DocBlockAwareInterface
- implements \Klitsche\Dog\Elements\ProjectAwareInterface
- implements \Klitsche\Dog\Enrichers\DataAwareInterface
- uses \Klitsche\Dog\Elements\DocBlockTrait
- uses \Klitsche\Dog\Elements\ProjectTrait
- uses \Klitsche\Dog\Elements\FqsenTrait
- uses \Klitsche\Dog\Enrichers\DataTrait
Constants¶
TYPE¶
public TYPE = 'Interface'
Methods¶
__construct()¶
public __construct (
\Klitsche\Dog\ProjectInterface $project,
\Klitsche\Dog\Elements\ElementInterface $owner,
\phpDocumentor\Reflection\Php\Interface_ $php
):
- Parameters
- project
\Klitsche\Dog\ProjectInterface
- owner
\Klitsche\Dog\Elements\ElementInterface
- php
\phpDocumentor\Reflection\Php\Interface_
getConstants()¶
public getConstants ( ): \Klitsche\Dog\Elements\Constant[]
- Returns
\Klitsche\Dog\Elements\Constant[]
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
getMethods()¶
public getMethods ( ): \Klitsche\Dog\Elements\Method[]
- Returns
\Klitsche\Dog\Elements\Method[]
getName()¶
public getName ( ): string
- Returns
string
getNamespace()¶
public getNamespace ( ): \phpDocumentor\Reflection\Fqsen
- Returns
\phpDocumentor\Reflection\Fqsen
getOwner()¶
public getOwner ( ): ?\Klitsche\Dog\Elements\ElementInterface
getParents()¶
public getParents ( ): \phpDocumentor\Reflection\Fqsen[]
- Returns
\phpDocumentor\Reflection\Fqsen[]
getPhp()¶
public getPhp ( ): \phpDocumentor\Reflection\Php\interface_
- Returns
\phpDocumentor\Reflection\Php\interface_
getProject()¶
public getProject ( ): \Klitsche\Dog\ProjectInterface
- Returns
\Klitsche\Dog\ProjectInterface
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: 80.65% (25 / 31)
- 💛 Methods: 73.33% (11 / 15)