Skip to content

Class ElementsIndex

Class \Klitsche\Dog\Elements\ElementsIndex

Methods

__construct()

public __construct (  ): 

addFile()

public addFile ( 
    \Klitsche\Dog\Elements\File $file
 ): void
Parameters
file \Klitsche\Dog\Elements\File

countElements()

public countElements (  ): int
Returns
int

getElementByFqsen()

public getElementByFqsen ( 
    \phpDocumentor\Reflection\Fqsen $fqsen
 ): ?\Klitsche\Dog\Elements\ElementInterface
Parameters
fqsen \phpDocumentor\Reflection\Fqsen
Returns
?\Klitsche\Dog\Elements\ElementInterface

getElementById()

public getElementById ( 
    string $id
 ): ?\Klitsche\Dog\Elements\ElementInterface
Parameters
id string
Returns
?\Klitsche\Dog\Elements\ElementInterface

getElements()

public getElements (  ): \Klitsche\Dog\Elements\ElementInterface[]
Returns
\Klitsche\Dog\Elements\ElementInterface[]

getElementsByElementType()

public getElementsByElementType ( 
    string $elementType
 ): \Klitsche\Dog\Elements\ElementInterface[]
Parameters
elementType string
Returns
\Klitsche\Dog\Elements\ElementInterface[]

getElementsByNamespace()

public getElementsByNamespace ( 
    \phpDocumentor\Reflection\Fqsen $namespace
 ): \Klitsche\Dog\Elements\ElementInterface[]
Parameters
namespace \phpDocumentor\Reflection\Fqsen
Returns
\Klitsche\Dog\Elements\ElementInterface[]

getFileByFqsen()

public getFileByFqsen ( 
    \phpDocumentor\Reflection\Fqsen $fqsen
 ): ?\Klitsche\Dog\Elements\File
Parameters
fqsen \phpDocumentor\Reflection\Fqsen
Returns
?\Klitsche\Dog\Elements\File

getFiles()

public getFiles (  ): \Klitsche\Dog\Elements\File[]
Returns
\Klitsche\Dog\Elements\File[]

getFqsenIndex()

public getFqsenIndex (  ): array
Returns
array

getNamespaces()

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

walk()

public walk ( 
    iterable $elements
 ): \Klitsche\Dog\Elements\ElementInterface[]
Parameters
elements iterable
Returns
\Klitsche\Dog\Elements\ElementInterface[]

walkElements()

public walkElements (  ): \Klitsche\Dog\Elements\ElementInterface[]
Returns
\Klitsche\Dog\Elements\ElementInterface[]

Test Coverage 🧡

  • 🧡 Lines: 68.18% (30 / 44)
  • ❤️ Methods: 28.57% (4 / 14)