README

中文说明

🚀 The most popular and comprehensive collection of high-quality components for the Hyperf framework, providing 50+ production-ready packages to accelerate your application development.

📖 About

This repository is a monorepo containing a collection of battle-tested, community-driven components that extend the Hyperf framework with additional features and integrations. Each component is independently usable and can be installed separately or as a complete suite.

✨ Features

🎯 50+ Components - Comprehensive collection covering various development needs
🔌 Easy Integration - Seamless integration with Hyperf 3.1+
📦 Modular Design - Install only what you need
🛡️ Production Ready - Battle-tested in production environments
📚 Well Documented - Comprehensive documentation in multiple languages
🧪 Fully Tested - High test coverage with PHPUnit and Pest
🌍 Multi-language - Documentation available in Chinese (Simplified, Traditional, HK) and English

📋 Requirements

PHP >= 8.1
Hyperf >= 3.1.0
Swoole or Swow extension

💾 Installation

Install All Components

composer require friendsofhyperf/components

Install Individual Components

You can install specific components as needed:

# Example: Install Telescope (Debug Assistant)
composer require friendsofhyperf/telescope

# Example: Install HTTP Client
composer require friendsofhyperf/http-client

# Example: Install Model Factory
composer require friendsofhyperf/model-factory --dev

🎯 Quick Start

After installing a component, most packages will automatically register with Hyperf through the ConfigProvider. Some components may require publishing configuration files:

php bin/hyperf.php vendor:publish friendsofhyperf/[component-name]

📦 Available Components

🔧 Development & Debugging Tools

telescope - Elegant debug assistant for Hyperf (requests, exceptions, SQL, Redis, etc.)
tinker - Powerful REPL for interactive debugging
web-tinker - Web-based Tinker interface
ide-helper - Enhanced IDE support and autocompletion
pretty-console - Beautiful console output formatting

💾 Database & Models

model-factory - Database model factories for testing
model-observer - Eloquent model observers
model-scope - Global and local query scopes
model-hashids - Hashids integration for models
model-morph-addon - Polymorphic relationship enhancements
compoships - Multi-column relationships for Eloquent
fast-paginate - High-performance pagination
mysql-grammar-addon - MySQL grammar extensions
trigger - MySQL trigger support

🗄️ Caching & Storage

cache - Advanced caching with multiple drivers
lock - Distributed locking mechanisms
redis-subscriber - Redis pub/sub subscriber

🌐 HTTP & API

http-client - Elegant HTTP client (Laravel-style)
http-logger - HTTP request/response logging
oauth2-server - OAuth2 server implementation

📨 Notifications & Communication

notification - Multi-channel notifications
notification-mail - Email notification channel
notification-easysms - SMS notification via EasySMS
mail - Email sending component
tcp-sender - TCP message sender

🔍 Search & Data

elasticsearch - Elasticsearch client integration
telescope-elasticsearch - Elasticsearch storage for Telescope

⚙️ Configuration & Infrastructure

confd - Configuration management with confd
config-consul - Consul configuration center

🛠️ Command & Console

command-signals - Signal handling for commands
command-validation - Command input validation
command-benchmark - Command performance benchmarking
console-spinner - Console loading spinners

🧩 Dependency Injection & Architecture

di-plus - Enhanced dependency injection features
facade - Laravel-style facades for Hyperf
middleware-plus - Enhanced middleware features
ipc-broadcaster - Inter-process communication broadcaster

🔐 Security & Validation

encryption - Data encryption and decryption
purifier - HTML purification (XSS protection)
recaptcha - Google reCAPTCHA integration
validated-dto - Data Transfer Objects with validation
grpc-validation - gRPC request validation

🎨 Utilities & Helpers

helpers - Useful helper functions
support - Support utilities and classes
macros - Macro support for various classes

📊 Monitoring & Logging

sentry - Sentry error tracking integration
monolog-hook - Monolog hooks and processors

🚀 Queue & Jobs

amqp-job - AMQP-based job queue

🧪 Testing

pest-plugin-hyperf - Pest testing framework integration
co-phpunit - Coroutine-compatible PHPUnit

🤖 AI & External Services

openai-client - OpenAI API client

📝 Others

exception-event - Exception event handling

📚 Documentation

For detailed documentation, visit the official documentation website.

Documentation by Language

🔨 Development

Clone the Repository

git clone https://github.com/friendsofhyperf/components.git
cd components

Install Dependencies

composer install

Running Tests

# Run all tests
composer test

# Run specific test suites
composer test:unit      # Unit tests
composer test:lint      # Code style checks
composer test:types     # Type coverage analysis

Code Quality

# Fix code style
composer cs-fix

# Run static analysis
composer analyse

🤝 Contributing

We welcome contributions from the community! Please read our Contributing Guidelines before submitting pull requests.

Development Workflow

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Make your changes
Run tests and code quality checks
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

🌟 Support & Community

📖 Documentation: hyperf.fans
💬 Issues: GitHub Issues
🐦 Twitter: @huangdijia
📧 Email: huangdijia@gmail.com

🔗 Mirrors

GitHub
CNB

👥 Contributors

We are grateful to all the contributors who have helped make this project better!

📄 License

This project is open-sourced software licensed under the MIT License.

Made with ❤️ by Deeka Wong and contributors

friendsofhyperf / components

Maintainers

Details