Request.php 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. <?php
  2. namespace Illuminate\Support\Facades;
  3. /**
  4. * @method static \Illuminate\Http\Request capture()
  5. * @method static \Illuminate\Http\Request instance()
  6. * @method static string method()
  7. * @method static \Illuminate\Support\Uri uri()
  8. * @method static string root()
  9. * @method static string url()
  10. * @method static string fullUrl()
  11. * @method static string fullUrlWithQuery(array $query)
  12. * @method static string fullUrlWithoutQuery(array|string $keys)
  13. * @method static string path()
  14. * @method static string decodedPath()
  15. * @method static string|null segment(int $index, string|null $default = null)
  16. * @method static array segments()
  17. * @method static bool is(mixed ...$patterns)
  18. * @method static bool routeIs(mixed ...$patterns)
  19. * @method static bool fullUrlIs(mixed ...$patterns)
  20. * @method static string host()
  21. * @method static string httpHost()
  22. * @method static string schemeAndHttpHost()
  23. * @method static bool ajax()
  24. * @method static bool pjax()
  25. * @method static bool prefetch()
  26. * @method static bool secure()
  27. * @method static string|null ip()
  28. * @method static array ips()
  29. * @method static string|null userAgent()
  30. * @method static \Illuminate\Http\Request merge(array $input)
  31. * @method static \Illuminate\Http\Request mergeIfMissing(array $input)
  32. * @method static \Illuminate\Http\Request replace(array $input)
  33. * @method static mixed get(string $key, mixed $default = null)
  34. * @method static \Symfony\Component\HttpFoundation\InputBag|mixed json(string|null $key = null, mixed $default = null)
  35. * @method static \Illuminate\Http\Request createFrom(\Illuminate\Http\Request $from, \Illuminate\Http\Request|null $to = null)
  36. * @method static \Illuminate\Http\Request createFromBase(\Symfony\Component\HttpFoundation\Request $request)
  37. * @method static \Illuminate\Http\Request duplicate(array|null $query = null, array|null $request = null, array|null $attributes = null, array|null $cookies = null, array|null $files = null, array|null $server = null)
  38. * @method static bool hasSession(bool $skipIfUninitialized = false)
  39. * @method static \Symfony\Component\HttpFoundation\Session\SessionInterface getSession()
  40. * @method static \Illuminate\Contracts\Session\Session session()
  41. * @method static void setLaravelSession(\Illuminate\Contracts\Session\Session $session)
  42. * @method static void setRequestLocale(string $locale)
  43. * @method static void setDefaultRequestLocale(string $locale)
  44. * @method static mixed user(string|null $guard = null)
  45. * @method static \Illuminate\Routing\Route|object|string|null route(string|null $param = null, mixed $default = null)
  46. * @method static string fingerprint()
  47. * @method static \Illuminate\Http\Request setJson(\Symfony\Component\HttpFoundation\InputBag $json)
  48. * @method static \Closure getUserResolver()
  49. * @method static \Illuminate\Http\Request setUserResolver(\Closure $callback)
  50. * @method static \Closure getRouteResolver()
  51. * @method static \Illuminate\Http\Request setRouteResolver(\Closure $callback)
  52. * @method static array toArray()
  53. * @method static void initialize(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], string|resource|null $content = null)
  54. * @method static \Illuminate\Http\Request createFromGlobals()
  55. * @method static \Illuminate\Http\Request create(string $uri, string $method = 'GET', array $parameters = [], array $cookies = [], array $files = [], array $server = [], string|resource|null $content = null)
  56. * @method static void setFactory(callable|null $callable)
  57. * @method static void overrideGlobals()
  58. * @method static void setTrustedProxies(array $proxies, int $trustedHeaderSet)
  59. * @method static string[] getTrustedProxies()
  60. * @method static int getTrustedHeaderSet()
  61. * @method static void setTrustedHosts(array $hostPatterns)
  62. * @method static string[] getTrustedHosts()
  63. * @method static string normalizeQueryString(string|null $qs)
  64. * @method static void enableHttpMethodParameterOverride()
  65. * @method static bool getHttpMethodParameterOverride()
  66. * @method static bool hasPreviousSession()
  67. * @method static void setSession(\Symfony\Component\HttpFoundation\Session\SessionInterface $session)
  68. * @method static array getClientIps()
  69. * @method static string|null getClientIp()
  70. * @method static string getScriptName()
  71. * @method static string getPathInfo()
  72. * @method static string getBasePath()
  73. * @method static string getBaseUrl()
  74. * @method static string getScheme()
  75. * @method static int|string|null getPort()
  76. * @method static string|null getUser()
  77. * @method static string|null getPassword()
  78. * @method static string|null getUserInfo()
  79. * @method static string getHttpHost()
  80. * @method static string getRequestUri()
  81. * @method static string getSchemeAndHttpHost()
  82. * @method static string getUri()
  83. * @method static string getUriForPath(string $path)
  84. * @method static string getRelativeUriForPath(string $path)
  85. * @method static string|null getQueryString()
  86. * @method static bool isSecure()
  87. * @method static string getHost()
  88. * @method static void setMethod(string $method)
  89. * @method static string getMethod()
  90. * @method static string getRealMethod()
  91. * @method static string|null getMimeType(string $format)
  92. * @method static string[] getMimeTypes(string $format)
  93. * @method static string|null getFormat(string|null $mimeType)
  94. * @method static void setFormat(string|null $format, string|string[] $mimeTypes)
  95. * @method static string|null getRequestFormat(string|null $default = 'html')
  96. * @method static void setRequestFormat(string|null $format)
  97. * @method static string|null getContentTypeFormat()
  98. * @method static void setDefaultLocale(string $locale)
  99. * @method static string getDefaultLocale()
  100. * @method static void setLocale(string $locale)
  101. * @method static string getLocale()
  102. * @method static bool isMethod(string $method)
  103. * @method static bool isMethodSafe()
  104. * @method static bool isMethodIdempotent()
  105. * @method static bool isMethodCacheable()
  106. * @method static string|null getProtocolVersion()
  107. * @method static string|resource getContent(bool $asResource = false)
  108. * @method static \Symfony\Component\HttpFoundation\InputBag getPayload()
  109. * @method static array getETags()
  110. * @method static bool isNoCache()
  111. * @method static string|null getPreferredFormat(string|null $default = 'html')
  112. * @method static string|null getPreferredLanguage(string[] $locales = null)
  113. * @method static string[] getLanguages()
  114. * @method static string[] getCharsets()
  115. * @method static string[] getEncodings()
  116. * @method static string[] getAcceptableContentTypes()
  117. * @method static bool isXmlHttpRequest()
  118. * @method static bool preferSafeContent()
  119. * @method static bool isFromTrustedProxy()
  120. * @method static array filterPrecognitiveRules(array $rules)
  121. * @method static bool isAttemptingPrecognition()
  122. * @method static bool isPrecognitive()
  123. * @method static bool isJson()
  124. * @method static bool expectsJson()
  125. * @method static bool wantsJson()
  126. * @method static bool accepts(string|array $contentTypes)
  127. * @method static string|null prefers(string|array $contentTypes)
  128. * @method static bool acceptsAnyContentType()
  129. * @method static bool acceptsJson()
  130. * @method static bool acceptsHtml()
  131. * @method static bool matchesType(string $actual, string $type)
  132. * @method static string format(string $default = 'html')
  133. * @method static string|array|null old(string|null $key = null, \Illuminate\Database\Eloquent\Model|string|array|null $default = null)
  134. * @method static void flash()
  135. * @method static void flashOnly(mixed $keys)
  136. * @method static void flashExcept(mixed $keys)
  137. * @method static void flush()
  138. * @method static string|array|null server(string|null $key = null, string|array|null $default = null)
  139. * @method static bool hasHeader(string $key)
  140. * @method static string|array|null header(string|null $key = null, string|array|null $default = null)
  141. * @method static string|null bearerToken()
  142. * @method static array keys()
  143. * @method static array all(mixed $keys = null)
  144. * @method static mixed input(string|null $key = null, mixed $default = null)
  145. * @method static \Illuminate\Support\Fluent fluent(array|string|null $key = null)
  146. * @method static string|array|null query(string|null $key = null, string|array|null $default = null)
  147. * @method static string|array|null post(string|null $key = null, string|array|null $default = null)
  148. * @method static bool hasCookie(string $key)
  149. * @method static string|array|null cookie(string|null $key = null, string|array|null $default = null)
  150. * @method static array allFiles()
  151. * @method static bool hasFile(string $key)
  152. * @method static array|\Illuminate\Http\UploadedFile|\Illuminate\Http\UploadedFile[]|null file(string|null $key = null, mixed $default = null)
  153. * @method static \Illuminate\Http\Request dump(mixed $keys = [])
  154. * @method static never dd(mixed ...$args)
  155. * @method static bool exists(string|array $key)
  156. * @method static bool has(string|array $key)
  157. * @method static bool hasAny(string|array $keys)
  158. * @method static \Illuminate\Http\Request|mixed whenHas(string $key, callable $callback, callable|null $default = null)
  159. * @method static bool filled(string|array $key)
  160. * @method static bool isNotFilled(string|array $key)
  161. * @method static bool anyFilled(string|array $keys)
  162. * @method static \Illuminate\Http\Request|mixed whenFilled(string $key, callable $callback, callable|null $default = null)
  163. * @method static bool missing(string|array $key)
  164. * @method static \Illuminate\Http\Request|mixed whenMissing(string $key, callable $callback, callable|null $default = null)
  165. * @method static \Illuminate\Support\Stringable str(string $key, mixed $default = null)
  166. * @method static \Illuminate\Support\Stringable string(string $key, mixed $default = null)
  167. * @method static bool boolean(string|null $key = null, bool $default = false)
  168. * @method static int integer(string $key, int $default = 0)
  169. * @method static float float(string $key, float $default = 0)
  170. * @method static \Illuminate\Support\Carbon|null date(string $key, string|null $format = null, \UnitEnum|string|null $tz = null)
  171. * @method static \BackedEnum|null enum(string $key, string $enumClass, \BackedEnum|null $default = null)
  172. * @method static \BackedEnum[] enums(string $key, string $enumClass)
  173. * @method static array array(array|string|null $key = null)
  174. * @method static \Illuminate\Support\Collection collect(array|string|null $key = null)
  175. * @method static array only(mixed $keys)
  176. * @method static array except(mixed $keys)
  177. * @method static \Illuminate\Http\Request|mixed when(\Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)
  178. * @method static \Illuminate\Http\Request|mixed unless(\Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)
  179. * @method static void macro(string $name, object|callable $macro)
  180. * @method static void mixin(object $mixin, bool $replace = true)
  181. * @method static bool hasMacro(string $name)
  182. * @method static void flushMacros()
  183. * @method static array validate(array $rules, ...$params)
  184. * @method static array validateWithBag(string $errorBag, array $rules, ...$params)
  185. * @method static bool hasValidSignature(bool $absolute = true)
  186. * @method static bool hasValidRelativeSignature()
  187. * @method static bool hasValidSignatureWhileIgnoring($ignoreQuery = [], $absolute = true)
  188. * @method static bool hasValidRelativeSignatureWhileIgnoring($ignoreQuery = [])
  189. *
  190. * @see \Illuminate\Http\Request
  191. */
  192. class Request extends Facade
  193. {
  194. /**
  195. * Get the registered name of the component.
  196. *
  197. * @return string
  198. */
  199. protected static function getFacadeAccessor()
  200. {
  201. return 'request';
  202. }
  203. }