Download the PHP package qdenka/php-architecture-guardian without Composer
On this page you can find all versions of the php package qdenka/php-architecture-guardian. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download qdenka/php-architecture-guardian
More information about qdenka/php-architecture-guardian
Files in qdenka/php-architecture-guardian
Package php-architecture-guardian
Short Description A tool for enforcing architectural principles in PHP projects
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-architecture-guardian
PHPArchitectureGuardian
PHPArchitectureGuardian is a powerful static analysis tool that helps you enforce architectural principles in your PHP projects. It ensures your code follows architectural patterns like Domain-Driven Design (DDD), Clean Architecture, or Hexagonal Architecture (Ports & Adapters).
Features
-
🏛️ Verify adherence to various architectural patterns:
- Domain-Driven Design (DDD)
- Clean Architecture
- Hexagonal Architecture (Ports & Adapters)
- Custom architecture rules
-
🔍 Enforce architectural constraints:
- Prevent improper dependencies between layers
- Ensure correct implementation of interfaces
- Validate proper namespace usage
- Enforce naming conventions
-
🛠️ Highly customizable:
- Configure namespaces for different architecture layers
- Create custom rules with specific validation logic
- Define custom naming conventions
- Specify custom dependency constraints
- 📊 Comprehensive reporting:
- Clear violation descriptions
- Severity levels for different issues
- Configurable output formats
Installation
You can install the package via composer:
Usage
Basic Usage
Run the tool in your project directory:
Configuration
Create a .architecture-guardian.php configuration file in your project root:
See the example configuration for a complete example with all options.
Command-Line Options
Supported Architectural Patterns
Domain-Driven Design (DDD)
Enforces the layered architecture of DDD:
- Domain Layer: Contains business logic, entities, value objects
- Application Layer: Contains application services, commands, queries
- Infrastructure Layer: Contains implementations of repositories, external services
Rules ensure:
- Domain layer does not depend on application or infrastructure
- Application layer does not depend on infrastructure (configurable)
- Infrastructure components implement domain interfaces
Clean Architecture
Enforces the concentric layers of Clean Architecture:
- Entities Layer: Core business objects
- Use Cases Layer: Application-specific business rules
- Interface Adapters Layer: Presenters, controllers, gateways
- Frameworks & Drivers Layer: Web, UI, DB, devices, external interfaces
Rules ensure:
- Entities do not depend on outer layers
- Use Cases depend only on Entities
- Interface Adapters depend only on Use Cases and Entities
- Frameworks & Drivers depend on inner layers
Hexagonal Architecture (Ports & Adapters)
Enforces the separation of:
- Domain: Core business logic
- Ports: Interfaces defining how domain interacts with outside world
- Adapters: Implementations of ports that connect to external systems
Rules ensure:
- Domain does not depend on anything outside
- Ports are interfaces and depend only on domain
- Adapters implement ports and connect to external systems
Custom Architecture Rules
Create your own architecture rules:
- Define custom naming conventions for different namespaces
- Specify allowed dependencies between namespaces
- Create custom rule classes for complex validation logic
Contributing
Contributions are welcome! Please see CONTRIBUTING for details.
License
The MIT License (MIT). Please see License File for more information.
