 |
VOOZH | about |
|
VOOZH | about |
This page describes the installation procedures for the friendsofhyperf/components monorepo and its individual components. It covers system requirements, installation methods, component registration, and configuration publishing procedures.
For information about the monorepo architecture and the "replace" directive strategy, see Monorepo Architecture and Component Registry. For a complete list of available components, see Component Catalog.
The following software versions are required to use any component from this monorepo:
| Requirement | Version |
|---|---|
| PHP | >= 8.1 |
| Hyperf Framework | >= 3.1.0 |
| Coroutine Engine | Swoole or Swow extension |
| Composer | >= 2.0 |
Sources: composer.json16-18 README.md28-32
The monorepo supports two installation approaches: installing all components as a suite or installing individual components on demand.
Installing the complete package provides all 50+ components through Composer's "replace" directive:
This single command makes all components available because composer.json119-168 declares a replace section that maps each individual package name to the monorepo version. When you require friendsofhyperf/components, Composer treats it as if you had installed all individual packages.
Sources: composer.json119-168 README.md36-40
To install specific components independently:
Each component exists as a separate package on Packagist and can be required individually. The component's dependencies are resolved automatically through its own composer.json file (e.g., src/sentry/composer.json24-47).
Sources: README.md42-55
Sources: composer.json119-168 composer.json171-237 README.md36-63
All components use Hyperf's ConfigProvider pattern for automatic registration. The registration process occurs during Hyperf's bootstrap phase.
Each component declares its ConfigProvider class in composer.json256-302 For example:
FriendsOfHyperf\Sentry\ConfigProvider at line 294FriendsOfHyperf\Cache\ConfigProvider at line 260FriendsOfHyperf\Helpers\ConfigProvider at line 273The ConfigProvider class returns an array defining:
dependencies: DI container bindingslisteners: Event listener registrationscommands: Console command classesaspects: AOP aspect classespublish: Configuration files to publishSources: composer.json256-302 src/sentry/composer.json60-67
Components are organized under PSR-4 namespaces mapped to their source directories:
| Namespace | Directory | Example Class |
|---|---|---|
FriendsOfHyperf\Sentry\ | src/sentry/src/ | FriendsOfHyperf\Sentry\Tracer |
FriendsOfHyperf\Cache\ | src/cache/src/ | FriendsOfHyperf\Cache\Repository |
FriendsOfHyperf\Helpers\ | src/helpers/src/ | FriendsOfHyperf\Helpers\Functions |
FriendsOfHyperf\Http\Client\ | src/http-client/src/ | FriendsOfHyperf\Http\Client\PendingRequest |
| ... | ... | ... |
The complete mapping is defined in composer.json171-221
Additionally, several components provide global function files that are auto-loaded via the files directive in composer.json222-237:
src/helpers/src/Functions.php - Global helper functionssrc/sentry/src/Function.php - Sentry helper functionssrc/encryption/src/Functions.php - Encryption helpersSources: composer.json171-237
Some components require configuration files to be published to your application's config/autoload/ directory.
Not all components require explicit configuration publishing. Components that typically need configuration include:
| Component | Configuration File | Key Settings |
|---|---|---|
sentry | config/autoload/sentry.php | DSN, tracing options, feature flags |
telescope | config/autoload/telescope.php | Storage driver, record mode, watchers |
trigger | config/autoload/trigger.php | MySQL binlog connection, consumers |
cache | config/autoload/cache.php | Driver configuration, default store |
lock | config/autoload/lock.php | Lock driver, connection pools |
mail | config/autoload/mail.php | SMTP configuration, from address |
Components like helpers, macros, and support work immediately after installation without additional configuration.
Sources: README.md59-63
After installation, verify that component classes are autoloadable:
Check that ConfigProviders are registered by examining Hyperf's provider collection:
If friendsofhyperf/helpers is installed, test global functions:
The helper functions are defined in src/helpers/src/Functions.php and auto-loaded via composer.json228
Sources: composer.json222-237 src/helpers/src/Functions.php
Some components have dependencies on other components or Hyperf packages. These are resolved automatically by Composer.
These components provide base functionality used by others:
| Component | Purpose | Dependents |
|---|---|---|
support | Base utilities, Collection, Arr, Str classes | Most components |
macros | RequestInterface extensions | helpers |
The Sentry component requires several packages as defined in src/sentry/composer.json24-37:
And suggests optional dependencies in src/sentry/composer.json39-46:
Sources: src/sentry/composer.json24-47
For development and testing, the monorepo includes test infrastructure configuration.
Development dependencies are defined in composer.json44-117 and include:
pestphp/pest - Testing frameworkmockery/mockery - Mocking librarypestphp/pest-plugin-faker - Fake data generationTest setup is centralized in tests/Pest.php1-98 which:
TestCase class for all testscache, sentry, helpers)faker() and test_property()Example test group registration from tests/Pest.php19-37:
Sources: composer.json44-117 tests/Pest.php1-98
Symptom: Installation fails with "ext-openssl is missing"
Solution: Install required PHP extensions listed in composer.json18:
Symptom: Dependency resolution fails with version conflicts
Solution: Ensure Hyperf version >= 3.1.0 is installed. Check your composer.json constraints.
Symptom: Component features not available after installation
Solution:
rm -rf runtime/container/ConfigProvider is listed in composer.json extra sectionSources: composer.json16-18 composer.json256-302
Refresh this wiki