Class Constant¶

Class \Klitsche\Dog\Elements\Constant

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\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 = 'Constant'

Methods¶

__construct()¶

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

Parameters: project \Klitsche\Dog\ProjectInterface; owner \Klitsche\Dog\Elements\ElementInterface; php \phpDocumentor\Reflection\Php\Constant

getData()¶

public getData ( 
    string $id
 ): mixed

Parameters: id string
Returns: mixed Null if data is not set

getDescription()¶

public getDescription (  ): ?string

Returns: ?string

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

Returns: \phpDocumentor\Reflection\Php\Constant

getProject()¶

public getProject (  ): \Klitsche\Dog\ProjectInterface

Returns: \Klitsche\Dog\ProjectInterface

getType()¶

public getType (  ): ?\phpDocumentor\Reflection\Type

Returns: ?\phpDocumentor\Reflection\Type

getValue()¶

public getValue (  ): ?string

Returns: ?string

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

isClassConstant()¶

public isClassConstant (  ): 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

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: 81.48% (22 / 27)
💛 Methods: 80% (12 / 15)