Core Architecture
| Rule | Keywords | Description |
|---|---|---|
| config-injection | config, env, injection | Inject ConfigInterface or use config() helper |
| logger-factory-usage | log, logger, monolog | Use LoggerFactory for structured logging |
| middleware-structure | middleware, psr-15 | Use PSR-15 Middleware interface |
| event-listener-structure | event, listener, psr-14 | Decouple logic with Event Listeners |
| aop-aspect-structure | aop, aspect, proxy | Use Aspects for cross-cutting concerns |
| custom-process-structure | process, daemon | Use Custom Processes for background tasks |
| validation-form-request | validation, request, form | Use FormRequest for validation encapsulation |
HTTP Layer
| Rule | Keywords | Description |
|---|---|---|
| router-annotations | route, router, annotation | Use Annotations for routing |
| request-injection | request, input, injection | Inject RequestInterface instead of globals |
| exception-handler | exception, error, handler | Use ExceptionHandler for global error handling |
| api-resource-usage | resource, json, transformation | Use JsonResource for API responses |
Microservices & Network
| Rule | Keywords | Description |
|---|---|---|
| guzzle-client-factory | guzzle, http client, curl | Use ClientFactory for coroutine-safe HTTP requests |
| rpc-service-definition | rpc, jsonrpc, grpc | Define RPC services with interfaces |
| websocket-controller | websocket, socket.io | Use Annotations for WebSocket events |
| service-governance-annotations | rate limit, circuit breaker | Use Annotations for governance |
| tracer-usage | tracer, opentracing, zipkin | Use OpenTracing for distributed tracing |
| async-queue-usage | queue, async, job | Use Async Queue for background tasks |
| amqp-usage | amqp, rabbitmq, queue | Use AMQP for RabbitMQ messaging |
| kafka-usage | kafka, queue, stream | Use Kafka for high-throughput messaging |
| tcp-server-usage | tcp, server, socket | Create custom TCP servers |
| websocket-client-usage | websocket, client, ws | Use WebSocket Client for real-time comms |
| config-center-usage | config center, nacos, consul | Use Config Center for dynamic configuration |
| metric-usage | metric, prometheus, monitor | Use Prometheus for monitoring metrics |
| retry-usage | retry, policy, resilience | Use Retry annotation for fault tolerance |
| distributed-transaction-usage | dtm, saga, tcc | Use DTM for distributed transactions |
Data & Caching
| Rule | Keywords | Description |
|---|---|---|
| redis-pool-usage | redis, pool, connection | Use Redis proxy for connection pooling |
| model-cache-usage | cache, model, orm | Use ModelCache for high-performance reads |
| simple-cache-usage | cache, psr-16 | Use PSR-16 Simple Cache interface |
| elasticsearch-client | elasticsearch, search | Use ClientBuilderFactory for ES client |
| model-relationships | model, relation, hasmany | Define model relationships with return types |
| model-mutator-usage | model, mutator, cast | Use Accessors, Mutators and Casts |
| db-migration-usage | migration, schema, database | Use Migrations for schema changes |
| paginator-usage | pagination, paginator, limit | Use Paginator for result set paging |
| scout-usage | scout, search, elasticsearch | Use Scout for model full-text search |
Utilities & System
| Rule | Keywords | Description |
|---|---|---|
| translation-usage | i18n, translation, trans | Use TranslatorInterface for internationalization |
| snowflake-id-generator | id, snowflake, uuid | Use Snowflake for distributed unique IDs |
| crontab-usage | cron, schedule, task | Use Crontab annotations for scheduling |
| swagger-annotations | swagger, openapi, doc | Use Annotations for API documentation |
| view-render-usage | view, render, template | Use RenderInterface for view rendering |
| command-annotation | command, console, cli | Use Annotations for Console Commands |
| filesystem-usage | file, storage, flysystem | Use FilesystemFactory for file operations |
| testing-structure | test, phpunit, mock | Use Co-PHPUnit and Testing components |
| constants-usage | constants, error code, enum | Define error codes with AbstractConstants |
| watcher-config | watcher, hot reload, dev | Use Watcher for hot reloading in development |