| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618 |
- <?php
- namespace Illuminate\Container;
- use ArrayAccess;
- use Closure;
- use Exception;
- use Illuminate\Contracts\Container\BindingResolutionException;
- use Illuminate\Contracts\Container\CircularDependencyException;
- use Illuminate\Contracts\Container\Container as ContainerContract;
- use Illuminate\Contracts\Container\ContextualAttribute;
- use LogicException;
- use ReflectionAttribute;
- use ReflectionClass;
- use ReflectionException;
- use ReflectionFunction;
- use ReflectionParameter;
- use TypeError;
- class Container implements ArrayAccess, ContainerContract
- {
- /**
- * The current globally available container (if any).
- *
- * @var static
- */
- protected static $instance;
- /**
- * An array of the types that have been resolved.
- *
- * @var bool[]
- */
- protected $resolved = [];
- /**
- * The container's bindings.
- *
- * @var array[]
- */
- protected $bindings = [];
- /**
- * The container's method bindings.
- *
- * @var \Closure[]
- */
- protected $methodBindings = [];
- /**
- * The container's shared instances.
- *
- * @var object[]
- */
- protected $instances = [];
- /**
- * The container's scoped instances.
- *
- * @var array
- */
- protected $scopedInstances = [];
- /**
- * The registered type aliases.
- *
- * @var string[]
- */
- protected $aliases = [];
- /**
- * The registered aliases keyed by the abstract name.
- *
- * @var array[]
- */
- protected $abstractAliases = [];
- /**
- * The extension closures for services.
- *
- * @var array[]
- */
- protected $extenders = [];
- /**
- * All of the registered tags.
- *
- * @var array[]
- */
- protected $tags = [];
- /**
- * The stack of concretions currently being built.
- *
- * @var array[]
- */
- protected $buildStack = [];
- /**
- * The parameter override stack.
- *
- * @var array[]
- */
- protected $with = [];
- /**
- * The contextual binding map.
- *
- * @var array[]
- */
- public $contextual = [];
- /**
- * The contextual attribute handlers.
- *
- * @var array[]
- */
- public $contextualAttributes = [];
- /**
- * All of the registered rebound callbacks.
- *
- * @var array[]
- */
- protected $reboundCallbacks = [];
- /**
- * All of the global before resolving callbacks.
- *
- * @var \Closure[]
- */
- protected $globalBeforeResolvingCallbacks = [];
- /**
- * All of the global resolving callbacks.
- *
- * @var \Closure[]
- */
- protected $globalResolvingCallbacks = [];
- /**
- * All of the global after resolving callbacks.
- *
- * @var \Closure[]
- */
- protected $globalAfterResolvingCallbacks = [];
- /**
- * All of the before resolving callbacks by class type.
- *
- * @var array[]
- */
- protected $beforeResolvingCallbacks = [];
- /**
- * All of the resolving callbacks by class type.
- *
- * @var array[]
- */
- protected $resolvingCallbacks = [];
- /**
- * All of the after resolving callbacks by class type.
- *
- * @var array[]
- */
- protected $afterResolvingCallbacks = [];
- /**
- * All of the after resolving attribute callbacks by class type.
- *
- * @var array[]
- */
- protected $afterResolvingAttributeCallbacks = [];
- /**
- * Define a contextual binding.
- *
- * @param array|string $concrete
- * @return \Illuminate\Contracts\Container\ContextualBindingBuilder
- */
- public function when($concrete)
- {
- $aliases = [];
- foreach (Util::arrayWrap($concrete) as $c) {
- $aliases[] = $this->getAlias($c);
- }
- return new ContextualBindingBuilder($this, $aliases);
- }
- /**
- * Define a contextual binding based on an attribute.
- *
- * @param string $attribute
- * @param \Closure $handler
- * @return void
- */
- public function whenHasAttribute(string $attribute, Closure $handler)
- {
- $this->contextualAttributes[$attribute] = $handler;
- }
- /**
- * Determine if the given abstract type has been bound.
- *
- * @param string $abstract
- * @return bool
- */
- public function bound($abstract)
- {
- return isset($this->bindings[$abstract]) ||
- isset($this->instances[$abstract]) ||
- $this->isAlias($abstract);
- }
- /**
- * {@inheritdoc}
- *
- * @return bool
- */
- public function has(string $id): bool
- {
- return $this->bound($id);
- }
- /**
- * Determine if the given abstract type has been resolved.
- *
- * @param string $abstract
- * @return bool
- */
- public function resolved($abstract)
- {
- if ($this->isAlias($abstract)) {
- $abstract = $this->getAlias($abstract);
- }
- return isset($this->resolved[$abstract]) ||
- isset($this->instances[$abstract]);
- }
- /**
- * Determine if a given type is shared.
- *
- * @param string $abstract
- * @return bool
- */
- public function isShared($abstract)
- {
- return isset($this->instances[$abstract]) ||
- (isset($this->bindings[$abstract]['shared']) &&
- $this->bindings[$abstract]['shared'] === true);
- }
- /**
- * Determine if a given string is an alias.
- *
- * @param string $name
- * @return bool
- */
- public function isAlias($name)
- {
- return isset($this->aliases[$name]);
- }
- /**
- * Register a binding with the container.
- *
- * @param string $abstract
- * @param \Closure|string|null $concrete
- * @param bool $shared
- * @return void
- *
- * @throws \TypeError
- */
- public function bind($abstract, $concrete = null, $shared = false)
- {
- $this->dropStaleInstances($abstract);
- // If no concrete type was given, we will simply set the concrete type to the
- // abstract type. After that, the concrete type to be registered as shared
- // without being forced to state their classes in both of the parameters.
- if (is_null($concrete)) {
- $concrete = $abstract;
- }
- // If the factory is not a Closure, it means it is just a class name which is
- // bound into this container to the abstract type and we will just wrap it
- // up inside its own Closure to give us more convenience when extending.
- if (! $concrete instanceof Closure) {
- if (! is_string($concrete)) {
- throw new TypeError(self::class.'::bind(): Argument #2 ($concrete) must be of type Closure|string|null');
- }
- $concrete = $this->getClosure($abstract, $concrete);
- }
- $this->bindings[$abstract] = compact('concrete', 'shared');
- // If the abstract type was already resolved in this container we'll fire the
- // rebound listener so that any objects which have already gotten resolved
- // can have their copy of the object updated via the listener callbacks.
- if ($this->resolved($abstract)) {
- $this->rebound($abstract);
- }
- }
- /**
- * Get the Closure to be used when building a type.
- *
- * @param string $abstract
- * @param string $concrete
- * @return \Closure
- */
- protected function getClosure($abstract, $concrete)
- {
- return function ($container, $parameters = []) use ($abstract, $concrete) {
- if ($abstract == $concrete) {
- return $container->build($concrete);
- }
- return $container->resolve(
- $concrete, $parameters, $raiseEvents = false
- );
- };
- }
- /**
- * Determine if the container has a method binding.
- *
- * @param string $method
- * @return bool
- */
- public function hasMethodBinding($method)
- {
- return isset($this->methodBindings[$method]);
- }
- /**
- * Bind a callback to resolve with Container::call.
- *
- * @param array|string $method
- * @param \Closure $callback
- * @return void
- */
- public function bindMethod($method, $callback)
- {
- $this->methodBindings[$this->parseBindMethod($method)] = $callback;
- }
- /**
- * Get the method to be bound in class@method format.
- *
- * @param array|string $method
- * @return string
- */
- protected function parseBindMethod($method)
- {
- if (is_array($method)) {
- return $method[0].'@'.$method[1];
- }
- return $method;
- }
- /**
- * Get the method binding for the given method.
- *
- * @param string $method
- * @param mixed $instance
- * @return mixed
- */
- public function callMethodBinding($method, $instance)
- {
- return call_user_func($this->methodBindings[$method], $instance, $this);
- }
- /**
- * Add a contextual binding to the container.
- *
- * @param string $concrete
- * @param string $abstract
- * @param \Closure|string $implementation
- * @return void
- */
- public function addContextualBinding($concrete, $abstract, $implementation)
- {
- $this->contextual[$concrete][$this->getAlias($abstract)] = $implementation;
- }
- /**
- * Register a binding if it hasn't already been registered.
- *
- * @param string $abstract
- * @param \Closure|string|null $concrete
- * @param bool $shared
- * @return void
- */
- public function bindIf($abstract, $concrete = null, $shared = false)
- {
- if (! $this->bound($abstract)) {
- $this->bind($abstract, $concrete, $shared);
- }
- }
- /**
- * Register a shared binding in the container.
- *
- * @param string $abstract
- * @param \Closure|string|null $concrete
- * @return void
- */
- public function singleton($abstract, $concrete = null)
- {
- $this->bind($abstract, $concrete, true);
- }
- /**
- * Register a shared binding if it hasn't already been registered.
- *
- * @param string $abstract
- * @param \Closure|string|null $concrete
- * @return void
- */
- public function singletonIf($abstract, $concrete = null)
- {
- if (! $this->bound($abstract)) {
- $this->singleton($abstract, $concrete);
- }
- }
- /**
- * Register a scoped binding in the container.
- *
- * @param string $abstract
- * @param \Closure|string|null $concrete
- * @return void
- */
- public function scoped($abstract, $concrete = null)
- {
- $this->scopedInstances[] = $abstract;
- $this->singleton($abstract, $concrete);
- }
- /**
- * Register a scoped binding if it hasn't already been registered.
- *
- * @param string $abstract
- * @param \Closure|string|null $concrete
- * @return void
- */
- public function scopedIf($abstract, $concrete = null)
- {
- if (! $this->bound($abstract)) {
- $this->scoped($abstract, $concrete);
- }
- }
- /**
- * "Extend" an abstract type in the container.
- *
- * @param string $abstract
- * @param \Closure $closure
- * @return void
- *
- * @throws \InvalidArgumentException
- */
- public function extend($abstract, Closure $closure)
- {
- $abstract = $this->getAlias($abstract);
- if (isset($this->instances[$abstract])) {
- $this->instances[$abstract] = $closure($this->instances[$abstract], $this);
- $this->rebound($abstract);
- } else {
- $this->extenders[$abstract][] = $closure;
- if ($this->resolved($abstract)) {
- $this->rebound($abstract);
- }
- }
- }
- /**
- * Register an existing instance as shared in the container.
- *
- * @param string $abstract
- * @param mixed $instance
- * @return mixed
- */
- public function instance($abstract, $instance)
- {
- $this->removeAbstractAlias($abstract);
- $isBound = $this->bound($abstract);
- unset($this->aliases[$abstract]);
- // We'll check to determine if this type has been bound before, and if it has
- // we will fire the rebound callbacks registered with the container and it
- // can be updated with consuming classes that have gotten resolved here.
- $this->instances[$abstract] = $instance;
- if ($isBound) {
- $this->rebound($abstract);
- }
- return $instance;
- }
- /**
- * Remove an alias from the contextual binding alias cache.
- *
- * @param string $searched
- * @return void
- */
- protected function removeAbstractAlias($searched)
- {
- if (! isset($this->aliases[$searched])) {
- return;
- }
- foreach ($this->abstractAliases as $abstract => $aliases) {
- foreach ($aliases as $index => $alias) {
- if ($alias == $searched) {
- unset($this->abstractAliases[$abstract][$index]);
- }
- }
- }
- }
- /**
- * Assign a set of tags to a given binding.
- *
- * @param array|string $abstracts
- * @param array|mixed ...$tags
- * @return void
- */
- public function tag($abstracts, $tags)
- {
- $tags = is_array($tags) ? $tags : array_slice(func_get_args(), 1);
- foreach ($tags as $tag) {
- if (! isset($this->tags[$tag])) {
- $this->tags[$tag] = [];
- }
- foreach ((array) $abstracts as $abstract) {
- $this->tags[$tag][] = $abstract;
- }
- }
- }
- /**
- * Resolve all of the bindings for a given tag.
- *
- * @param string $tag
- * @return iterable
- */
- public function tagged($tag)
- {
- if (! isset($this->tags[$tag])) {
- return [];
- }
- return new RewindableGenerator(function () use ($tag) {
- foreach ($this->tags[$tag] as $abstract) {
- yield $this->make($abstract);
- }
- }, count($this->tags[$tag]));
- }
- /**
- * Alias a type to a different name.
- *
- * @param string $abstract
- * @param string $alias
- * @return void
- *
- * @throws \LogicException
- */
- public function alias($abstract, $alias)
- {
- if ($alias === $abstract) {
- throw new LogicException("[{$abstract}] is aliased to itself.");
- }
- $this->aliases[$alias] = $abstract;
- $this->abstractAliases[$abstract][] = $alias;
- }
- /**
- * Bind a new callback to an abstract's rebind event.
- *
- * @param string $abstract
- * @param \Closure $callback
- * @return mixed
- */
- public function rebinding($abstract, Closure $callback)
- {
- $this->reboundCallbacks[$abstract = $this->getAlias($abstract)][] = $callback;
- if ($this->bound($abstract)) {
- return $this->make($abstract);
- }
- }
- /**
- * Refresh an instance on the given target and method.
- *
- * @param string $abstract
- * @param mixed $target
- * @param string $method
- * @return mixed
- */
- public function refresh($abstract, $target, $method)
- {
- return $this->rebinding($abstract, function ($app, $instance) use ($target, $method) {
- $target->{$method}($instance);
- });
- }
- /**
- * Fire the "rebound" callbacks for the given abstract type.
- *
- * @param string $abstract
- * @return void
- */
- protected function rebound($abstract)
- {
- $instance = $this->make($abstract);
- foreach ($this->getReboundCallbacks($abstract) as $callback) {
- $callback($this, $instance);
- }
- }
- /**
- * Get the rebound callbacks for a given type.
- *
- * @param string $abstract
- * @return array
- */
- protected function getReboundCallbacks($abstract)
- {
- return $this->reboundCallbacks[$abstract] ?? [];
- }
- /**
- * Wrap the given closure such that its dependencies will be injected when executed.
- *
- * @param \Closure $callback
- * @param array $parameters
- * @return \Closure
- */
- public function wrap(Closure $callback, array $parameters = [])
- {
- return fn () => $this->call($callback, $parameters);
- }
- /**
- * Call the given Closure / class@method and inject its dependencies.
- *
- * @param callable|string $callback
- * @param array<string, mixed> $parameters
- * @param string|null $defaultMethod
- * @return mixed
- *
- * @throws \InvalidArgumentException
- */
- public function call($callback, array $parameters = [], $defaultMethod = null)
- {
- $pushedToBuildStack = false;
- if (($className = $this->getClassForCallable($callback)) && ! in_array(
- $className,
- $this->buildStack,
- true
- )) {
- $this->buildStack[] = $className;
- $pushedToBuildStack = true;
- }
- $result = BoundMethod::call($this, $callback, $parameters, $defaultMethod);
- if ($pushedToBuildStack) {
- array_pop($this->buildStack);
- }
- return $result;
- }
- /**
- * Get the class name for the given callback, if one can be determined.
- *
- * @param callable|string $callback
- * @return string|false
- */
- protected function getClassForCallable($callback)
- {
- if (is_callable($callback) &&
- ! ($reflector = new ReflectionFunction($callback(...)))->isAnonymous()) {
- return $reflector->getClosureScopeClass()->name ?? false;
- }
- return false;
- }
- /**
- * Get a closure to resolve the given type from the container.
- *
- * @param string $abstract
- * @return \Closure
- */
- public function factory($abstract)
- {
- return fn () => $this->make($abstract);
- }
- /**
- * An alias function name for make().
- *
- * @param string|callable $abstract
- * @param array $parameters
- * @return mixed
- *
- * @throws \Illuminate\Contracts\Container\BindingResolutionException
- */
- public function makeWith($abstract, array $parameters = [])
- {
- return $this->make($abstract, $parameters);
- }
- /**
- * Resolve the given type from the container.
- *
- * @param string|callable $abstract
- * @param array $parameters
- * @return mixed
- *
- * @throws \Illuminate\Contracts\Container\BindingResolutionException
- */
- public function make($abstract, array $parameters = [])
- {
- return $this->resolve($abstract, $parameters);
- }
- /**
- * {@inheritdoc}
- *
- * @return mixed
- */
- public function get(string $id)
- {
- try {
- return $this->resolve($id);
- } catch (Exception $e) {
- if ($this->has($id) || $e instanceof CircularDependencyException) {
- throw $e;
- }
- throw new EntryNotFoundException($id, is_int($e->getCode()) ? $e->getCode() : 0, $e);
- }
- }
- /**
- * Resolve the given type from the container.
- *
- * @param string|callable $abstract
- * @param array $parameters
- * @param bool $raiseEvents
- * @return mixed
- *
- * @throws \Illuminate\Contracts\Container\BindingResolutionException
- * @throws \Illuminate\Contracts\Container\CircularDependencyException
- */
- protected function resolve($abstract, $parameters = [], $raiseEvents = true)
- {
- $abstract = $this->getAlias($abstract);
- // First we'll fire any event handlers which handle the "before" resolving of
- // specific types. This gives some hooks the chance to add various extends
- // calls to change the resolution of objects that they're interested in.
- if ($raiseEvents) {
- $this->fireBeforeResolvingCallbacks($abstract, $parameters);
- }
- $concrete = $this->getContextualConcrete($abstract);
- $needsContextualBuild = ! empty($parameters) || ! is_null($concrete);
- // If an instance of the type is currently being managed as a singleton we'll
- // just return an existing instance instead of instantiating new instances
- // so the developer can keep using the same objects instance every time.
- if (isset($this->instances[$abstract]) && ! $needsContextualBuild) {
- return $this->instances[$abstract];
- }
- $this->with[] = $parameters;
- if (is_null($concrete)) {
- $concrete = $this->getConcrete($abstract);
- }
- // We're ready to instantiate an instance of the concrete type registered for
- // the binding. This will instantiate the types, as well as resolve any of
- // its "nested" dependencies recursively until all have gotten resolved.
- $object = $this->isBuildable($concrete, $abstract)
- ? $this->build($concrete)
- : $this->make($concrete);
- // If we defined any extenders for this type, we'll need to spin through them
- // and apply them to the object being built. This allows for the extension
- // of services, such as changing configuration or decorating the object.
- foreach ($this->getExtenders($abstract) as $extender) {
- $object = $extender($object, $this);
- }
- // If the requested type is registered as a singleton we'll want to cache off
- // the instances in "memory" so we can return it later without creating an
- // entirely new instance of an object on each subsequent request for it.
- if ($this->isShared($abstract) && ! $needsContextualBuild) {
- $this->instances[$abstract] = $object;
- }
- if ($raiseEvents) {
- $this->fireResolvingCallbacks($abstract, $object);
- }
- // Before returning, we will also set the resolved flag to "true" and pop off
- // the parameter overrides for this build. After those two things are done
- // we will be ready to return back the fully constructed class instance.
- $this->resolved[$abstract] = true;
- array_pop($this->with);
- return $object;
- }
- /**
- * Get the concrete type for a given abstract.
- *
- * @param string|callable $abstract
- * @return mixed
- */
- protected function getConcrete($abstract)
- {
- // If we don't have a registered resolver or concrete for the type, we'll just
- // assume each type is a concrete name and will attempt to resolve it as is
- // since the container should be able to resolve concretes automatically.
- if (isset($this->bindings[$abstract])) {
- return $this->bindings[$abstract]['concrete'];
- }
- return $abstract;
- }
- /**
- * Get the contextual concrete binding for the given abstract.
- *
- * @param string|callable $abstract
- * @return \Closure|string|array|null
- */
- protected function getContextualConcrete($abstract)
- {
- if (! is_null($binding = $this->findInContextualBindings($abstract))) {
- return $binding;
- }
- // Next we need to see if a contextual binding might be bound under an alias of the
- // given abstract type. So, we will need to check if any aliases exist with this
- // type and then spin through them and check for contextual bindings on these.
- if (empty($this->abstractAliases[$abstract])) {
- return;
- }
- foreach ($this->abstractAliases[$abstract] as $alias) {
- if (! is_null($binding = $this->findInContextualBindings($alias))) {
- return $binding;
- }
- }
- }
- /**
- * Find the concrete binding for the given abstract in the contextual binding array.
- *
- * @param string|callable $abstract
- * @return \Closure|string|null
- */
- protected function findInContextualBindings($abstract)
- {
- return $this->contextual[end($this->buildStack)][$abstract] ?? null;
- }
- /**
- * Determine if the given concrete is buildable.
- *
- * @param mixed $concrete
- * @param string $abstract
- * @return bool
- */
- protected function isBuildable($concrete, $abstract)
- {
- return $concrete === $abstract || $concrete instanceof Closure;
- }
- /**
- * Instantiate a concrete instance of the given type.
- *
- * @param \Closure|string $concrete
- * @return mixed
- *
- * @throws \Illuminate\Contracts\Container\BindingResolutionException
- * @throws \Illuminate\Contracts\Container\CircularDependencyException
- */
- public function build($concrete)
- {
- // If the concrete type is actually a Closure, we will just execute it and
- // hand back the results of the functions, which allows functions to be
- // used as resolvers for more fine-tuned resolution of these objects.
- if ($concrete instanceof Closure) {
- $this->buildStack[] = spl_object_hash($concrete);
- try {
- return $concrete($this, $this->getLastParameterOverride());
- } finally {
- array_pop($this->buildStack);
- }
- }
- try {
- $reflector = new ReflectionClass($concrete);
- } catch (ReflectionException $e) {
- throw new BindingResolutionException("Target class [$concrete] does not exist.", 0, $e);
- }
- // If the type is not instantiable, the developer is attempting to resolve
- // an abstract type such as an Interface or Abstract Class and there is
- // no binding registered for the abstractions so we need to bail out.
- if (! $reflector->isInstantiable()) {
- return $this->notInstantiable($concrete);
- }
- $this->buildStack[] = $concrete;
- $constructor = $reflector->getConstructor();
- // If there are no constructors, that means there are no dependencies then
- // we can just resolve the instances of the objects right away, without
- // resolving any other types or dependencies out of these containers.
- if (is_null($constructor)) {
- array_pop($this->buildStack);
- $this->fireAfterResolvingAttributeCallbacks(
- $reflector->getAttributes(), $instance = new $concrete
- );
- return $instance;
- }
- $dependencies = $constructor->getParameters();
- // Once we have all the constructor's parameters we can create each of the
- // dependency instances and then use the reflection instances to make a
- // new instance of this class, injecting the created dependencies in.
- try {
- $instances = $this->resolveDependencies($dependencies);
- } catch (BindingResolutionException $e) {
- array_pop($this->buildStack);
- throw $e;
- }
- array_pop($this->buildStack);
- $this->fireAfterResolvingAttributeCallbacks(
- $reflector->getAttributes(), $instance = $reflector->newInstanceArgs($instances)
- );
- return $instance;
- }
- /**
- * Resolve all of the dependencies from the ReflectionParameters.
- *
- * @param \ReflectionParameter[] $dependencies
- * @return array
- *
- * @throws \Illuminate\Contracts\Container\BindingResolutionException
- */
- protected function resolveDependencies(array $dependencies)
- {
- $results = [];
- foreach ($dependencies as $dependency) {
- // If the dependency has an override for this particular build we will use
- // that instead as the value. Otherwise, we will continue with this run
- // of resolutions and let reflection attempt to determine the result.
- if ($this->hasParameterOverride($dependency)) {
- $results[] = $this->getParameterOverride($dependency);
- continue;
- }
- $result = null;
- if (! is_null($attribute = $this->getContextualAttributeFromDependency($dependency))) {
- $result = $this->resolveFromAttribute($attribute);
- }
- // If the class is null, it means the dependency is a string or some other
- // primitive type which we can not resolve since it is not a class and
- // we will just bomb out with an error since we have no-where to go.
- $result ??= is_null(Util::getParameterClassName($dependency))
- ? $this->resolvePrimitive($dependency)
- : $this->resolveClass($dependency);
- $this->fireAfterResolvingAttributeCallbacks($dependency->getAttributes(), $result);
- if ($dependency->isVariadic()) {
- $results = array_merge($results, $result);
- } else {
- $results[] = $result;
- }
- }
- return $results;
- }
- /**
- * Determine if the given dependency has a parameter override.
- *
- * @param \ReflectionParameter $dependency
- * @return bool
- */
- protected function hasParameterOverride($dependency)
- {
- return array_key_exists(
- $dependency->name, $this->getLastParameterOverride()
- );
- }
- /**
- * Get a parameter override for a dependency.
- *
- * @param \ReflectionParameter $dependency
- * @return mixed
- */
- protected function getParameterOverride($dependency)
- {
- return $this->getLastParameterOverride()[$dependency->name];
- }
- /**
- * Get the last parameter override.
- *
- * @return array
- */
- protected function getLastParameterOverride()
- {
- return count($this->with) ? end($this->with) : [];
- }
- /**
- * Get a contextual attribute from a dependency.
- *
- * @param ReflectionParameter $dependency
- * @return \ReflectionAttribute|null
- */
- protected function getContextualAttributeFromDependency($dependency)
- {
- return $dependency->getAttributes(ContextualAttribute::class, ReflectionAttribute::IS_INSTANCEOF)[0] ?? null;
- }
- /**
- * Resolve a non-class hinted primitive dependency.
- *
- * @param \ReflectionParameter $parameter
- * @return mixed
- *
- * @throws \Illuminate\Contracts\Container\BindingResolutionException
- */
- protected function resolvePrimitive(ReflectionParameter $parameter)
- {
- if (! is_null($concrete = $this->getContextualConcrete('$'.$parameter->getName()))) {
- return Util::unwrapIfClosure($concrete, $this);
- }
- if ($parameter->isDefaultValueAvailable()) {
- return $parameter->getDefaultValue();
- }
- if ($parameter->isVariadic()) {
- return [];
- }
- $this->unresolvablePrimitive($parameter);
- }
- /**
- * Resolve a class based dependency from the container.
- *
- * @param \ReflectionParameter $parameter
- * @return mixed
- *
- * @throws \Illuminate\Contracts\Container\BindingResolutionException
- */
- protected function resolveClass(ReflectionParameter $parameter)
- {
- try {
- return $parameter->isVariadic()
- ? $this->resolveVariadicClass($parameter)
- : $this->make(Util::getParameterClassName($parameter));
- }
- // If we can not resolve the class instance, we will check to see if the value
- // is optional, and if it is we will return the optional parameter value as
- // the value of the dependency, similarly to how we do this with scalars.
- catch (BindingResolutionException $e) {
- if ($parameter->isDefaultValueAvailable()) {
- array_pop($this->with);
- return $parameter->getDefaultValue();
- }
- if ($parameter->isVariadic()) {
- array_pop($this->with);
- return [];
- }
- throw $e;
- }
- }
- /**
- * Resolve a class based variadic dependency from the container.
- *
- * @param \ReflectionParameter $parameter
- * @return mixed
- */
- protected function resolveVariadicClass(ReflectionParameter $parameter)
- {
- $className = Util::getParameterClassName($parameter);
- $abstract = $this->getAlias($className);
- if (! is_array($concrete = $this->getContextualConcrete($abstract))) {
- return $this->make($className);
- }
- return array_map(fn ($abstract) => $this->resolve($abstract), $concrete);
- }
- /**
- * Resolve a dependency based on an attribute.
- *
- * @param \ReflectionAttribute $attribute
- * @return mixed
- */
- protected function resolveFromAttribute(ReflectionAttribute $attribute)
- {
- $handler = $this->contextualAttributes[$attribute->getName()] ?? null;
- $instance = $attribute->newInstance();
- if (is_null($handler) && method_exists($instance, 'resolve')) {
- $handler = $instance->resolve(...);
- }
- if (is_null($handler)) {
- throw new BindingResolutionException("Contextual binding attribute [{$attribute->getName()}] has no registered handler.");
- }
- return $handler($instance, $this);
- }
- /**
- * Throw an exception that the concrete is not instantiable.
- *
- * @param string $concrete
- * @return void
- *
- * @throws \Illuminate\Contracts\Container\BindingResolutionException
- */
- protected function notInstantiable($concrete)
- {
- if (! empty($this->buildStack)) {
- $previous = implode(', ', $this->buildStack);
- $message = "Target [$concrete] is not instantiable while building [$previous].";
- } else {
- $message = "Target [$concrete] is not instantiable.";
- }
- throw new BindingResolutionException($message);
- }
- /**
- * Throw an exception for an unresolvable primitive.
- *
- * @param \ReflectionParameter $parameter
- * @return void
- *
- * @throws \Illuminate\Contracts\Container\BindingResolutionException
- */
- protected function unresolvablePrimitive(ReflectionParameter $parameter)
- {
- $message = "Unresolvable dependency resolving [$parameter] in class {$parameter->getDeclaringClass()->getName()}";
- throw new BindingResolutionException($message);
- }
- /**
- * Register a new before resolving callback for all types.
- *
- * @param \Closure|string $abstract
- * @param \Closure|null $callback
- * @return void
- */
- public function beforeResolving($abstract, ?Closure $callback = null)
- {
- if (is_string($abstract)) {
- $abstract = $this->getAlias($abstract);
- }
- if ($abstract instanceof Closure && is_null($callback)) {
- $this->globalBeforeResolvingCallbacks[] = $abstract;
- } else {
- $this->beforeResolvingCallbacks[$abstract][] = $callback;
- }
- }
- /**
- * Register a new resolving callback.
- *
- * @param \Closure|string $abstract
- * @param \Closure|null $callback
- * @return void
- */
- public function resolving($abstract, ?Closure $callback = null)
- {
- if (is_string($abstract)) {
- $abstract = $this->getAlias($abstract);
- }
- if (is_null($callback) && $abstract instanceof Closure) {
- $this->globalResolvingCallbacks[] = $abstract;
- } else {
- $this->resolvingCallbacks[$abstract][] = $callback;
- }
- }
- /**
- * Register a new after resolving callback for all types.
- *
- * @param \Closure|string $abstract
- * @param \Closure|null $callback
- * @return void
- */
- public function afterResolving($abstract, ?Closure $callback = null)
- {
- if (is_string($abstract)) {
- $abstract = $this->getAlias($abstract);
- }
- if ($abstract instanceof Closure && is_null($callback)) {
- $this->globalAfterResolvingCallbacks[] = $abstract;
- } else {
- $this->afterResolvingCallbacks[$abstract][] = $callback;
- }
- }
- /**
- * Register a new after resolving attribute callback for all types.
- *
- * @param string $attribute
- * @param \Closure $callback
- * @return void
- */
- public function afterResolvingAttribute(string $attribute, \Closure $callback)
- {
- $this->afterResolvingAttributeCallbacks[$attribute][] = $callback;
- }
- /**
- * Fire all of the before resolving callbacks.
- *
- * @param string $abstract
- * @param array $parameters
- * @return void
- */
- protected function fireBeforeResolvingCallbacks($abstract, $parameters = [])
- {
- $this->fireBeforeCallbackArray($abstract, $parameters, $this->globalBeforeResolvingCallbacks);
- foreach ($this->beforeResolvingCallbacks as $type => $callbacks) {
- if ($type === $abstract || is_subclass_of($abstract, $type)) {
- $this->fireBeforeCallbackArray($abstract, $parameters, $callbacks);
- }
- }
- }
- /**
- * Fire an array of callbacks with an object.
- *
- * @param string $abstract
- * @param array $parameters
- * @param array $callbacks
- * @return void
- */
- protected function fireBeforeCallbackArray($abstract, $parameters, array $callbacks)
- {
- foreach ($callbacks as $callback) {
- $callback($abstract, $parameters, $this);
- }
- }
- /**
- * Fire all of the resolving callbacks.
- *
- * @param string $abstract
- * @param mixed $object
- * @return void
- */
- protected function fireResolvingCallbacks($abstract, $object)
- {
- $this->fireCallbackArray($object, $this->globalResolvingCallbacks);
- $this->fireCallbackArray(
- $object, $this->getCallbacksForType($abstract, $object, $this->resolvingCallbacks)
- );
- $this->fireAfterResolvingCallbacks($abstract, $object);
- }
- /**
- * Fire all of the after resolving callbacks.
- *
- * @param string $abstract
- * @param mixed $object
- * @return void
- */
- protected function fireAfterResolvingCallbacks($abstract, $object)
- {
- $this->fireCallbackArray($object, $this->globalAfterResolvingCallbacks);
- $this->fireCallbackArray(
- $object, $this->getCallbacksForType($abstract, $object, $this->afterResolvingCallbacks)
- );
- }
- /**
- * Fire all of the after resolving attribute callbacks.
- *
- * @param \ReflectionAttribute[] $abstract
- * @param mixed $object
- * @return void
- */
- protected function fireAfterResolvingAttributeCallbacks(array $attributes, $object)
- {
- foreach ($attributes as $attribute) {
- if (is_a($attribute->getName(), ContextualAttribute::class, true)) {
- $instance = $attribute->newInstance();
- if (method_exists($instance, 'after')) {
- $instance->after($instance, $object, $this);
- }
- }
- $callbacks = $this->getCallbacksForType(
- $attribute->getName(), $object, $this->afterResolvingAttributeCallbacks
- );
- foreach ($callbacks as $callback) {
- $callback($attribute->newInstance(), $object, $this);
- }
- }
- }
- /**
- * Get all callbacks for a given type.
- *
- * @param string $abstract
- * @param object $object
- * @param array $callbacksPerType
- * @return array
- */
- protected function getCallbacksForType($abstract, $object, array $callbacksPerType)
- {
- $results = [];
- foreach ($callbacksPerType as $type => $callbacks) {
- if ($type === $abstract || $object instanceof $type) {
- $results = array_merge($results, $callbacks);
- }
- }
- return $results;
- }
- /**
- * Fire an array of callbacks with an object.
- *
- * @param mixed $object
- * @param array $callbacks
- * @return void
- */
- protected function fireCallbackArray($object, array $callbacks)
- {
- foreach ($callbacks as $callback) {
- $callback($object, $this);
- }
- }
- /**
- * Get the container's bindings.
- *
- * @return array
- */
- public function getBindings()
- {
- return $this->bindings;
- }
- /**
- * Get the alias for an abstract if available.
- *
- * @param string $abstract
- * @return string
- */
- public function getAlias($abstract)
- {
- return isset($this->aliases[$abstract])
- ? $this->getAlias($this->aliases[$abstract])
- : $abstract;
- }
- /**
- * Get the extender callbacks for a given type.
- *
- * @param string $abstract
- * @return array
- */
- protected function getExtenders($abstract)
- {
- return $this->extenders[$this->getAlias($abstract)] ?? [];
- }
- /**
- * Remove all of the extender callbacks for a given type.
- *
- * @param string $abstract
- * @return void
- */
- public function forgetExtenders($abstract)
- {
- unset($this->extenders[$this->getAlias($abstract)]);
- }
- /**
- * Drop all of the stale instances and aliases.
- *
- * @param string $abstract
- * @return void
- */
- protected function dropStaleInstances($abstract)
- {
- unset($this->instances[$abstract], $this->aliases[$abstract]);
- }
- /**
- * Remove a resolved instance from the instance cache.
- *
- * @param string $abstract
- * @return void
- */
- public function forgetInstance($abstract)
- {
- unset($this->instances[$abstract]);
- }
- /**
- * Clear all of the instances from the container.
- *
- * @return void
- */
- public function forgetInstances()
- {
- $this->instances = [];
- }
- /**
- * Clear all of the scoped instances from the container.
- *
- * @return void
- */
- public function forgetScopedInstances()
- {
- foreach ($this->scopedInstances as $scoped) {
- unset($this->instances[$scoped]);
- }
- }
- /**
- * Flush the container of all bindings and resolved instances.
- *
- * @return void
- */
- public function flush()
- {
- $this->aliases = [];
- $this->resolved = [];
- $this->bindings = [];
- $this->instances = [];
- $this->abstractAliases = [];
- $this->scopedInstances = [];
- }
- /**
- * Get the globally available instance of the container.
- *
- * @return static
- */
- public static function getInstance()
- {
- if (is_null(static::$instance)) {
- static::$instance = new static;
- }
- return static::$instance;
- }
- /**
- * Set the shared instance of the container.
- *
- * @param \Illuminate\Contracts\Container\Container|null $container
- * @return \Illuminate\Contracts\Container\Container|static
- */
- public static function setInstance(?ContainerContract $container = null)
- {
- return static::$instance = $container;
- }
- /**
- * Determine if a given offset exists.
- *
- * @param string $key
- * @return bool
- */
- public function offsetExists($key): bool
- {
- return $this->bound($key);
- }
- /**
- * Get the value at a given offset.
- *
- * @param string $key
- * @return mixed
- */
- public function offsetGet($key): mixed
- {
- return $this->make($key);
- }
- /**
- * Set the value at a given offset.
- *
- * @param string $key
- * @param mixed $value
- * @return void
- */
- public function offsetSet($key, $value): void
- {
- $this->bind($key, $value instanceof Closure ? $value : fn () => $value);
- }
- /**
- * Unset the value at a given offset.
- *
- * @param string $key
- * @return void
- */
- public function offsetUnset($key): void
- {
- unset($this->bindings[$key], $this->instances[$key], $this->resolved[$key]);
- }
- /**
- * Dynamically access container services.
- *
- * @param string $key
- * @return mixed
- */
- public function __get($key)
- {
- return $this[$key];
- }
- /**
- * Dynamically set container services.
- *
- * @param string $key
- * @param mixed $value
- * @return void
- */
- public function __set($key, $value)
- {
- $this[$key] = $value;
- }
- }
|