Download the PHP package rawnoq/laravel-hmvc without Composer

Laravel HMVC Package

A professional, feature-rich Hierarchical Model-View-Controller (HMVC) package for Laravel applications. This package provides a complete modular architecture solution with automatic route loading, view registration, migration management, and comprehensive Artisan command support.

📋 Table of Contents

• Features
• Requirements
• Installation
• Quick Start
• Module Management
• Artisan Commands
• Module Structure
• Configuration
• Advanced Usage
• Examples
• Contributing
• License

✨ Features

Core Features

• ✅ Complete HMVC Architecture - Organize your application into independent, reusable modules
• ✅ Automatic Route Loading - Routes are automatically discovered and loaded from modules
• ✅ View Registration - Module views are automatically registered with Laravel
• ✅ Translation Support - Automatic language file loading from modules
• ✅ Migration Management - Module-specific migrations with dedicated commands
• ✅ Service Provider Support - Each module can have its own service providers
• ✅ Configuration Management - Module-specific configuration files
• ✅ Module Status Management - Enable/disable modules dynamically

Artisan Commands

• ✅ Make Commands - Full support for creating components within modules
• ✅ Module Management Commands - Create, list, enable, disable modules
• ✅ Migration & Seeding - Module-specific database operations
• ✅ Case-Insensitive - Module names work regardless of case

Supported Components

All Laravel make: commands support the --module option:

• Controllers, Models, Requests, Factories, Seeders, Migrations, Policies
• Middleware, Commands, Events, Listeners, Observers
• Resources, Tests, Notifications, Mail, Jobs, Exceptions
• Rules, Casts, Channels, Components, Enums, Scopes
• Views, Classes, Interfaces, Traits, DTOs, Config, Providers, Job Middleware

📦 Requirements

• PHP 8.2 or higher
• Laravel 11.0+ or Laravel 12.0+

🚀 Installation

Step 1: Install via Composer

The package will automatically register PSR-4 autoloading for your modules. No manual configuration needed!

Step 2: Publish Configuration (Optional)

This will publish the configuration file to config/hmvc.php.

Step 3: Publish Stubs (Optional)

This will publish module stubs to stubs/hmvc/module/ for customization.

⚠️ Note on Autoloading

The package automatically registers PSR-4 autoloading for the Modules namespace. You do not need to manually add it to your composer.json. The autoloading is registered programmatically and works on both Linux and Windows systems.

🎯 Quick Start

Create Your First Module

This command will create a complete module structure:

Create Components Within Modules

📚 Module Management

List All Modules

Output:

Enable/Disable Modules

Run Module Migrations

Run Module Seeders

🛠️ Artisan Commands

Module Management Commands

Module Options

The module:make command supports several options:

Make Commands with Module Support

All Laravel make: commands support the --module option:

Basic Components

Database Components

Event System

Jobs & Queues

API & Resources

Notifications & Mail

Validation & Rules

Broadcasting

View Components

Other Components

Note: All commands work normally without --module option (standard Laravel behavior).

📁 Module Structure

A typical module structure looks like this (matching Laravel's standard structure):

⚙️ Configuration

The configuration file is located at config/hmvc.php:

Customizing Module Directories

You can customize the directory structure in config/hmvc.php:

🎓 Advanced Usage

Module Service Providers

Each module can have its own service provider located at Providers/ServiceProvider.php:

Registering Class Aliases

The package provides two ways to register class aliases:

1. Using the Helper Function (Recommended):

Single alias:

Multiple aliases at once (snake_case):

Multiple aliases at once (camelCase):

Note: Both register_class_aliases() (snake_case) and registerClassAliases() (camelCase) are available. Use whichever naming convention you prefer.

2. Using the Trait:

Benefits:

• Allows modules to reference classes by a consistent name
• Actual implementation can be swapped via configuration
• Prevents duplicate alias registration
• Type-safe and maintainable

Module Routes

Web Routes (routes/web.php)

API Routes (routes/api.php)

Module Views

Views are automatically registered with the module name as namespace:

Module Translations

Translation files are automatically loaded:

Module Migrations

Migrations are automatically discovered and can be run with:

Or run all migrations (including modules):

Module Configuration

Access module configuration:

📝 Examples

Example 1: Complete Blog Module

Example 2: API Module with Events

Example 3: E-commerce Module

🔧 Troubleshooting

Module Not Found

If you get "Module does not exist" error:

1. Check module name (case-insensitive)
2. Verify module exists in modules/ directory
3. Run php artisan module:list to see all modules

Routes Not Loading

1. Ensure module is enabled: php artisan module:enable ModuleName
2. Check route files exist: modules/ModuleName/routes/web.php or api.php
3. Clear route cache: php artisan route:clear

Views Not Found

1. Verify view files exist in modules/ModuleName/Resources/views/
2. Use correct namespace: module-name::view.name
3. Clear view cache: php artisan view:clear

🧪 Testing

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please see CONTRIBUTING.md for more details.

📄 License

This package is open-sourced software licensed under the MIT license.

📦 Data Transfer Objects (DTOs)

The package includes a powerful DTO system with a base class for type-safe data transfer:

Creating DTOs

DTO Structure

All DTOs extend Rawnoq\HMVC\DTOs\BaseDto which provides:

• fromArray(array $data): static - Create DTO from array
• fromRequest(Request $request): static - Create DTO from validated request
• toArray(): array - Convert DTO to array

Example DTO

Using DTOs

🙏 Credits

• Author: Rawnoq
• Package: rawnoq/laravel-hmvc
• Version: 1.0.3

📚 Additional Resources

• Laravel Documentation
• HMVC Architecture

Made with ❤️ for the Laravel community