Skip to content

Commit b3dcef5

Browse files
committed
feat: atualizar documentação dos middlewares com descrições e informações de versão
1 parent 2e3cc03 commit b3dcef5

File tree

6 files changed

+61
-3
lines changed

6 files changed

+61
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
**PivotPHP** é um microframework moderno, leve e seguro, inspirado no Express.js, para construir APIs e aplicações web de alta performance em PHP. Ideal para validação de conceitos, estudos e desenvolvimento de aplicações que exigem produtividade, arquitetura desacoplada e extensibilidade real.
1717

18-
- **Alta Performance**: 1.32M+ ops/sec total throughput, 837K ops/sec JSON processing, 505K ops/sec small JSON, apenas 1.61MB memory footprint (v1.1.1 Revolutionary JSON Edition).
18+
- **Performance Competitiva**: 6,227 req/sec em ambiente Docker controlado (3º lugar em validação comparativa), 837K ops/sec JSON processing interno, 505K ops/sec small JSON, apenas 1.61MB memory footprint (v1.1.1 Revolutionary JSON Edition).
1919
- **Arquitetura Moderna**: DI Container, Service Providers, Event System, Extension System e PSR-15.
2020
- **Segurança**: Middlewares robustos para CSRF, XSS, Rate Limiting, JWT, API Key e mais.
2121
- **Extensível**: Sistema de plugins, hooks, providers e integração PSR-14.
@@ -210,7 +210,7 @@ $app->get('/api/users', function($req, $res) {
210210
$users = User::all(); // 1000+ usuários
211211

212212
// Automaticamente usa pooling para datasets grandes
213-
return $res->json($users); // 505K ops/sec (pequenos), 119K ops/sec (médios), 214K ops/sec (grandes)
213+
return $res->json($users); // 505K ops/sec (pequenos), 119K ops/sec (médios), 214K ops/sec (grandes) - Benchmarks internos
214214
});
215215

216216
// Controle manual para casos específicos
@@ -240,7 +240,7 @@ echo "Operations: {$stats['total_operations']}";
240240
**Características da Otimização JSON:**
241241
-**Detecção automática** - ativa pooling para arrays 10+ elementos, objetos 5+ propriedades
242242
-**Fallback inteligente** - dados pequenos usam `json_encode()` tradicional
243-
-**505K ops/sec** (pequenos), **119K ops/sec** (médios), **214K ops/sec** (grandes) em testes validados
243+
-**505K ops/sec** (pequenos), **119K ops/sec** (médios), **214K ops/sec** (grandes) em benchmarks internos
244244
-**100% reuso** de buffers em cenários de alta frequência
245245
-**Zero configuração** - funciona automaticamente com código existente
246246
-**Monitoramento integrado** - estatísticas detalhadas para otimização

src/Middleware/Http/ErrorMiddleware.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@
1212
use PivotPHP\Core\Http\Psr7\Stream;
1313
use Throwable;
1414

15+
/**
16+
* Error Handling Middleware
17+
*
18+
* Catches and handles exceptions that occur during request processing,
19+
* providing appropriate error responses and logging.
20+
*
21+
* @package PivotPHP\Core\Middleware\Http
22+
* @since 1.1.2
23+
*/
1524
class ErrorMiddleware implements MiddlewareInterface
1625
{
1726
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface

src/Middleware/Performance/CacheMiddleware.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@
99
use Psr\Http\Message\ServerRequestInterface;
1010
use Psr\Http\Message\ResponseInterface;
1111

12+
/**
13+
* Cache Middleware
14+
*
15+
* Provides HTTP response caching to improve application performance
16+
* by storing and serving cached responses for repeated requests.
17+
*
18+
* @package PivotPHP\Core\Middleware\Performance
19+
* @since 1.1.2
20+
*/
1221
class CacheMiddleware implements MiddlewareInterface
1322
{
1423
private int $ttl;

src/Middleware/Security/CsrfMiddleware.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@
1111
use PivotPHP\Core\Http\Psr7\Response;
1212
use PivotPHP\Core\Http\Psr7\Stream;
1313

14+
/**
15+
* CSRF Protection Middleware
16+
*
17+
* Provides Cross-Site Request Forgery (CSRF) protection by validating
18+
* tokens in form submissions and AJAX requests.
19+
*
20+
* @package PivotPHP\Core\Middleware\Security
21+
* @since 1.1.2
22+
*/
1423
class CsrfMiddleware implements MiddlewareInterface
1524
{
1625
private string $fieldName;

src/Middleware/Security/SecurityHeadersMiddleware.php

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,24 @@
99
use Psr\Http\Message\ServerRequestInterface;
1010
use Psr\Http\Message\ResponseInterface;
1111

12+
/**
13+
* Security Headers Middleware
14+
*
15+
* Adds essential security headers to HTTP responses including
16+
* X-Frame-Options, X-Content-Type-Options, and X-XSS-Protection.
17+
*
18+
* @package PivotPHP\Core\Middleware\Security
19+
* @since 1.1.2
20+
*/
1221
class SecurityHeadersMiddleware implements MiddlewareInterface
1322
{
23+
/**
24+
* Process the request and add security headers to the response
25+
*
26+
* @param ServerRequestInterface $request The incoming request
27+
* @param RequestHandlerInterface $handler The request handler
28+
* @return ResponseInterface The response with security headers
29+
*/
1430
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
1531
{
1632
$response = $handler->handle($request);
@@ -20,6 +36,12 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
2036
->withHeader('X-XSS-Protection', '1; mode=block');
2137
}
2238

39+
/**
40+
* Create a new instance of the middleware
41+
*
42+
* @param array $options Configuration options (currently unused)
43+
* @return self New middleware instance
44+
*/
2345
public static function create(array $options = []): self
2446
{
2547
return new self();

src/Middleware/Security/XssMiddleware.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@
99
use Psr\Http\Message\ServerRequestInterface;
1010
use Psr\Http\Message\ResponseInterface;
1111

12+
/**
13+
* XSS Protection Middleware
14+
*
15+
* Provides protection against Cross-Site Scripting (XSS) attacks by
16+
* sanitizing request input and adding appropriate security headers.
17+
*
18+
* @package PivotPHP\Core\Middleware\Security
19+
* @since 1.1.2
20+
*/
1221
class XssMiddleware implements MiddlewareInterface
1322
{
1423
private string $allowedTags;

0 commit comments

Comments
 (0)