Last indexed: 14 February 2026 (fb2a0f)

Getting Started

This guide covers installation, configuration, and initial usage of the hypervel/support package. It provides step-by-step instructions for integrating the package into your Hypervel or Hyperf application, understanding its dependencies, and making your first calls to facades and helper functions.

For architectural details about the package's design patterns, see Core Architecture. For comprehensive references to specific subsystems like HTTP, data persistence, or views, see their respective sections (HTTP Layer, Data Persistence Layer, View Layer).

Requirements

The hypervel/support package has the following requirements:

Requirement	Version	Purpose
PHP	^8.2	Minimum PHP version
hyperf/context	~3.1.0	Context management for coroutines
hyperf/support	~3.1.0	Base Hyperf utilities
hyperf/stringable	~3.1.0	String manipulation
hyperf/tappable	~3.1.0	Fluent method chaining
hyperf/collection	~3.1.0	Collection utilities
nesbot/carbon	^2.72.6	Date and time handling
league/uri	^7.5	URI manipulation

Sources: composer.json22-31

Installation

Step 1: Install via Composer

Add the package to your project using Composer:

The package will automatically install all required dependencies listed above.

Step 2: Verify Autoloading

The package uses PSR-4 autoloading for the Hypervel\Support namespace and automatically loads two function files:

src/Functions.php - Core function definitions
src/helpers.php - Global helper functions (~40 utilities)

These files are loaded automatically when Composer's autoloader is initialized.

Installation Flow Diagram

Sources: composer.json32-40

Package Structure and Integration

The hypervel/support package integrates into your application through multiple layers:

Integration Architecture Diagram

Sources: composer.json1-50 src/ServiceProvider.php1-50

Basic Usage

Using Facades

Facades provide a static interface to services registered in the container. Here are the primary facades available:

Facade	Purpose	Example Usage
`Hypervel\Support\Facades\Request`	Access HTTP request data	`Request::input('name')`
`Hypervel\Support\Facades\Response`	Generate HTTP responses	`Response::json(['status' => 'ok'])`
`Hypervel\Support\Facades\DB`	Database operations	`DB::table('users')->get()`
`Hypervel\Support\Facades\Cache`	Caching operations	`Cache::get('key')`
`Hypervel\Support\Facades\View`	Render views	`View::make('welcome')`
`Hypervel\Support\Facades\Route`	Define routes	`Route::get('/home', [HomeController::class, 'index'])`
`Hypervel\Support\Facades\Event`	Dispatch events	`Event::dispatch(new OrderShipped($order))`
`Hypervel\Support\Facades\Queue`	Queue jobs	`Queue::push(new ProcessOrder($order))`

Example: Using Request and Response Facades

For complete facade documentation, see Facade System.

Sources: High-level architectural diagrams (Facade Layer), Diagram 2

Using Helper Functions

The package provides approximately 40 global helper functions for common tasks:

Data Manipulation

Environment and Configuration

String Utilities

Control Flow

For a complete reference of all helper functions, see Helper Functions.

Sources: composer.json36-39 src/helpers.php (referenced but not included in files)

Service Provider Registration

Understanding Service Providers

Service providers are the central mechanism for bootstrapping services in the application. The ServiceProvider abstract class provides methods for:

Registering services in the container
Loading resources (routes, views, translations, migrations)
Publishing assets (configuration files, public assets)
Extending the framework with custom functionality

Service Provider Lifecycle Diagram

Sources: src/ServiceProvider.php17-92

Creating a Custom Service Provider

If you're building a package that extends the Hypervel framework, extend Hypervel\Support\ServiceProvider:

Key ServiceProvider Methods

Method	Purpose	Typical Usage
`register()`	Bind services to container	Service registration, configuration merging
`boot()`	Bootstrap after registration	Load routes, views, migrations, translations
`mergeConfigFrom(string $path, string $key)`	Merge package config with app config	ServiceProvider.php97-104
`loadRoutesFrom(string $path)`	Register route file	ServiceProvider.php109-113
`loadViewsFrom($path, string $namespace)`	Register view namespace	ServiceProvider.php118-130
`loadTranslationsFrom(string $path, string $namespace)`	Register translation namespace	ServiceProvider.php147-152
`loadMigrationsFrom($paths)`	Register migration paths	ServiceProvider.php167-174
`publishes(array $paths, $groups)`	Define publishable assets	ServiceProvider.php206-215

Sources: src/ServiceProvider.php54-240

Default Providers

The package includes a DefaultProviders collection that defines the core service providers:

Default Providers Structure

The DefaultProviders class provides methods to customize the provider collection:

merge(array $providers) - Add additional providers
replace(array $replacements) - Replace specific providers
except(array $providers) - Remove specific providers

Sources: src/DefaultProviders.php1-69 src/ServiceProvider.php327-330

Directory Structure

Understanding the package's internal structure:

hypervel/support/
├── src/
│ ├── Facades/ # Static facade classes
│ ├── ServiceProvider.php # Base service provider class
│ ├── DefaultProviders.php # Default provider collection
│ ├── Functions.php # Core function definitions
│ ├── helpers.php # Global helper functions
│ ├── DataObject.php # Base data object class
│ ├── Manager.php # Base manager class
│ └── Collection.php # Collection utilities
└── composer.json # Package definition

Code Entity Mapping