adachsoft/code-search-contract

v0.1.0 2026-02-14 14:36 UTC

Requires

• php: ^8.3
• adachsoft/collection: ^3.0

Requires (Dev)

• adachsoft/changelog-linter: ^0.3.0
• adachsoft/php-code-style: 0.3.0
• friendsofphp/php-cs-fixer: ^3.68
• justinrainbow/json-schema: ^5.2
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^12.4
• rector/rector: ^2.3
• twig/twig: ^3.0

MIT

• Arkadiusz Adach

README

Biblioteka kontraktowa dla wyszukiwania symboli w kodzie PHP.

Cel

Ta biblioteka definiuje stabilny, rozszerzalny kontrakt (interfejsy, DTO, VO, kolekcje, wyjątki) dla wyszukiwania symboli w kodzie PHP:

• typy (class / interface / trait / enum / anonymous),
• metody,
• relacje typów (implements / extends, w tym wyszukiwanie potomków).

Nie zawiera żadnej implementacji indeksowania ani wyszukiwania.

Instalacja

composer require adachsoft/code-search-contract

Główna fasada

use AdachSoft\CodeSearchContract\PublicApi\CodeSearchFacadeInterface;

Implementacja tej fasady powinna być dostarczona w osobnej bibliotece.

Quick start (dla deweloperów kontraktu)

composer install
composer test

Zakres API

• CodeSearchFacadeInterface  główna fasada,
• DTO/VO w przestrzeni nazw AdachSoft\CodeSearchContract\PublicApi i podprzestrzeniach,
• kolekcje oparte o adachsoft/collection (brak publicznych array w API),
• wyjątki jako główny mechanizm sygnalizacji błędów.

Szczegóły struktury można znaleźć w kodzie źródłowym w katalogu src/PublicApi.