Container.php 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  1. <?php
  2. namespace Illuminate\Contracts\Container;
  3. use Closure;
  4. use Psr\Container\ContainerInterface;
  5. interface Container extends ContainerInterface
  6. {
  7. /**
  8. * {@inheritdoc}
  9. *
  10. * @template TClass of object
  11. *
  12. * @param string|class-string<TClass> $id
  13. * @return ($id is class-string<TClass> ? TClass : mixed)
  14. */
  15. public function get(string $id);
  16. /**
  17. * Determine if the given abstract type has been bound.
  18. *
  19. * @param string $abstract
  20. * @return bool
  21. */
  22. public function bound($abstract);
  23. /**
  24. * Alias a type to a different name.
  25. *
  26. * @param string $abstract
  27. * @param string $alias
  28. * @return void
  29. *
  30. * @throws \LogicException
  31. */
  32. public function alias($abstract, $alias);
  33. /**
  34. * Assign a set of tags to a given binding.
  35. *
  36. * @param array|string $abstracts
  37. * @param mixed ...$tags
  38. * @return void
  39. */
  40. public function tag($abstracts, $tags);
  41. /**
  42. * Resolve all of the bindings for a given tag.
  43. *
  44. * @param string $tag
  45. * @return iterable
  46. */
  47. public function tagged($tag);
  48. /**
  49. * Register a binding with the container.
  50. *
  51. * @param \Closure|string $abstract
  52. * @param \Closure|string|null $concrete
  53. * @param bool $shared
  54. * @return void
  55. */
  56. public function bind($abstract, $concrete = null, $shared = false);
  57. /**
  58. * Bind a callback to resolve with Container::call.
  59. *
  60. * @param array|string $method
  61. * @param \Closure $callback
  62. * @return void
  63. */
  64. public function bindMethod($method, $callback);
  65. /**
  66. * Register a binding if it hasn't already been registered.
  67. *
  68. * @param \Closure|string $abstract
  69. * @param \Closure|string|null $concrete
  70. * @param bool $shared
  71. * @return void
  72. */
  73. public function bindIf($abstract, $concrete = null, $shared = false);
  74. /**
  75. * Register a shared binding in the container.
  76. *
  77. * @param \Closure|string $abstract
  78. * @param \Closure|string|null $concrete
  79. * @return void
  80. */
  81. public function singleton($abstract, $concrete = null);
  82. /**
  83. * Register a shared binding if it hasn't already been registered.
  84. *
  85. * @param \Closure|string $abstract
  86. * @param \Closure|string|null $concrete
  87. * @return void
  88. */
  89. public function singletonIf($abstract, $concrete = null);
  90. /**
  91. * Register a scoped binding in the container.
  92. *
  93. * @param \Closure|string $abstract
  94. * @param \Closure|string|null $concrete
  95. * @return void
  96. */
  97. public function scoped($abstract, $concrete = null);
  98. /**
  99. * Register a scoped binding if it hasn't already been registered.
  100. *
  101. * @param \Closure|string $abstract
  102. * @param \Closure|string|null $concrete
  103. * @return void
  104. */
  105. public function scopedIf($abstract, $concrete = null);
  106. /**
  107. * "Extend" an abstract type in the container.
  108. *
  109. * @param \Closure|string $abstract
  110. * @param \Closure $closure
  111. * @return void
  112. *
  113. * @throws \InvalidArgumentException
  114. */
  115. public function extend($abstract, Closure $closure);
  116. /**
  117. * Register an existing instance as shared in the container.
  118. *
  119. * @template TInstance of mixed
  120. *
  121. * @param \Closure|string $abstract
  122. * @param TInstance $instance
  123. * @return TInstance
  124. */
  125. public function instance($abstract, $instance);
  126. /**
  127. * Add a contextual binding to the container.
  128. *
  129. * @param string $concrete
  130. * @param \Closure|string $abstract
  131. * @param \Closure|string $implementation
  132. * @return void
  133. */
  134. public function addContextualBinding($concrete, $abstract, $implementation);
  135. /**
  136. * Define a contextual binding.
  137. *
  138. * @param string|array $concrete
  139. * @return \Illuminate\Contracts\Container\ContextualBindingBuilder
  140. */
  141. public function when($concrete);
  142. /**
  143. * Get a closure to resolve the given type from the container.
  144. *
  145. * @template TClass of object
  146. *
  147. * @param string|class-string<TClass> $abstract
  148. * @return ($abstract is class-string<TClass> ? \Closure(): TClass : \Closure(): mixed)
  149. */
  150. public function factory($abstract);
  151. /**
  152. * Flush the container of all bindings and resolved instances.
  153. *
  154. * @return void
  155. */
  156. public function flush();
  157. /**
  158. * Resolve the given type from the container.
  159. *
  160. * @template TClass of object
  161. *
  162. * @param string|class-string<TClass> $abstract
  163. * @param array $parameters
  164. * @return ($abstract is class-string<TClass> ? TClass : mixed)
  165. *
  166. * @throws \Illuminate\Contracts\Container\BindingResolutionException
  167. */
  168. public function make($abstract, array $parameters = []);
  169. /**
  170. * Call the given Closure / class@method and inject its dependencies.
  171. *
  172. * @param callable|string $callback
  173. * @param array $parameters
  174. * @param string|null $defaultMethod
  175. * @return mixed
  176. */
  177. public function call($callback, array $parameters = [], $defaultMethod = null);
  178. /**
  179. * Determine if the given abstract type has been resolved.
  180. *
  181. * @param string $abstract
  182. * @return bool
  183. */
  184. public function resolved($abstract);
  185. /**
  186. * Register a new before resolving callback.
  187. *
  188. * @param \Closure|string $abstract
  189. * @param \Closure|null $callback
  190. * @return void
  191. */
  192. public function beforeResolving($abstract, ?Closure $callback = null);
  193. /**
  194. * Register a new resolving callback.
  195. *
  196. * @param \Closure|string $abstract
  197. * @param \Closure|null $callback
  198. * @return void
  199. */
  200. public function resolving($abstract, ?Closure $callback = null);
  201. /**
  202. * Register a new after resolving callback.
  203. *
  204. * @param \Closure|string $abstract
  205. * @param \Closure|null $callback
  206. * @return void
  207. */
  208. public function afterResolving($abstract, ?Closure $callback = null);
  209. }