README

🇺🇸 English | 🇷🇺 Русский

PHP tokenizer for finding class, interface, trait, and enum declarations.

Features

• High Performance - optimized PHP token parsing
• Full PHP 8+ Support - works with classes, interfaces, traits, and enums
• Modifier Support - handles abstract, final, readonly classes
• Anonymous Class Filtering - focuses on named declarations only
• PHP Attributes Support - properly handles #[Attribute] syntax
• Configurable Search - bitwise flags for selective searching

Installation

composer require bermudaphp/tokenizer

Quick Start

<?php

use Bermuda\Tokenizer\Tokenizer;
use Bermuda\Tokenizer\TokenizerInterface;

$tokenizer = new Tokenizer();
$source = '<?php 
namespace App\Models;

abstract class User {
    // ...
}

interface UserInterface {
    // ...
}
';

// Find all declarations
$declarations = $tokenizer->parse($source);

foreach ($declarations as $classInfo) {
    echo "Found {$classInfo->type}: {$classInfo->fullQualifiedName}\n";
    echo "Namespace: {$classInfo->namespace}\n";
    echo "Class name: {$classInfo->name}\n";
    echo "Abstract: " . ($classInfo->isAbstract ? 'yes' : 'no') . "\n";
    echo "---\n";
}

Search Modes

Use bitwise flags to configure which declaration types to search for:

// Search only classes
$classes = $tokenizer->parse($source, TokenizerInterface::SEARCH_CLASSES);

// Search only interfaces and traits
$interfaces = $tokenizer->parse($source, 
    TokenizerInterface::SEARCH_INTERFACES | TokenizerInterface::SEARCH_TRAITS
);

// Search everything (default)
$all = $tokenizer->parse($source, TokenizerInterface::SEARCH_ALL);

Available Flags

ClassInfo API

The ClassInfo class provides detailed information about found declarations:

Properties

$classInfo->fullQualifiedName;  // string: Fully qualified class name
$classInfo->type;              // string: 'class'|'interface'|'trait'|'enum'
$classInfo->isAbstract;        // bool: Is abstract class
$classInfo->isFinal;           // bool: Is final class
$classInfo->isReadonly;        // bool: Is readonly class

Virtual Properties

$classInfo->name;              // string: Class name without namespace
$classInfo->namespace;         // string: Namespace without class name
$classInfo->isClass;          // bool: Is this a class?
$classInfo->isInterface;      // bool: Is this an interface?
$classInfo->isTrait;          // bool: Is this a trait?
$classInfo->isEnum;           // bool: Is this an enum?
$classInfo->isConcrete;       // bool: Is concrete class (not abstract)?
$classInfo->reflector;        // ReflectionClass|ReflectionEnum: Reflector instance

Methods

$classInfo->exists();         // bool: Does the class exist in memory

Usage Examples

Finding Concrete Classes

$source = file_get_contents('path/to/file.php');
$declarations = $tokenizer->parse($source, TokenizerInterface::SEARCH_CLASSES);

$concreteClasses = array_filter($declarations, fn($info) => $info->isConcrete);

Working with Reflection

foreach ($declarations as $classInfo) {
    if ($classInfo->exists()) {
        $reflection = $classInfo->reflector;
        echo "Class {$classInfo->name} has " . count($reflection->getMethods()) . " methods\n";
    }
}

Grouping by Namespace

$byNamespace = [];
foreach ($declarations as $classInfo) {
    $byNamespace[$classInfo->namespace][] = $classInfo->name;
}

Requirements

• PHP 8.4 or higher
• tokenizer extension (usually included in standard PHP builds)

License

MIT License. See LICENSE file for details.