 |
VOOZH | about |
|
VOOZH | about |
This document provides a comprehensive reference of the external dependencies required by the hypervel/api-client package. It explains the role of each dependency, how they integrate with the API client architecture, and version compatibility requirements.
For information about the overall architecture and how these dependencies fit into the system design, see Architecture Overview. For details about the core components that utilize these dependencies, see sections ApiClient through ApiResource.
The hypervel/api-client package has minimal external dependencies, relying primarily on two sibling packages within the Hypervel ecosystem. This lean dependency structure ensures lightweight integration while providing powerful HTTP communication and utility capabilities.
| Dependency | Version | Purpose |
|---|---|---|
| php | ^8.2 | Platform requirement for language features |
| hypervel/support | ^0.3 | Utility library providing pipeline and helper functions |
| hypervel/http-client | ^0.3 | HTTP client library providing base request/response classes |
Sources: composer.json23-26
The package requires PHP 8.2 or higher. This requirement enables the use of modern PHP features including:
true, false, and null typesThe PHP 8.2 requirement is specified in composer.json24
The hypervel/support package provides utility classes and helper functions used throughout the Hypervel ecosystem. Within hypervel/api-client, its primary contribution is the Pipeline component.
The Pipeline class implements the chain-of-responsibility pattern used for middleware processing. It enables:
Diagram: hypervel/support Integration
The PendingRequest class instantiates Pipeline objects to process request and response middleware arrays. The pipeline receives an array of middleware classes, instantiates each one, and executes them in sequence, passing the request or response object through each stage.
Version: ^0.3 (specified in composer.json25)
Sources: composer.json25 High-Level System Architecture Diagram 1, Diagram 4
The hypervel/http-client package provides the foundational HTTP communication layer. It serves as the bridge between the API client's high-level abstractions and actual network operations.
The package provides two primary base classes that hypervel/api-client extends:
| Class | Extended By | Purpose |
|---|---|---|
HttpClientRequest | ApiRequest | Base class for HTTP request objects |
HttpClientResponse | ApiResponse | Base class for HTTP response objects |
Beyond base classes, hypervel/http-client handles:
Diagram: hypervel/http-client Integration
The inheritance relationship allows ApiRequest and ApiResponse to add API-specific functionality (like context management via the HasContext trait) while retaining all base HTTP capabilities. Meanwhile, PendingRequest delegates actual HTTP execution to the HTTP client, separating concerns between request orchestration and network communication.
Version: ^0.3 (specified in composer.json26)
Sources: composer.json26 High-Level System Architecture Diagram 1, Diagram 3
The following table maps each core component to its external dependencies:
| Component | Uses hypervel/support | Uses hypervel/http-client |
|---|---|---|
ApiClient | No | No |
PendingRequest | Yes (Pipeline) | Yes (HTTP execution) |
ApiRequest | No | Yes (extends HttpClientRequest) |
ApiResponse | No | Yes (extends HttpClientResponse) |
ApiResource | No | No |
HasContext | No | No |
Sources: composer.json23-26 High-Level System Architecture Diagram 1
The hypervel/api-client package is positioned as a mid-level component within the Hypervel ecosystem, building upon lower-level packages while providing specialized API client functionality.
Diagram: Hypervel Ecosystem Hierarchy
This hierarchy allows:
Sources: composer.json23-26 High-Level System Architecture Diagram 1
All Hypervel packages use semantic versioning and maintain synchronized major version numbers for compatibility.
The ^0.3 version constraint specifies:
This constraint ensures:
The package defines a branch alias in composer.json34-36:
This allows development versions from the main branch to satisfy the ^0.3 version constraint during local development or when using development dependencies.
Sources: composer.json23-26 composer.json34-36
The package uses PSR-4 autoloading with the namespace Hypervel\ApiClient\ mapped to the src/ directory, as defined in composer.json28-31
This structure enables:
All classes referenced in this documentation follow this namespace convention:
Hypervel\ApiClient\ApiClientHypervel\ApiClient\PendingRequestHypervel\ApiClient\ApiRequestHypervel\ApiClient\ApiResponseHypervel\ApiClient\ApiResourceHypervel\ApiClient\Traits\HasContextSources: composer.json28-31
When installing via Composer, all dependencies are resolved automatically:
This command will:
hypervel/api-client version 0.3.xhypervel/support ^0.3hypervel/http-client ^0.3For detailed installation instructions, see Installation.
Sources: composer.json2 composer.json23-26
Refresh this wiki