Overview

This document provides an overview of the hypervel/support package, a foundational utility library for the Hypervel framework built on top of Hyperf 3.1. It covers the package's purpose, dependencies, architectural patterns, and the facade-based API surface that applications interact with.

For installation and configuration instructions, see Getting Started. For detailed architectural patterns, see Core Architecture.

Purpose and Scope

The hypervel/support package serves as the infrastructure layer for the Hypervel framework, providing:

• Facade System: Static API layer for convenient access to framework services
• Core Patterns: Reusable architectural patterns (Manager, DataObject, ServiceProvider)
• Helper Functions: Global utility functions for common operations
• Testing Infrastructure: Fake implementations for isolated testing

This package is designed to be a dependency for other Hypervel components and application code, offering a Laravel-like developer experience on top of Hyperf's high-performance foundation.

Sources: composer.json1-50

Package Identity

Property	Value
Package Name	hypervel/support
Namespace	Hypervel\Support
Minimum PHP	8.2
License	MIT
Repository	https://github.com/hypervel/components

The package follows PSR-4 autoloading standards and automatically loads two helper files: src/Functions.php and src/helpers.php, which provide approximately 40 global utility functions.

Sources: composer.json2-4 composer.json22-23 composer.json32-39

Core Dependencies

Dependency Purposes

Dependency	Purpose
hyperf/context	Coroutine-safe context management for request-scoped data
hyperf/support	Base Hyperf utilities and contracts
hyperf/stringable	Fluent string manipulation interface
hyperf/tappable	Trait for tap/pipe method chaining
hyperf/collection	Base Collection implementation
nesbot/carbon	Advanced date and time manipulation
league/uri	RFC 3986 compliant URI manipulation

Sources: composer.json22-31

Architectural Layers

The package follows a multi-layer architecture with clear separation of concerns:

Sources: composer.json32-39

Facade Ecosystem

The package provides a comprehensive facade layer that serves as the primary API surface for applications. Each facade resolves to a concrete service implementation through the PSR-11 container.

Complete Facade Mapping

Facade Categories

Category	Facades	Primary Use Cases
HTTP	Request, Response, Cookie, Http, URL	Request handling, response generation, HTTP client operations
Routing	Route	Route registration, URL generation, model binding
Data	DB, Cache, Redis, Queue	Database queries, caching, message queues
View	View, Blade, Lang	Template rendering, localization
System	Event, Bus, Validator, Broadcast	Event dispatching, validation, real-time broadcasting

For detailed facade documentation, see Facade System.

Sources: composer.json34

Core Architectural Patterns

The package implements three foundational patterns that enable extensibility and code reuse:

Pattern Overview

Pattern	Base Class	Purpose
Facade	Hypervel\Support\Facades\Facade	Static proxy to container-resolved services
Manager	Hypervel\Support\Manager	Multi-driver service management with pooling
ServiceProvider	Hypervel\Support\ServiceProvider	Framework extension and service registration
DataObject	Hypervel\Support\DataObject	Auto-casting data transfer objects

Pattern Relationships

For detailed pattern documentation, see:

• Facade System
• Service Provider System
• Manager Pattern
• Data Object System

Sources: composer.json32-39

Helper Functions

The package automatically loads global helper functions from two files, providing quick access to common operations without requiring facade usage:

Helper File Structure

File	Purpose	Example Functions
src/helpers.php	Core utilities (~40 functions)	collect(), data_get(), retry(), env(), blank(), filled()
src/Functions.php	Additional utilities	Framework-specific helper functions

Helper Categories

For comprehensive helper function reference, see Helper Functions.

Sources: composer.json36-39

Testing Infrastructure

The package provides first-class testing support through fake implementations that replace real services during tests:

Available Fakes

Facade	Fake Implementation	Key Assertions
Event	EventFake	assertDispatched(), assertNotDispatched(), assertListening()
Queue	QueueFake	assertPushed(), assertPushedOn(), assertNotPushed()
Http	HTTP stubbing via Http::fake()	assertSent(), assertNotSent(), assertSentCount()

Testing Architecture

For detailed testing documentation, see Testing Infrastructure.

Sources: composer.json32-39

Package Structure

The package follows a standard PSR-4 structure with autoloading configuration:

Directory Layout

Path	Purpose
src/	Main source code root (PSR-4: Hypervel\Support)
src/Facades/	Facade implementations
src/helpers.php	Global helper functions
src/Functions.php	Additional utility functions
composer.json	Package definition and dependencies

Autoloading Configuration

The package uses two autoloading strategies:

1. PSR-4 Autoloading: Hypervel\Support\ namespace maps to src/ directory
2. File Autoloading: Automatically loads src/Functions.php and src/helpers.php on every request

This configuration ensures that all facades, classes, and helper functions are immediately available without manual imports.

Sources: composer.json32-39

Design Philosophy

The hypervel/support package is designed with the following principles:

1. Developer Experience First

• Facade Layer: Provides Laravel-like static API for familiarity
• Helper Functions: Quick access to common operations without class imports
• Type Safety: Leverages PHP 8.2+ features for better IDE support

2. High Performance Foundation

• Built on Hyperf 3.1, optimized for Swoole coroutines
• Coroutine-safe context management via hyperf/context
• Connection pooling support through Manager pattern

3. Extensibility

• ServiceProvider System: Clean extension points for package authors
• Manager Pattern: Easy addition of custom drivers
• Facade System: Swappable implementations for testing and customization

4. Testing-First

• Comprehensive fake implementations
• Assertion methods for verification
• Easy isolation of external dependencies

Sources: composer.json1-50

Version Information

Property	Value
Current Branch	0.3-dev
Stability	Development
PHP Requirement	^8.2
Hyperf Version	~3.1.0

Sources: composer.json41-49