Skip to content

CHANGELOG.md

Latest commit

 

History

History
398 lines (288 loc) · 15.1 KB

CHANGELOG.md

File metadata and controls

398 lines (288 loc) · 15.1 KB

Changelog

All Notable changes to League\Container will be documented in this file

Unreleased (6.0.0)

Added

  • Container compilation - compile a bootstrapped container into a standalone PHP class implementing PSR-11 ContainerInterface, eliminating reflection and definition resolution at runtime (#279)
    • Compiler entry point with compile() and isStale() methods
    • DefinitionAnalyser for inspecting definitions, classifying types, resolving autowiring, and building the dependency graph
    • CodeGenerator for producing compiled PHP source via string templating (zero new dependencies)
    • ArgumentCompiler for converting argument descriptors to PHP code expressions
    • DependencyGraph with cycle detection (DFS with visited/in-stack colouring) and topological ordering
    • Value objects: CompiledDefinition, CompilationConfig, CompilationResult, AnalysisResult, ConcreteType enum
    • CompilationException with structured errors (service ID, error type, message, suggested fix)
    • ContainerFactory for switching between compiled and dynamic containers based on environment
    • bin/container-compile CLI binary with --input, --output, --class, --namespace, --check, --dry-run options
    • ServiceProviderAggregateInterface::registerAll() for force-registering all lazy providers before compilation
    • Pre-flight validation collecting all errors before failing, with actionable suggested fixes
    • SHA-256 source hash for staleness detection based on normalised definition state
  • Contextual binding - bind different implementations of an interface depending on the consuming class
    • DefinitionInterface::addContextualArgument(string $abstract, string|object $concrete) for per-definition contextual resolution
    • DefinitionInterface::getContextualArguments() to retrieve stored bindings
    • Runtime resolution via Definition::resolveClass() with constructor reflection
    • Full compilation support: contextual arguments resolved at compile time into direct service references
  • Improved error messages with runtime circular dependency detection
    • NotFoundException::forAlias() with Levenshtein-based "did you mean?" suggestions for mistyped service IDs
    • Runtime circular dependency detection via resolution stack in Container::resolve() with descriptive chain messages
    • Resolution chain context in nested dependency failure messages
    • Service provider class identification in "service provider lied" errors
  • Container introspection for debugging
    • Container::getDefinitionIds() returns all registered service IDs
    • Container::getServiceProviderIds() returns all IDs claimed by providers (lazy or registered)
    • ServiceProviderInterface::getProvidedIds() for providers to declare their full service list
    • --dump flag on bin/container-compile for service summary output
  • #[Shared] attribute - class-level attribute declaring singleton intent for auto-wired classes via ReflectionContainer, with compilation support
  • PHP 8.5 support (first-class CI target)
  • Typed class constants throughout (ReflectionContainer, LiteralArgument, DependencyGraph)
  • #[\Override] attribute on all interface implementations and trait methods
  • readonly class declarations for compiler value objects (CompilationConfig, CompilationResult, CompiledDefinition)
  • Pest v4 arch tests enforcing strict types, final compiler classes, and exception hierarchy
  • Granular Composer scripts: test:unit, test:types, test:style

Changed

  • PHP minimum version raised from ^8.1 to ^8.3
  • Testing framework migrated from PHPUnit to Pest v4
  • Test mocking framework migrated from PHPUnit mocks to Mockery, with explicit stub/expectation separation (allows vs shouldReceive)
  • Coding standard migrated from PHP CodeSniffer (PSR-12) to PHP CS Fixer (PER-CS 2.0)
  • PHPStan analysis level raised from 6 to 8 with all blanket suppressions removed
  • ContainerAwareInterface::setContainer() now returns static instead of ContainerAwareInterface
  • Container::get() and ReflectionContainer::get() now declare : mixed return type (PSR-11 v2 alignment)
  • LiteralArgument now throws with actionable error messages including expected and actual types
  • get_class() calls replaced with ::class syntax throughout
  • call_user_func_array calls replaced with spread syntax
  • psr/container-implementation provide version corrected from ^1.0 to ^2.0

Fixed

  • Removed ContainerAwareTrait test that was incompatible with #[\Override] enforcement in PHP 8.3+
  • Test mocking of DefinitionInterface and Reflection classes now explicitly stubs all called methods, preventing silent pass-through on unmocked interactions

Removed

  • Inflector subsystem (Inflector, InflectorAggregate, InflectorAggregateInterface, InflectorInterface) - use Container::afterResolve() or the event system instead
  • Container::inflector() method (deprecated in 5.2)
  • inflector() from DefinitionContainerInterface
  • Definition::$recursiveCheck (dead code, written but never read)
  • Scrutinizer CI integration (.scrutinizer.yml, scrutinizer/ocular)
  • orno/di replace directive from composer.json
  • Unused dev dependencies: nette/php-generator, nikic/php-parser
  • Stale branch aliases for 1.x through 4.x

5.2.0

Added

  • Event system for hooking into the container lifecycle
    • Four event types: OnDefineEvent, BeforeResolveEvent, DefinitionResolvedEvent, ServiceResolvedEvent
    • Fluent filtering API: forType(), forTag(), forId(), where()
    • Container::listen() for registering filtered event listeners
    • Container::afterResolve() convenience method as a drop-in replacement for inflector()
    • Lazy event dispatch: events are only created when listeners are registered for that event type
    • EventDispatcher::hasListenersFor() to check whether listeners exist for a given event type
    • DefinitionInterface::getTags() for retrieving tags from definitions
    • Docs: https://container.thephpleague.com/5.x/events/
  • Container::getDelegate(string $class) to retrieve a registered delegate container by type

Fixed

  • Interface-to-concrete definitions now correctly resolve through the concrete's own registered definition instead of bypassing it via direct reflection (#275, #278)
  • Definition::resolveClass() now throws ContainerException with actionable guidance when a class has unsatisfied constructor dependencies, instead of a raw ArgumentCountError

Deprecated

  • Container::inflector() - use Container::afterResolve() or the event system instead. Will be removed in v6.0.

Changed

  • DefinitionContainerInterface no longer extends EventAwareContainerInterface (removed)
  • Shared definitions now receive a 'shared' tag automatically via addTag('shared')

Removed

  • EventAwareContainerInterface - the event system is provided by EventAwareTrait on the concrete Container class, not as an interface contract

5.1.0

Added

Changed

  • Small internal changes for stricter static analysis and type safety. (@ADmad)

5.0.1

Fixed

  • Fixed a small unreachable code bug

5.0.0

Added

  • Ability to overwrite a definition within the container, disabled by default

Changed

  • PHP requirement now >=8.1
  • General language modernisation
  • General prep for future updates and container compilation

4.2.4

Fixed

  • Now properly handle string based fully qualified class names in with preceding slashes. (@M1ke)

4.2.3

Fixed

  • Warnings for PHP 8.4 implicit nullable types (@andypost)

4.2.1

Fixed

  • Remove an unnecessary conditional in ServiceProviderAggregate. (@SubhanSh)
  • Fixed an infinite loop in resolving definitions. (@arai-ta)

4.2.0

Added

  • Support for psr/container 1.1.0.

4.1.2

Fixed

  • Fix bug that was causing an error on inflection due to introduced type hint.

4.1.1

Changed

  • Move files autoload directive to dev (@ADmad)

4.1.0

Added

  • Way to handle non-public controllers safely (@beryllium)

4.0.0

Added

  • New definition interface that extends psr/container
  • Literal and resolvable argument wrappers for better explicitness in definitions

Changed

  • PHP requirement now >=7.2
  • Updated psr/container to ^2.0.0
  • Container::shared convenience method is now explicit Container::addShared method
  • Removed third argument $shared from Container::add, use Container::addShared
  • ServiceProviderInterface now defines return types
  • Service providers now require implementation of a provides method rather than relying on a class property.

3.4.1

Added

  • Way to handle non-public controllers safely (@beryllium)
  • PHPUnit ^7.0 for PHP versions that support it (@beryllium)

3.4.0

Removed

  • Support for psr/container ^2.0.0 as the interface cannot be reconciled between versions

3.3.5

Added

  • Support for psr/container ^2.0.0

3.3.4

Fixed

  • Fixed an issue that caused a recursive register call. @pcoutinho
  • Fixed a return type declaration. @orbex

3.3.3

Fixed

  • Fixed bug relating to ReflectionContainer::call on arrow functions.

3.3.2

Added

  • Experimental support for PHP 8.

Fixed

  • Fix issue when preventing reflection from using default value for arguments.

3.3.1

Fixed

  • Respect $new argument when getting tagged definitions.

3.3.0

Added

  • Support for PHP 7.3
  • {set,get}LeagueContainer methods added to ContainerAwareTrait as a temporary measure until next major release when this can be properly addressed, less hinting of Psr\Container\ContainerInterface

Changed

  • Various internal code improvements

Fixed

  • Fix for setConcrete not re-resolving class on when overriding (@jleeothon)
  • Fix stack overflow error incase a service provider lies about providing a specific service (@azjezz)
  • Fix issue where providers may be aggregated multiple times (@bwg)
  • Various documentation fixes

3.2.2

Fixed

  • Fixed issue that prevented service providers from registering if a previous one in the aggregate was already registered.

3.2.1

Fixed

  • Fixed issue where all service providers were registered regardless of whether they need to be.

3.2.0

Added

  • Added ability to add definition as not shared when container is set to default to shared.
  • Added {set|get}Concrete to definitions to allow for better use of extend.

3.1.0

Added

  • Re-added the share proxy method that was mistakenly removed in previous major release.
  • Added ability to set Container to "share" by default using defaultToShared method.
  • Added ability for ReflectionContainer to cache resolutions and pull from cache for following calls.

3.0.1

Added

  • Allow definition aggregates to be built outside of container.

3.0.0

Added

  • Service providers can now be pulled from the container if they are registered.
  • Definition logic now handled by aggregate for better separation.
  • Now able to add tags to a definition to return an array of items containing that tag.

Changed

  • Updated minimum PHP requirements to 7.0.
  • Now depend directly on PSR-11 interfaces, including providing PSR-11 exceptions.
  • Refactored inflector logic to accept type on construction and use generator to iterate.
  • Refactored service provider logic with better separation and performance.
  • Merged service provider signature logic in to one interface and abstract.
  • Heavily simplified definition logic providing more control to user.

2.4.1

Fixed

  • Ensures ReflectionContainer converts class name in array callable to object.

2.4.0

Changed

  • Can now wrap shared objects as RawArgument.
  • Ability to override shared items.

Fixed

  • Booleans now recognised as accepted values.
  • Various docblock fixes.
  • Unused imports removed.
  • Unreachable arguments no longer passed.

2.3.0

Added

  • Now implementation of the PSR-11.

2.2.0

Changed

  • Service providers can now be added multiple times by giving them a signature.

2.1.0

Added

  • Allow resolving of RawArgument objects as first class dependencies.

Changed

  • Unnecessary recursion removed from Container::get.

2.0.3

Fixed

  • Bug where delegating container was not passed to delegate when needed.
  • Bug where Container::extend would not return a shared definition to extend.

2.0.2

Fixed

  • Bug introduced in 2.0.1 where shared definitions registered via a service provider would never be returned as shared.

2.0.1

Fixed

  • Bug where shared definitions were not stored as shared.

2.0.0

Added

  • Now implementation of the container-interop project.
  • BootableServiceProviderInterface for eagerly loaded service providers.
  • Delegate container functionality.
  • RawArgument to ensure scalars are not resolved from the container but seen as an argument.

Altered

  • Refactor of definition functionality.
  • Container::share replaces singleton functionality to improve understanding.
  • Auto wiring is now disabled by default.
  • Auto wiring abstracted to be a delegate container ReflectionContainer handling all reflection based functionality.
  • Inflection functionality abstracted to an aggregate.
  • Service provider functionality abstracted to an aggregate.
  • Much bloat removed.
  • Container::call now proxies to ReflectionContainer::call and handles argument resolution in a much more efficient way.

Removed

  • Ability to register invokables, this functionality added a layer of complexity too large for the problem it solved.
  • Container no longer accepts a configuration array, this functionality will now be provided by an external service provider package.

1.4.0

Added

  • Added isRegisteredCallable method to public API.
  • Invoking call now accepts named arguments at runtime.

Fixed

  • Container now stores instantiated Service Providers after first instantiation.
  • Extending a definition now looks in Service Providers as well as just Definitions.

1.3.1 - 2015-02-21

Fixed

  • Fixed bug where arbitrary values were attempted to be resolved as classes.

1.3.0 - 2015-02-09

Added

  • Added ServiceProvider functionality to allow cleaner resolving of complex dependencies.
  • Added Inflector functionality to allow for manipulation of resolved objects of a specific type.
  • Improvements to DRY throughout the package.

Fixed

  • Setter in ContainerAwareTrait now returns self ($this).

1.2.1 - 2015-01-29

Fixed

  • Allow arbitrary values to be registered via container config.

1.2.0 - 2015-01-13

Added

  • Improvements to Container::call functionality.

Fixed

  • General code tidy.
  • Improvements to test suite.

1.1.1 - 2015-01-13

Fixed

  • Allow singleton to be passed as method argument.

1.1.0 - 2015-01-12

Added

  • Addition of ContainerAwareTrait to provide functionality from ContainerAwareInterface.

1.0.0 - 2015-01-12

Added