ParserFile

Parses a PHP source file and indexes its top-level declarations.

class ParserFile extends \Hazaar\Parser\PHP\TokenParser

The parser stores file metadata and discovered symbols such as constants, functions, interfaces, classes, and traits.

Properties

source

Absolute path to the parsed source file.

private string $source

size

File size in bytes.

private int $size

constants

Top-level constants discovered in the file.

private array $constants

functions

Top-level functions discovered in the file.

private array $functions

interfaces

Interface declarations discovered in the file.

private array $interfaces

classes

Class declarations discovered in the file.

private array $classes

traits

Trait declarations discovered in the file.

private array $traits

enums

Enum declarations discovered in the file.

private array $enums

Methods

__construct

Creates a parser instance and immediately parses the given file.

public __construct(string $filename): void

Parameters

Parameter	Type	Description
$filename	string	path to a readable PHP source file

getSource

Returns the source file path.

public getSource(): string

getSize

Returns the size of the file in bytes.

public getSize(): int

getConstants

Returns an array of constants defined in the file.

public getConstants(): void

getFunctions

Returns an array of functions defined in the file.

public getFunctions(): void

getInterfaces

Returns an array of interfaces defined in the file.

public getInterfaces(): void

getClasses

Returns an array of classes defined in the file.

public getClasses(): void

getTraits

Returns an array of traits defined in the file.

public getTraits(): void

getEnums

Returns an array of enums defined in the file.

public getEnums(): void

getDocBlock

Returns the file-level docblock marked with @file, when present.

public getDocBlock(): ?DocBlock

fixTokenArray

Converts raw token output into parser token objects.

private fixTokenArray(array $tokens): void

Whitespace tokens are intentionally excluded to simplify higher-level declaration parsing.

Parameters

Parameter	Type	Description
$tokens	array	raw tokens from token_get_all()

---

Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:25 +0000