Skip to content

Class File

Class \Klitsche\Dog\Elements\File

Constants

TYPE

public TYPE = 'File'

Methods

__construct()

public __construct ( 
    \Klitsche\Dog\ProjectInterface $project, 
    \phpDocumentor\Reflection\Php\File $file
 ):
Parameters
project \Klitsche\Dog\ProjectInterface
file \phpDocumentor\Reflection\Php\File

getClasses()

public getClasses (  ): \Klitsche\Dog\Elements\Class_[]
Returns
\Klitsche\Dog\Elements\Class_[]

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 (  ): self
Returns
self

getFunctions()

public getFunctions (  ): \Klitsche\Dog\Elements\Function_[]
Returns
\Klitsche\Dog\Elements\Function_[]

getHash()

public getHash (  ): string
Returns
string

getId()

public getId (  ): string
Returns
string

getIncludes()

public getIncludes (  ): string[]
Returns
string[]

getInterfaces()

public getInterfaces (  ): \Klitsche\Dog\Elements\Interface_[]
Returns
\Klitsche\Dog\Elements\Interface_[]

getLocation()

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

getName()

public getName (  ): string
Returns
string

getNamespaces()

public getNamespaces (  ): \phpDocumentor\Reflection\Fqsen[]
Returns
\phpDocumentor\Reflection\Fqsen[]

getOwner()

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

getPath()

public getPath (  ): string
Returns
string

getPhp()

public getPhp (  ): \phpDocumentor\Reflection\Php\File
Returns
\phpDocumentor\Reflection\Php\File

getProject()

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

getSource()

public getSource (  ): string
Returns
string

getTraits()

public getTraits (  ): \Klitsche\Dog\Elements\Trait_[]
Returns
\Klitsche\Dog\Elements\Trait_[]

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: 87.5% (35 / 40)
  • 💛 Methods: 73.68% (14 / 19)