Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions qadocs-out/01-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 1. Project overview

> Generated by codebase-qa-docs 1.0.0 from `Slim`. Every row cites `file:line` in the scanned source. Items that could not be verified are marked **Not Verified**. Do not edit by hand: re-run the generate command.

| Item | Value |
|---|---|
| Project name | `Slim` (taken from the folder name) |
| Files scanned | 145 |
| Code LOC (non-blank, in code languages) | 13451 |
| Modules (top-level groupings) | 4 |
| Routes found | 31 |
| File-based endpoints (PHP in `api/`) | 0 |
| Tables/models found | 0 |

## Purpose

Quoted from `README.md:1`: **Slim Framework**

> [![Build Status](https://github.com/slimphp/Slim/actions/workflows/tests.yml/badge.svg?branch=4.x)](https://github.com/slimphp/Slim/actions/workflows/tests.yml?query=branch:4.x) — `README.md:3`
> [![Coverage Status](https://coveralls.io/repos/github/slimphp/Slim/badge.svg?branch=4.x)](https://coveralls.io/github/slimphp/Slim?branch=4.x) — `README.md:4`
> [![Total Downloads](https://poser.pugx.org/slim/slim/downloads)](https://packagist.org/packages/slim/slim) — `README.md:5`
> [![License](https://poser.pugx.org/slim/slim/license)](https://packagist.org/packages/slim/slim) — `README.md:6`

## Languages

| Language | Files | LOC |
|---|---:|---:|
| PHP | 125 | 13451 |
| Markdown | 8 | 493 |
| JSON | 1 | 105 |
| Other text | 6 | 85 |
| YAML | 4 | 64 |
| XML | 1 | 17 |

## Entry points

None of the conventional entry file names were found. **Not Verified**: how the application is started.
21 changes: 21 additions & 0 deletions qadocs-out/02-technology-stack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 2. Technology stack

> Generated by codebase-qa-docs 1.0.0 from `Slim`. Every row cites `file:line` in the scanned source. Items that could not be verified are marked **Not Verified**. Do not edit by hand: re-run the generate command.

## Frameworks / libraries recognised from manifests

| Name | Detail | Evidence |
|---|---|---|
| PHPUnit | dependency phpunit/phpunit ^9.6 \|\| ^10 \|\| ^11 \|\| ^12 | `composer.json:68` |

## Manifests parsed

- `composer.json`

## Containers

No Dockerfile or compose file found.

## Notes

- PHP constraint `~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0` declared in composer.json:46
165 changes: 165 additions & 0 deletions qadocs-out/03-folder-structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
# 3. Folder structure

> Generated by codebase-qa-docs 1.0.0 from `Slim`. Every row cites `file:line` in the scanned source. Items that could not be verified are marked **Not Verified**. Do not edit by hand: re-run the generate command.

Depth is limited to 3 levels; file counts are exact. Directories skipped by design: `.git`, `.svn`, `.hg`, `node_modules`, `vendor`, `.qa-docs`, `__pycache__`, `.idea`, `.vscode`, `.venv`, `venv`, `env`, `bower_components`, `.next`, `.nuxt`, `dist`, `build`, `coverage`, `.pytest_cache`, `.gradle`, `graphify-out`, `.cache`.

```text
.github/ (3 files)
workflows/ (1 files)
tests.yml
FUNDING.yml
dependabot.yml
Slim/ (72 files)
Error/ (5 files)
Renderers/ (4 files)
AbstractErrorRenderer.php
Exception/ (11 files)
HttpBadRequestException.php
HttpException.php
HttpForbiddenException.php
HttpGoneException.php
HttpInternalServerErrorException.php
HttpMethodNotAllowedException.php
HttpNotFoundException.php
HttpNotImplementedException.php
HttpSpecializedException.php
HttpTooManyRequestsException.php
HttpUnauthorizedException.php
Factory/ (12 files)
Psr17/ (10 files)
AppFactory.php
ServerRequestCreatorFactory.php
Handlers/ (5 files)
Strategies/ (4 files)
ErrorHandler.php
Interfaces/ (17 files)
AdvancedCallableResolverInterface.php
CallableResolverInterface.php
DispatcherInterface.php
ErrorHandlerInterface.php
ErrorRendererInterface.php
InvocationStrategyInterface.php
MiddlewareDispatcherInterface.php
Psr17FactoryInterface.php
Psr17FactoryProviderInterface.php
RequestHandlerInvocationStrategyInterface.php
RouteCollectorInterface.php
RouteCollectorProxyInterface.php
RouteGroupInterface.php
RouteInterface.php
RouteParserInterface.php
RouteResolverInterface.php
ServerRequestCreatorInterface.php
Middleware/ (6 files)
BodyParsingMiddleware.php
ContentLengthMiddleware.php
ErrorMiddleware.php
MethodOverrideMiddleware.php
OutputBufferingMiddleware.php
RoutingMiddleware.php
Routing/ (11 files)
Dispatcher.php
FastRouteDispatcher.php
Route.php
RouteCollector.php
RouteCollectorProxy.php
RouteContext.php
RouteGroup.php
RouteParser.php
RouteResolver.php
RouteRunner.php
RoutingResults.php
App.php
CallableResolver.php
Logger.php
MiddlewareDispatcher.php
ResponseEmitter.php
tests/ (53 files)
Assets/ (1 files)
HeaderStack.php
Error/ (1 files)
AbstractErrorRendererTest.php
Exception/ (2 files)
HttpExceptionTest.php
HttpUnauthorizedExceptionTest.php
Factory/ (5 files)
Psr17/ (3 files)
AppFactoryTest.php
ServerRequestCreatorFactoryTest.php
Handlers/ (2 files)
Strategies/ (1 files)
ErrorHandlerTest.php
Middleware/ (6 files)
BodyParsingMiddlewareTest.php
ContentLengthMiddlewareTest.php
ErrorMiddlewareTest.php
MethodOverrideMiddlewareTest.php
OutputBufferingMiddlewareTest.php
RoutingMiddlewareTest.php
Mocks/ (19 files)
CallableTest.php
InvocationStrategyTest.php
InvokableTest.php
MiddlewareTest.php
MockAction.php
MockCustomException.php
MockCustomRequestHandlerInvocationStrategy.php
MockMiddlewareSlimCallable.php
MockMiddlewareWithConstructor.php
MockMiddlewareWithoutConstructor.php
MockMiddlewareWithoutInterface.php
MockPsr17Factory.php
MockPsr17FactoryWithoutStreamFactory.php
MockRequestHandler.php
MockSequenceMiddleware.php
MockStream.php
RequestHandlerTest.php
SlowPokeStream.php
SmallChunksStream.php
Providers/ (2 files)
PSR7ObjectProvider.php
PSR7ObjectProviderInterface.php
Routing/ (9 files)
DispatcherTest.php
FastRouteDispatcherTest.php
RouteCollectorProxyTest.php
RouteCollectorTest.php
RouteContextTest.php
RouteParserTest.php
RouteResolverTest.php
RouteRunnerTest.php
RouteTest.php
AppTest.php
CallableResolverTest.php
MiddlewareDispatcherTest.php
ResponseEmitterTest.php
TestCase.php
bootstrap.php
.coveralls.yml
.editorconfig
.gitattributes
.gitignore
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.md
MAINTAINERS.md
README.md
SECURITY.md
UPGRADING.md
composer.json
phpcs.xml.dist
phpstan.neon.dist
phpunit.xml.dist
psalm.xml
```

## Convention-based directory hints (inferred from names only)

| Directory | Common meaning | Status |
|---|---|---|
| `Slim/Middleware` | `middleware` directory name | Inferred from name; contents not judged |
| `tests` | `tests` directory name | Inferred from name; contents not judged |
| `tests/Assets` | `assets` directory name | Inferred from name; contents not judged |
| `tests/Middleware` | `middleware` directory name | Inferred from name; contents not judged |
30 changes: 30 additions & 0 deletions qadocs-out/04-architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# 4. Architecture

> Generated by codebase-qa-docs 1.0.0 from `Slim`. Every row cites `file:line` in the scanned source. Items that could not be verified are marked **Not Verified**. Do not edit by hand: re-run the generate command.

Diagrams: [architecture.drawio](diagrams/architecture.drawio), [api-routes.drawio](diagrams/api-routes.drawio).

## Components (top-level modules)

| Module | Files | LOC | Languages |
|---|---:|---:|---|
| `tests` | 53 | 8581 | PHP |
| `Slim` | 72 | 4870 | PHP |
| `(root)` | 17 | 701 | YAML, Markdown, JSON, XML |
| `.github` | 3 | 63 | YAML |

## Verified inter-module dependencies

Only imports/includes that resolve to a real file in the scanned tree are listed (static resolution; dynamic includes are not followed).

| From | To | References | First evidence |
|---|---|---:|---|
| `tests` | `Slim` | 140 | `tests/AppTest.php:26` |

## External systems

- No database usage detected by the supported patterns. **Not Verified** that none exists.

## Architectural pattern

**Not Verified.** This tool does not assert a pattern (MVC, layered, microservices). Directory-name hints are listed in [03-folder-structure.md](03-folder-structure.md); confirm with the team.
114 changes: 114 additions & 0 deletions qadocs-out/05-modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# 5. Modules

> Generated by codebase-qa-docs 1.0.0 from `Slim`. Every row cites `file:line` in the scanned source. Items that could not be verified are marked **Not Verified**. Do not edit by hand: re-run the generate command.

## `tests`

- Files: 53 · LOC: 8581 · Languages: PHP
- Depends on (verified imports): `Slim`

| Kind | Name | Evidence |
|---|---|---|
| class | `AppTest` | `tests/AppTest.php:56` |
| class | `HeaderStack` | `tests/Assets/HeaderStack.php:41` |
| class | `CallableResolverTest` | `tests/CallableResolverTest.php:24` |
| class | `AbstractErrorRendererTest` | `tests/Error/AbstractErrorRendererTest.php:32` |
| class | `HttpExceptionTest` | `tests/Exception/HttpExceptionTest.php:18` |
| class | `HttpUnauthorizedExceptionTest` | `tests/Exception/HttpUnauthorizedExceptionTest.php:16` |
| class | `AppFactoryTest` | `tests/Factory/AppFactoryTest.php:45` |
| class | `Psr17FactoryProviderTest` | `tests/Factory/Psr17/Psr17FactoryProviderTest.php:16` |
| class | `Psr17FactoryTest` | `tests/Factory/Psr17/Psr17FactoryTest.php:17` |
| class | `SlimHttpServerRequestCreatorTest` | `tests/Factory/Psr17/SlimHttpServerRequestCreatorTest.php:23` |
| class | `ServerRequestCreatorFactoryTest` | `tests/Factory/ServerRequestCreatorFactoryTest.php:32` |
| class | `ErrorHandlerTest` | `tests/Handlers/ErrorHandlerTest.php:31` |
| class | `RequestResponseNamedArgsTest` | `tests/Handlers/Strategies/RequestResponseNamedArgsTest.php:18` |
| class | `BodyParsingMiddlewareTest` | `tests/Middleware/BodyParsingMiddlewareTest.php:23` |
| class | `ContentLengthMiddlewareTest` | `tests/Middleware/ContentLengthMiddlewareTest.php:17` |
| class | `ErrorMiddlewareTest` | `tests/Middleware/ErrorMiddlewareTest.php:28` |
| class | `MethodOverrideMiddlewareTest` | `tests/Middleware/MethodOverrideMiddlewareTest.php:19` |
| class | `OutputBufferingMiddlewareTest` | `tests/Middleware/OutputBufferingMiddlewareTest.php:22` |
| class | `RoutingMiddlewareTest` | `tests/Middleware/RoutingMiddlewareTest.php:31` |
| class | `MiddlewareDispatcherTest` | `tests/MiddlewareDispatcherTest.php:28` |
| class | `CallableTest` | `tests/Mocks/CallableTest.php:15` |
| class | `InvocationStrategyTest` | `tests/Mocks/InvocationStrategyTest.php:17` |
| class | `InvokableTest` | `tests/Mocks/InvokableTest.php:13` |
| class | `MiddlewareTest` | `tests/Mocks/MiddlewareTest.php:19` |
| class | `MockAction` | `tests/Mocks/MockAction.php:19` |
| class | `MockCustomException` | `tests/Mocks/MockCustomException.php:15` |
| class | `MockCustomRequestHandlerInvocationStrategy` | `tests/Mocks/MockCustomRequestHandlerInvocationStrategy.php:17` |
| class | `MockMiddlewareSlimCallable` | `tests/Mocks/MockMiddlewareSlimCallable.php:17` |
| class | `MockMiddlewareWithConstructor` | `tests/Mocks/MockMiddlewareWithConstructor.php:20` |
| class | `MockMiddlewareWithoutConstructor` | `tests/Mocks/MockMiddlewareWithoutConstructor.php:18` |
| class | `MockMiddlewareWithoutInterface` | `tests/Mocks/MockMiddlewareWithoutInterface.php:13` |
| class | `MockPsr17Factory` | `tests/Mocks/MockPsr17Factory.php:15` |
| class | `MockPsr17FactoryWithoutStreamFactory` | `tests/Mocks/MockPsr17FactoryWithoutStreamFactory.php:15` |
| class | `MockRequestHandler` | `tests/Mocks/MockRequestHandler.php:18` |
| class | `MockSequenceMiddleware` | `tests/Mocks/MockSequenceMiddleware.php:18` |
| class | `MockStream` | `tests/Mocks/MockStream.php:36` |
| class | `RequestHandlerTest` | `tests/Mocks/RequestHandlerTest.php:20` |
| class | `SlowPokeStream` | `tests/Mocks/SlowPokeStream.php:22` |
| class | `SmallChunksStream` | `tests/Mocks/SmallChunksStream.php:21` |
| class | `PSR7ObjectProvider` | `tests/Providers/PSR7ObjectProvider.php:30` |

_12 more symbols not shown — see `data/facts.json`._

## `Slim`

- Files: 72 · LOC: 4870 · Languages: PHP

| Kind | Name | Evidence |
|---|---|---|
| class | `App` | `Slim/App.php:39` |
| class | `CallableResolver` | `Slim/CallableResolver.php:32` |
| class | `AbstractErrorRenderer` | `Slim/Error/AbstractErrorRenderer.php:23` |
| class | `HtmlErrorRenderer` | `Slim/Error/Renderers/HtmlErrorRenderer.php:27` |
| class | `JsonErrorRenderer` | `Slim/Error/Renderers/JsonErrorRenderer.php:26` |
| class | `PlainTextErrorRenderer` | `Slim/Error/Renderers/PlainTextErrorRenderer.php:23` |
| class | `XmlErrorRenderer` | `Slim/Error/Renderers/XmlErrorRenderer.php:23` |
| class | `HttpBadRequestException` | `Slim/Exception/HttpBadRequestException.php:14` |
| class | `HttpException` | `Slim/Exception/HttpException.php:21` |
| class | `HttpForbiddenException` | `Slim/Exception/HttpForbiddenException.php:14` |
| class | `HttpGoneException` | `Slim/Exception/HttpGoneException.php:14` |
| class | `HttpInternalServerErrorException` | `Slim/Exception/HttpInternalServerErrorException.php:14` |
| class | `HttpMethodNotAllowedException` | `Slim/Exception/HttpMethodNotAllowedException.php:15` |
| class | `HttpNotFoundException` | `Slim/Exception/HttpNotFoundException.php:13` |
| class | `HttpNotImplementedException` | `Slim/Exception/HttpNotImplementedException.php:14` |
| class | `HttpSpecializedException` | `Slim/Exception/HttpSpecializedException.php:16` |
| class | `HttpTooManyRequestsException` | `Slim/Exception/HttpTooManyRequestsException.php:14` |
| class | `HttpUnauthorizedException` | `Slim/Exception/HttpUnauthorizedException.php:14` |
| class | `AppFactory` | `Slim/Factory/AppFactory.php:28` |
| class | `GuzzlePsr17Factory` | `Slim/Factory/Psr17/GuzzlePsr17Factory.php:13` |
| class | `HttpSoftPsr17Factory` | `Slim/Factory/Psr17/HttpSoftPsr17Factory.php:13` |
| class | `LaminasDiactorosPsr17Factory` | `Slim/Factory/Psr17/LaminasDiactorosPsr17Factory.php:13` |
| class | `NyholmPsr17Factory` | `Slim/Factory/Psr17/NyholmPsr17Factory.php:9` |
| class | `Psr17Factory` | `Slim/Factory/Psr17/Psr17Factory.php:22` |
| class | `Psr17FactoryProvider` | `Slim/Factory/Psr17/Psr17FactoryProvider.php:17` |
| class | `ServerRequestCreator` | `Slim/Factory/Psr17/ServerRequestCreator.php:17` |
| class | `SlimHttpPsr17Factory` | `Slim/Factory/Psr17/SlimHttpPsr17Factory.php:17` |
| class | `SlimHttpServerRequestCreator` | `Slim/Factory/Psr17/SlimHttpServerRequestCreator.php:19` |
| class | `SlimPsr17Factory` | `Slim/Factory/Psr17/SlimPsr17Factory.php:13` |
| class | `ServerRequestCreatorFactory` | `Slim/Factory/ServerRequestCreatorFactory.php:21` |
| class | `ErrorHandler` | `Slim/Handlers/ErrorHandler.php:48` |
| class | `RequestHandler` | `Slim/Handlers/Strategies/RequestHandler.php:20` |
| class | `RequestResponse` | `Slim/Handlers/Strategies/RequestResponse.php:20` |
| class | `RequestResponseArgs` | `Slim/Handlers/Strategies/RequestResponseArgs.php:23` |
| class | `RequestResponseNamedArgs` | `Slim/Handlers/Strategies/RequestResponseNamedArgs.php:22` |
| interface | `AdvancedCallableResolverInterface` | `Slim/Interfaces/AdvancedCallableResolverInterface.php:13` |
| interface | `CallableResolverInterface` | `Slim/Interfaces/CallableResolverInterface.php:13` |
| interface | `DispatcherInterface` | `Slim/Interfaces/DispatcherInterface.php:15` |
| interface | `ErrorHandlerInterface` | `Slim/Interfaces/ErrorHandlerInterface.php:17` |
| interface | `ErrorRendererInterface` | `Slim/Interfaces/ErrorRendererInterface.php:15` |

_32 more symbols not shown — see `data/facts.json`._

## `(root)`

- Files: 17 · LOC: 701 · Languages: YAML, Markdown, JSON, XML
- No classes/functions extracted by the supported patterns.

## `.github`

- Files: 3 · LOC: 63 · Languages: YAML
- No classes/functions extracted by the supported patterns.

_Module responsibilities are **Not Verified**: only structure is extracted, not intent._
Loading