API Reference

This page provides comprehensive method-level documentation for the Hypervel Container public APIs. It covers method signatures, parameters, return types, and usage patterns for the Container class and BoundMethod utility.

For conceptual information about container operations, see Container System. For details on service binding patterns, see Service Binding. For resolution pipeline mechanics, see Dependency Resolution.

---

Container Class Overview

The Container class is the primary entry point for dependency injection operations. It extends Hyperf's base container and implements both the Hypervel Container contract and PHP's ArrayAccess interface.

Sources: src/Container.php17 src/Contracts/Container.php13

---

Resolution Methods

Methods for retrieving and resolving dependencies from the container.

make()

Resolves a service from the container with factory behavior. Creates a new instance on each call, even for singletons.

Signature:

Parameter	Type	Description
$name	string	Service name, class name, or alias
$parameters	array	Optional parameters for construction

Returns: Resolved service instance

Throws: Hyperf\Di\Exception\NotFoundException if service not found

Sources: src/Container.php109-132

---

get()

PSR-11 compliant method for retrieving services. Respects singleton bindings and caches instances.

Signature:

Parameter	Type	Description
$id	string	Identifier of the entry to retrieve

Returns: Entry from the container

Sources: src/Container.php139-146 src/Contracts/Container.php33

---

has()

Checks if the container can return an entry for the given identifier. Returns true for bound services and registered aliases.

Signature:

Parameter	Type	Description
$id	mixed|string	Identifier to check

Returns: true if entry exists, false otherwise

Sources: src/Container.php211-214 src/Contracts/Container.php26-33

---

bound()

Determines if the given abstract type has been bound in the container.

Signature:

Parameter	Type	Description
$abstract	string	Abstract type or service name

Returns: true if bound, false otherwise

Sources: src/Container.php194-201 src/Contracts/Container.php23

---

resolved()

Checks if the given abstract type has already been resolved and cached.

Signature:

Parameter	Type	Description
$abstract	string	Abstract type to check

Returns: true if resolved, false otherwise

Sources: src/Container.php219-226 src/Contracts/Container.php38

---

set()

Binds an arbitrary resolved entry to an identifier. Primarily used for testing.

Signature:

Parameter	Type	Description
$name	string	Service identifier
$entry	mixed	Entry to bind

Sources: src/Container.php153-160

---

unbind()

Removes a resolved entry from the instance cache.

Signature:

Parameter	Type	Description
$name	string	Service to unbind

Sources: src/Container.php165-172 src/Contracts/Container.php18

---

remove()

Completely removes a binding, including its definition and resolved instances.

Signature:

Parameter	Type	Description
$name	string	Service to remove

Sources: src/Container.php178-189

---

Binding Methods

Methods for registering services and their implementations.

Sources: src/Container.php243-349

---

bind()

Registers a binding with the container. If no concrete implementation is provided, the abstract name is used.

Signature:

Parameter	Type	Description
$abstract	string	Service interface or abstract name
$concrete	null|Closure|string	Implementation, closure, or null for self-binding

Throws: TypeError if concrete type is invalid

Sources: src/Container.php243-259 src/Contracts/Container.php46-52

---

bindIf()

Registers a binding only if it hasn't already been registered.

Signature:

Parameter	Type	Description
$abstract	string	Service interface or abstract name
$concrete	null|Closure|string	Implementation or null

Sources: src/Container.php302-307 src/Contracts/Container.php70-74

---

instance()

Registers an existing instance as a shared singleton in the container.

Signature:

Parameter	Type	Description
$abstract	string	Service name
$instance	mixed	Pre-constructed instance

Returns: The registered instance

Sources: src/Container.php329-349 src/Contracts/Container.php86

---

Alias Methods

Methods for managing service aliases (alternate names for the same service).

alias()

Creates an alias for a service, allowing it to be resolved by multiple names.

Signature:

Parameter	Type	Description
$abstract	string	Original service name
$alias	string	Alternate name

Throws: LogicException if attempting to alias to itself

Sources: src/Container.php374-383 src/Contracts/Container.php89-93

---

isAlias()

Checks if a given name is an alias.

Signature:

Parameter	Type	Description
$name	string	Name to check

Returns: true if the name is an alias

Sources: src/Container.php231-234 src/Contracts/Container.php43

---

getAlias()

Recursively resolves an alias to its underlying abstract name.

Signature:

Parameter	Type	Description
$abstract	string	Name or alias to resolve

Returns: The underlying abstract name

Sources: src/Container.php622-627 src/Contracts/Container.php158

---

Method Binding

Special binding system for controlling how specific methods are invoked.

Sources: src/Container.php264-295

---

bindMethod()

Binds a callback to be used when resolving a specific method via Container::call().

Signature:

Parameter	Type	Description
$method	array|string	Method in Class@method format or [Class, method] array
$callback	Closure	Callback receiving ($instance, $container)

Sources: src/Container.php272-275 src/Contracts/Container.php62

---

hasMethodBinding()

Checks if a method binding exists for the given method.

Signature:

Parameter	Type	Description
$method	string	Method in Class@method format

Returns: true if binding exists

Sources: src/Container.php264-267 src/Contracts/Container.php57

---

callMethodBinding()

Invokes a registered method binding.

Signature:

Parameter	Type	Description
$method	string	Method identifier
$instance	mixed	Instance to pass to callback

Returns: Result of the bound callback

Sources: src/Container.php292-295 src/Contracts/Container.php67

---

Lifecycle Callbacks

Registration methods for hooking into the resolution lifecycle.

Callback Types and Execution Order

Sources: src/Container.php467-578

---

beforeResolving()

Registers a callback to execute before a service is resolved.

Signature:

Parameter	Type	Description
$abstract	Closure|string	Service type or global closure
$callback	?Closure	Callback receiving ($abstract, $parameters, $container)

Callback Signature: function(string $abstract, array $parameters, Container $container): void

Sources: src/Container.php467-478 src/Contracts/Container.php130-134

---

resolving()

Registers a callback to execute during service resolution, after instance creation but during the resolution phase.

Signature:

Parameter	Type	Description
$abstract	Closure|string	Service type or global closure
$callback	?Closure	Callback receiving ($instance, $container)

Callback Signature: function(mixed $instance, Container $container): void

Sources: src/Container.php485-496 src/Contracts/Container.php136-141

---

afterResolving()

Registers a callback to execute after a service has been fully resolved.

Signature:

Parameter	Type	Description
$abstract	Closure|string	Service type or global closure
$callback	?Closure	Callback receiving ($instance, $container)

Callback Signature: function(mixed $instance, Container $container): void

Sources: src/Container.php503-514 src/Contracts/Container.php143-148

---

Extenders and Decorators

extend()

Extends a service by wrapping it with additional functionality. Applies to future resolutions and immediately to already-resolved instances.

Signature:

Parameter	Type	Description
$abstract	string	Service to extend
$closure	Closure	Decorator receiving ($instance, $container)

Throws: InvalidArgumentException if service type is invalid

Sources: src/Container.php314-324 src/Contracts/Container.php77-81

---

forgetExtenders()

Removes all extender callbacks for a given service type.

Signature:

Parameter	Type	Description
$abstract	string	Service to clear extenders for

Sources: src/Container.php640-643 src/Contracts/Container.php163

---

Rebinding and Refresh

Methods for managing service lifecycle when bindings change.

rebinding()

Registers a callback to execute when a service is rebound (re-registered).

Signature:

Parameter	Type	Description
$abstract	string	Service to watch
$callback	Closure	Callback receiving ($container, $instance)

Returns: Current instance if already bound, null otherwise

Sources: src/Container.php388-397 src/Contracts/Container.php98

---

refresh()

Convenience method to refresh a specific property when a service is rebound.

Signature:

Parameter	Type	Description
$abstract	string	Service to watch
$target	mixed	Object to update
$method	string	Method to call on rebind

Returns: Result of rebinding()

Sources: src/Container.php402-407 src/Contracts/Container.php103

---

Invocation Methods

Methods for calling functions and methods with automatic dependency injection.

Sources: src/BoundMethod.php25-74

---

call()

Invokes a callable with automatic dependency injection for its parameters.

Signature:

Parameter	Type	Description
$callback	callable|string	Callable, closure, or Class@method string
$parameters	array	Optional parameters to override dependency resolution
$defaultMethod	?string	Default method name if not specified

Returns: Result of the invoked callable

Throws: BindingResolutionException if callable is invalid or dependencies cannot be resolved

Supported Callback Formats:

• Closure: function($dep1, $dep2) { ... }
• Class@method: "App\\Service@handle"
• Array: [$instance, 'method'] or [ClassName::class, 'method']
• Static: "ClassName::method"
• Invokable: $objectWithInvokeMethod

Sources: src/Container.php437-440 src/Contracts/Container.php106-113

---

factory()

Returns a closure that resolves the given service when invoked.

Signature:

Parameter	Type	Description
$abstract	string	Service to create factory for

Returns: Closure that returns resolved instance

Sources: src/Container.php445-448 src/Contracts/Container.php118

---

makeWith()

Alias for make() with a different name for compatibility.

Signature:

Parameter	Type	Description
$abstract	callable|string	Service to resolve
$parameters	array	Construction parameters

Returns: Resolved instance

Throws: Hyperf\Di\Exception\NotFoundException if not found

Sources: src/Container.php457-460 src/Contracts/Container.php121-127

---

Instance Management

Methods for managing resolved instances and clearing caches.

Method	Purpose	Scope
forgetInstance(string)	Remove specific instance from cache	Single service
forgetInstances()	Clear all resolved instances	All instances
flush()	Clear instances, aliases, and abstract aliases	Complete reset

forgetInstance()

Removes a specific resolved instance from the cache.

Signature:

Sources: src/Container.php656-659 src/Contracts/Container.php168

---

forgetInstances()

Clears all resolved instances from the cache.

Signature:

Sources: src/Container.php664-667 src/Contracts/Container.php173

---

flush()

Completely flushes the container, removing all aliases and resolved instances.

Signature:

Sources: src/Container.php672-677 src/Contracts/Container.php178

---

Container Information

Methods for introspecting container state.

getBindings()

Returns all registered service bindings.

Signature:

Returns: Array of all definitions from the definition source

Sources: src/Container.php614-617 src/Contracts/Container.php153

---

Static Container Access

Methods for managing the global container instance.

getInstance()

Retrieves the globally available container instance. Creates one if it doesn't exist.

Signature:

Returns: The global container instance

Sources: src/Container.php682-692 src/Contracts/Container.php183

---

setInstance()

Sets the shared global container instance.

Signature:

Parameter	Type	Description
$container	ContainerContract	Container to set as global

Returns: The container that was set

Sources: src/Container.php697-701 src/Contracts/Container.php188

---

ArrayAccess Implementation

The container implements ArrayAccess, allowing array-style access to services.

Sources: src/Container.php703-738

Array Syntax Examples

Operation	Method Called	Equivalent
isset($container['service'])	offsetExists() → bound()	$container->bound('service')
$service = $container['service']	offsetGet() → get()	$container->get('service')
$container['service'] = $impl	offsetSet() → define()	$container->define('service', $impl)
unset($container['service'])	offsetUnset() → remove()	$container->remove('service')

---

BoundMethod Class

Static utility class for invoking callables with automatic dependency injection.

Sources: src/BoundMethod.php15-222

---

BoundMethod::call()

Primary static method for invoking callables with dependency injection.

Signature:

Parameter	Type	Description
$container	ContainerContract	Container for dependency resolution
$callback	callable|string	Callable to invoke
$parameters	array	Override parameters
$defaultMethod	?string	Default method if not specified

Returns: Result of the invoked callable

Throws:

• ReflectionException if reflection fails
• BindingResolutionException if dependencies cannot be resolved

Parameter Resolution Priority:

1. Explicitly provided in $parameters by parameter name
2. Explicitly provided by parameter position
3. Explicitly provided by type name
4. Parameter default value if available
5. Resolved from container by type
6. null if parameter allows null
7. Exception if required parameter cannot be resolved

Sources: src/BoundMethod.php25-74

---

Dependency Resolution in BoundMethod

Sources: src/BoundMethod.php76-115

---

Code Entity Map

This table maps high-level concepts to specific code entities for easy reference.

Concept	Primary Class	Key Methods	File Reference
Service Resolution	Container	make(), get(), has()	src/Container.php109-214
Service Registration	Container	bind(), bindIf(), instance()	src/Container.php243-349
Aliasing	Container	alias(), isAlias(), getAlias()	src/Container.php231-383
Method Binding	Container	bindMethod(), hasMethodBinding(), callMethodBinding()	src/Container.php264-295
Lifecycle Hooks	Container	beforeResolving(), resolving(), afterResolving()	src/Container.php467-514
Service Decoration	Container	extend(), forgetExtenders()	src/Container.php314-324 src/Container.php640-643
Rebinding	Container	rebinding(), refresh()	src/Container.php388-419
Method Invocation	Container, BoundMethod	call(), BoundMethod::call()	src/Container.php437-440 src/BoundMethod.php25-74
Factory Pattern	Container	factory(), makeWith()	src/Container.php445-460
Cache Management	Container	forgetInstance(), forgetInstances(), flush()	src/Container.php656-677
Global Access	Container	getInstance(), setInstance()	src/Container.php682-701
Array Access	Container	offsetExists(), offsetGet(), offsetSet(), offsetUnset()	src/Container.php703-721
Interface Contract	ContainerContract	All interface methods	src/Contracts/Container.php13-189
Parameter Resolution	BoundMethod	getDependencyParameters(), getMethodDependencies(), getClosureDependencies()	src/BoundMethod.php76-211

Sources: src/Container.php src/Contracts/Container.php src/BoundMethod.php