-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathServerRequest.php
More file actions
1837 lines (1617 loc) · 58.2 KB
/
ServerRequest.php
File metadata and controls
1837 lines (1617 loc) · 58.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* This file is part of Blitz PHP framework.
*
* (c) 2022 Dimitri Sitchet Tomkeu <devcode.dst@gmail.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace BlitzPHP\Http;
use BadMethodCallException;
use BlitzPHP\Exceptions\FrameworkException;
use BlitzPHP\Exceptions\HttpException;
use BlitzPHP\Filesystem\Files\UploadedFile;
use BlitzPHP\Session\Cookie\CookieCollection;
use BlitzPHP\Session\Store;
use BlitzPHP\Utilities\Iterable\Arr;
use Closure;
use GuzzleHttp\Psr7\ServerRequest as Psr7ServerRequest;
use GuzzleHttp\Psr7\Stream;
use GuzzleHttp\Psr7\Utils;
use InvalidArgumentException;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UploadedFileInterface;
use Psr\Http\Message\UriInterface;
/**
* Une classe qui aide à envelopper les informations de la requête et les détails d'une seule requête.
* Fournit des méthodes couramment utilisées pour effectuer une introspection sur les en-têtes et le corps de la requête.
*/
class ServerRequest implements ServerRequestInterface
{
/**
* Tableau de paramètres analysés à partir de l'URL.
*/
protected array $params = [
'plugin' => null,
'controller' => null,
'action' => null,
'_ext' => null,
'pass' => [],
];
/**
* Tableau de données POST. Contiendra des données de formulaire ainsi que des fichiers téléchargés.
* Dans les requêtes PUT/PATCH/DELETE, cette propriété contiendra les données encodées du formulaire.
*/
protected array|object|null $data = [];
/**
* Tableau d'arguments de chaîne de requête
*/
protected array $query = [];
/**
* Tableau de données de cookie.
*
* @var array<string, mixed>
*/
protected array $cookies = [];
/**
* Tableau de données d'environnement.
*
* @var array<string, mixed>
*/
protected array $_environment = [];
/**
* Chemin de l'URL de base.
*/
protected string $base;
/**
* segment de chemin webroot pour la demande.
*/
protected string $webroot = '/';
/**
* S'il faut faire confiance aux en-têtes HTTP_X définis par la plupart des équilibreurs de charge.
* Défini sur vrai uniquement si votre application s'exécute derrière des équilibreurs de charge/proxies que vous contrôlez.
*/
public bool $trustProxy = false;
/**
* Liste des proxys de confiance
*
* @var list<string>
*/
protected array $trustedProxies = [];
/**
* Les détecteurs intégrés utilisés avec `is()` peuvent être modifiés avec `addDetector()`.
*
* Il existe plusieurs façons de spécifier un détecteur, voir `addDetector()` pour
* les différents formats et façons de définir des détecteurs.
*
* @var array<string, array|Closure>
*/
protected static array $_detectors = [
'get' => ['env' => 'REQUEST_METHOD', 'value' => 'GET'],
'post' => ['env' => 'REQUEST_METHOD', 'value' => 'POST'],
'put' => ['env' => 'REQUEST_METHOD', 'value' => 'PUT'],
'patch' => ['env' => 'REQUEST_METHOD', 'value' => 'PATCH'],
'delete' => ['env' => 'REQUEST_METHOD', 'value' => 'DELETE'],
'head' => ['env' => 'REQUEST_METHOD', 'value' => 'HEAD'],
'options' => ['env' => 'REQUEST_METHOD', 'value' => 'OPTIONS'],
'https' => ['env' => 'HTTPS', 'options' => [1, 'on']],
'ssl' => ['env' => 'HTTPS', 'options' => [1, 'on']],
'ajax' => ['env' => 'HTTP_X_REQUESTED_WITH', 'value' => 'XMLHttpRequest'],
'json' => ['accept' => ['application/json'], 'param' => '_ext', 'value' => 'json'],
'xml' => ['accept' => ['application/xml', 'text/xml'], 'param' => '_ext', 'value' => 'xml'],
];
/**
* Cache d'instance pour les résultats des appels is(something)
*
* @var array<string, bool>
*/
protected array $_detectorCache = [];
/**
* Flux du corps de la requête. Contient php://input sauf si l'option constructeur `input` est utilisée.
*/
protected StreamInterface $stream;
/**
* instance Uri
*/
protected UriInterface $uri;
/**
* Instance d'un objet Session relative à cette requête
*/
protected Store $session;
/**
* Stockez les attributs supplémentaires attachés à la requête.
*
* @var array<string, mixed>
*/
protected array $attributes = [];
/**
* Une liste de propriétés émulées par les méthodes d'attribut PSR7.
*
* @var list<string>
*/
protected array $emulatedAttributes = ['session', 'flash', 'webroot', 'base', 'params', 'here'];
/**
* Tableau de fichiers.
*/
protected array $uploadedFiles = [];
/**
* La version du protocole HTTP utilisée.
*/
protected ?string $protocol = null;
/**
* La cible de la requête si elle est remplacée
*/
protected ?string $requestTarget = null;
/**
* Negotiator
*/
protected ?Negotiator $negotiator = null;
/**
* Créer un nouvel objet de requête.
*
* Vous pouvez fournir les données sous forme de tableau ou de chaîne. Si tu utilises
* une chaîne, vous ne pouvez fournir que l'URL de la demande. L'utilisation d'un tableau
* vous permettent de fournir les clés suivantes :
*
* - `post` Données POST ou données de chaîne sans requête
* - `query` Données supplémentaires de la chaîne de requête.
* - `files` Fichiers téléchargés dans une structure normalisée, avec chaque feuille une instance de UploadedFileInterface.
* - `cookies` Cookies pour cette demande.
* - `environment` $_SERVER et $_ENV données.
* - `url` L'URL sans le chemin de base de la requête.
* - `uri` L'objet PSR7 UriInterface. Si nul, un sera créé à partir de `url` ou `environment`.
* - `base` L'URL de base de la requête.
* - `webroot` Le répertoire webroot pour la requête.
* - `input` Les données qui proviendraient de php://input ceci est utile pour simuler
* requêtes avec mise, patch ou suppression de données.
* - `session` Une instance d'un objet Session
*
* @param array<string, mixed> $config Un tableau de données de requête avec lequel créer une requête.
*/
public function __construct(array $config = [])
{
$config += [
'params' => $this->params,
'query' => [],
'post' => [],
'files' => [],
'cookies' => [],
'environment' => [],
'url' => '',
'uri' => null,
'base' => '',
'webroot' => '',
'input' => null,
];
$this->_setConfig($config);
}
/**
* Traitez les données de configuration/paramètres dans les propriétés.
*
* @param array<string, mixed> $config
*/
protected function _setConfig(array $config): void
{
if (empty($config['session'])) {
$config['session'] = single_service('session');
}
if (empty($config['environment']['REQUEST_METHOD'])) {
$config['environment']['REQUEST_METHOD'] = $_SERVER['REQUEST_METHOD'] ?? 'GET';
}
$this->cookies = $config['cookies'];
if (isset($config['uri'])) {
if (! $config['uri'] instanceof UriInterface) {
throw new FrameworkException('The `uri` key must be an instance of ' . UriInterface::class);
}
$uri = $config['uri'];
} elseif ($config['url'] !== '') {
$config = $this->processUrlOption($config);
$uri = new Uri(implode('?', [$config['url'], $config['environment']['QUERY_STRING'] ?? '']));
} else {
$uri = new Uri(Psr7ServerRequest::getUriFromGlobals()->__toString());
}
if (isset($config['environment']['REQUEST_URI'])) {
$uri = $uri->withPath($config['environment']['REQUEST_URI']);
}
if (in_array($uri->getHost(), ['localhost', '127.0.0.1'], true)) {
$uri = $uri->withHost(parse_url(config('app.base_url'), PHP_URL_HOST));
}
$this->_environment = $config['environment'];
$this->uri = $uri;
$this->base = $config['base'];
$this->webroot = $config['webroot'];
if (isset($config['input'])) {
$stream = new Stream(Utils::tryFopen('php://memory', 'rw'));
$stream->write($config['input']);
$stream->rewind();
} else {
$stream = new Stream(Utils::tryFopen('php://input', 'r'));
}
$this->stream = $stream;
$post = $config['post'];
if (! (is_array($post) || is_object($post) || $post === null)) {
throw new InvalidArgumentException(sprintf(
'La clé `post` doit être un tableau, un objet ou null. On a obtenu `%s` à la place.',
get_debug_type($post)
));
}
$this->data = $post;
$this->uploadedFiles = $config['files'];
$this->query = $config['query'];
$this->params = $config['params'];
$this->session = $config['session'];
}
/**
* Définissez les variables d'environnement en fonction de l'option `url` pour faciliter la génération d'instance UriInterface.
*
* L'option `query` est également mise à jour en fonction de la chaîne de requête de l'URL.
*/
protected function processUrlOption(array $config): array
{
if ($config['url'][0] !== '/') {
$config['url'] = '/' . $config['url'];
}
if (str_contains($config['url'], '?')) {
[$config['url'], $config['environment']['QUERY_STRING']] = explode('?', $config['url']);
parse_str($config['environment']['QUERY_STRING'], $queryArgs);
$config['query'] += $queryArgs;
}
$config['environment']['REQUEST_URI'] = $config['url'];
return $config;
}
/**
* Obtenez le type de contenu utilisé dans cette requête.
*/
public function contentType(): ?string
{
return $this->getEnv('CONTENT_TYPE') ?: $this->getEnv('HTTP_CONTENT_TYPE');
}
/**
* Renvoie l'instance de l'objet Session pour cette requête
*/
public function session(): Store
{
return $this->session;
}
/**
* Obtenez l'adresse IP que le client utilise ou dit qu'il utilise.
*/
public function clientIp(): string
{
if ($this->trustProxy && $this->getEnv('HTTP_X_FORWARDED_FOR')) {
$addresses = array_map('trim', explode(',', $this->getEnv('HTTP_X_FORWARDED_FOR')));
$trusted = $this->trustedProxies !== [];
$n = count($addresses);
if ($trusted) {
$trusted = array_diff($addresses, $this->trustedProxies);
$trusted = (count($trusted) === 1);
}
if ($trusted) {
return $addresses[0];
}
return $addresses[$n - 1];
}
if ($this->trustProxy && $this->getEnv('HTTP_X_REAL_IP')) {
$ipaddr = $this->getEnv('HTTP_X_REAL_IP');
} elseif ($this->trustProxy && $this->getEnv('HTTP_CLIENT_IP')) {
$ipaddr = $this->getEnv('HTTP_CLIENT_IP');
} else {
$ipaddr = $this->getEnv('REMOTE_ADDR');
}
return trim((string) $ipaddr);
}
/**
* Enregistrer des proxys de confiance
*
* @param list<string> $proxies ips liste des proxys de confiance
*/
public function setTrustedProxies(array $proxies): void
{
$this->trustedProxies = $proxies;
$this->trustProxy = true;
$this->uri = $this->uri->withScheme($this->scheme());
}
/**
* Obtenez les proxys de confiance
*/
public function getTrustedProxies(): array
{
return $this->trustedProxies;
}
/**
* Renvoie le référent qui a référé cette requête.
*
* @param bool $local Tentative de renvoi d'une adresse locale.
* Les adresses locales ne contiennent pas de noms d'hôtes..
*/
public function referer(bool $local = true): ?string
{
$ref = $this->getEnv('HTTP_REFERER');
$base = config('app.base_url') . $this->webroot;
if ($base === '' || ($ref === null || $ref === '')) {
return null;
}
if ($local && str_starts_with($ref, $base)) {
$ref = substr($ref, strlen($base));
if ($ref === '' || str_starts_with($ref, '//')) {
$ref = '/';
}
if ($ref[0] !== '/') {
$ref = '/' . $ref;
}
return $ref;
}
if ($local) {
return null;
}
return $ref;
}
/**
* Gestionnaire de méthodes manquant, les poignées enveloppent les anciennes méthodes de type isAjax()
*
* @return bool
*
* @throws BadMethodCallException lorsqu'une méthode invalide est appelée.
*/
public function __call(string $name, array $params)
{
if (str_starts_with($name, 'is')) {
$type = strtolower(substr($name, 2));
array_unshift($params, $type);
return $this->is(...$params);
}
throw new BadMethodCallException(sprintf('La méthode "%s()" n\'existe pas', $name));
}
/**
* Vérifiez si une demande est d'un certain type.
*
* Utilise les règles de détection intégrées ainsi que des règles supplémentaires
* défini avec {@link \BlitzPHP\Http\ServerRequest::addDetector()}. Tout détecteur peut être appelé
* comme `is($type)` ou `is$Type()`.
*
* @param list<string>|string $type Le type de requête que vous souhaitez vérifier. S'il s'agit d'un tableau, cette méthode renverra true si la requête correspond à n'importe quel type.
*
* @return bool Si la demande est du type que vous vérifiez.
*/
public function is($type, ...$args): bool
{
if (is_array($type)) {
foreach ($type as $_type) {
if ($this->is($_type)) {
return true;
}
}
return false;
}
$type = strtolower($type);
if (! isset(static::$_detectors[$type])) {
return false;
}
if ($args !== []) {
return $this->_is($type, $args);
}
return $this->_detectorCache[$type] ??= $this->_is($type, $args);
}
/**
* Efface le cache du détecteur d'instance, utilisé par la fonction is()
*/
public function clearDetectorCache(): void
{
$this->_detectorCache = [];
}
/**
* Worker pour la fonction publique is()
*
* @param string $type Le type de requête que vous souhaitez vérifier.
* @param array $args Tableau d'arguments de détecteur personnalisés.
*
* @return bool Si la demande est du type que vous vérifiez.
*/
protected function _is(string $type, array $args): bool
{
$detect = static::$_detectors[$type];
if ($detect instanceof Closure) {
array_unshift($args, $this);
return $detect(...$args);
}
if (isset($detect['env']) && $this->_environmentDetector($detect)) {
return true;
}
if (isset($detect['header']) && $this->_headerDetector($detect)) {
return true;
}
if (isset($detect['accept']) && $this->_acceptHeaderDetector($detect)) {
return true;
}
return isset($detect['param']) && $this->_paramDetector($detect);
}
/**
* Détecte si un en-tête d'acceptation spécifique est présent.
*
* @param array $detect Tableau d'options du détecteur.
*
* @return bool Si la demande est du type que vous vérifiez.
*/
protected function _acceptHeaderDetector(array $detect): bool
{
$acceptHeaders = explode(',', (string) $this->getEnv('HTTP_ACCEPT'));
foreach ($detect['accept'] as $header) {
if (in_array($header, $acceptHeaders, true)) {
return true;
}
}
return false;
}
/**
* Détecte si un en-tête spécifique est présent.
*
* @param array $detect Tableau d'options du détecteur.
*
* @return bool Si la demande est du type que vous vérifiez.
*/
protected function _headerDetector(array $detect): bool
{
foreach ($detect['header'] as $header => $value) {
$header = $this->getEnv('http_' . $header);
if ($header !== null) {
if ($value instanceof Closure) {
return $value($header);
}
return $header === $value;
}
}
return false;
}
/**
* Détecte si un paramètre de requête spécifique est présent.
*
* @param array $detect Tableau d'options du détecteur.
*
* @return bool Si la demande est du type que vous vérifiez.
*/
protected function _paramDetector(array $detect): bool
{
$key = $detect['param'];
if (isset($detect['value'])) {
$value = $detect['value'];
return isset($this->params[$key]) && $this->params[$key] === $value;
}
if (isset($detect['options'])) {
return isset($this->params[$key]) && in_array($this->params[$key], $detect['options'], true);
}
return false;
}
/**
* Détecte si une variable d'environnement spécifique est présente.
*
* @param array $detect Tableau d'options du détecteur.
*
* @return bool Si la demande est du type que vous vérifiez.
*/
protected function _environmentDetector(array $detect): bool
{
if (isset($detect['env'])) {
if (isset($detect['value'])) {
return $this->getEnv($detect['env']) === $detect['value'];
}
if (isset($detect['pattern'])) {
return (bool) preg_match($detect['pattern'], (string) $this->getEnv($detect['env']));
}
if (isset($detect['options'])) {
$pattern = '/' . implode('|', $detect['options']) . '/i';
return (bool) preg_match($pattern, (string) $this->getEnv($detect['env']));
}
}
return false;
}
/**
* Vérifier qu'une requête correspond à tous les types donnés.
*
* Vous permet de tester plusieurs types et d'unir les résultats.
* Voir Request::is() pour savoir comment ajouter des types supplémentaires et le
* types intégrés.
*
* @param list<string> $types Les types à vérifier.
*
* @see ServerRequest::is()
*/
public function isAll(array $types): bool
{
foreach ($types as $type) {
if (! $this->is($type)) {
return false;
}
}
return true;
}
/**
* Ajouter un nouveau détecteur à la liste des détecteurs qu'une requête peut utiliser.
* Il existe plusieurs types de détecteurs différents qui peuvent être réglés.
*
* ### Comparaison des rappels
*
* Les détecteurs de rappel vous permettent de fournir un callable pour gérer le chèque.
* Le rappel recevra l'objet de requête comme seul paramètre.
*
* ```
* addDetector('custom', function ($request) { //Renvoyer un booléen });
* ```
*
* ### Comparaison des valeurs d'environnement
*
* Une comparaison de valeur d'environnement, compare une valeur extraite de `env()` à une valeur connue
* la valeur d'environnement est l'égalité vérifiée par rapport à la valeur fournie.
*
* ```
* addDetector('post', ['env' => 'REQUEST_METHOD', 'value' => 'POST']);
* ```
*
* ### Comparaison des paramètres de demande
*
* Permet des détecteurs personnalisés sur les paramètres de demande.
*
* ```
* addDetector('admin', ['param' => 'prefix', 'value' => 'admin']);
* ```
*
* ### Accepter la comparaison
*
* Permet au détecteur de comparer avec la valeur d'en-tête Accepter.
*
* ```
* addDetector('csv', ['accept' => 'text/csv']);
* ```
*
* ### Comparaison d'en-tête
*
* Permet de comparer un ou plusieurs en-têtes.
*
* ```
* addDetector('fancy', ['header' => ['X-Fancy' => 1]);
* ```
*
* Les types `param`, `env` et de comparaison permettent ce qui suit
* options de comparaison de valeur :
*
* ### Comparaison des valeurs de modèle
*
* La comparaison de valeurs de modèles vous permet de comparer une valeur extraite de `env()` à une expression régulière.
*
* ```
* addDetector('iphone', ['env' => 'HTTP_USER_AGENT', 'pattern' => '/iPhone/i']);
* ```
*
* ### Comparaison basée sur les options
*
* Les comparaisons basées sur des options utilisent une liste d'options pour créer une expression régulière. Appels ultérieurs
* ajouter un détecteur d'options déjà défini fusionnera les options.
*
* ```
* addDetector('mobile', ['env' => 'HTTP_USER_AGENT', 'options' => ['Fennec']]);
* ```
*
* Vous pouvez également comparer plusieurs valeurs
* en utilisant la touche `options`. Ceci est utile lorsque vous souhaitez vérifier
* si une valeur de requête se trouve dans une liste d'options.
*
* `addDetector('extension', ['param' => '_ext', 'options' => ['pdf', 'csv']]`
*
* @param array|callable $detector Un callback ou tableau d'options pour la définition du détecteur.
*/
public static function addDetector(string $name, $detector): void
{
$name = strtolower($name);
if ($detector instanceof Closure) {
static::$_detectors[$name] = $detector;
return;
}
if (isset(static::$_detectors[$name], $detector['options'])) {
/** @var array $data */
$data = static::$_detectors[$name];
$detector = Arr::merge($data, $detector);
}
static::$_detectors[$name] = $detector;
}
/**
* Normaliser un nom d'en-tête dans la version SERVER.
*/
protected function normalizeHeaderName(string $name): string
{
$name = str_replace('-', '_', strtoupper($name));
if (! in_array($name, ['CONTENT_LENGTH', 'CONTENT_TYPE'], true)) {
$name = 'HTTP_' . $name;
}
return $name;
}
/**
* Obtenez tous les en-têtes de la requête.
*
* Renvoie un tableau associatif où les noms d'en-tête sont
* les clés et les valeurs sont une liste de valeurs d'en-tête.
*
* Bien que les noms d'en-tête ne soient pas sensibles à la casse, getHeaders() normalisera
* les en-têtes.
*
* @return array<string, list<string>> Un tableau associatif d'en-têtes et leurs valeurs.
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function getHeaders(): array
{
$headers = [];
foreach ($this->_environment as $key => $value) {
$name = null;
if (str_starts_with($key, 'HTTP_')) {
$name = substr($key, 5);
}
if (str_starts_with($key, 'CONTENT_')) {
$name = $key;
}
if ($name !== null) {
$name = str_replace('_', ' ', strtolower($name));
$name = str_replace(' ', '-', ucwords($name));
$headers[$name] = (array) $value;
}
}
return $headers;
}
/**
* Vérifiez si un en-tête est défini dans la requête.
*
* @param string $name L'en-tête que vous souhaitez obtenir (insensible à la casse)
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function hasHeader(string $name): bool
{
if (isset($this->_environment[$name])) {
return true;
}
if (isset($this->_environment[$this->normalizeHeaderName($name)])) {
return true;
}
return [] !== $this->getHeader($name);
}
/**
* Obtenez un seul en-tête de la requête.
*
* Renvoie la valeur de l'en-tête sous forme de tableau. Si l'en-tête
* n'est pas présent, un tableau vide sera retourné.
*
* @param string $name L'en-tête que vous souhaitez obtenir (insensible à la casse)
*
* @return list<string> Un tableau associatif d'en-têtes et leurs valeurs.
* Si l'en-tête n'existe pas, un tableau vide sera retourné.
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function getHeader(string $name): array
{
if (isset($this->_environment[$name])) {
return (array) $this->_environment[$name];
}
$name = $this->normalizeHeaderName($name);
if (isset($this->_environment[$name])) {
return (array) $this->_environment[$name];
}
return (array) $this->getEnv($name);
}
/**
* Obtenez un seul en-tête sous forme de chaîne à partir de la requête.
*
* @param string $name L'en-tête que vous souhaitez obtenir (insensible à la casse)
*
* @return string Les valeurs d'en-tête sont réduites à une chaîne séparée par des virgules.
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function getHeaderLine(string $name): string
{
$value = $this->getHeader($name);
return implode(', ', $value);
}
/**
* Obtenez une demande modifiée avec l'en-tête fourni.
*
* @param array|string $value
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function withHeader(string $name, $value): static
{
$new = clone $this;
$name = $this->normalizeHeaderName($name);
$new->_environment[$name] = $value;
return $new;
}
/**
* Obtenez une demande modifiée avec l'en-tête fourni.
*
* Les valeurs d'en-tête existantes seront conservées. La valeur fournie
* sera ajouté aux valeurs existantes.
*
* @param array|string $value
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function withAddedHeader(string $name, $value): static
{
$new = clone $this;
$name = $this->normalizeHeaderName($name);
$existing = [];
if (isset($new->_environment[$name])) {
$existing = (array) $new->_environment[$name];
}
$existing = array_merge($existing, (array) $value);
$new->_environment[$name] = $existing;
return $new;
}
/**
* Obtenez une demande modifiée sans en-tête fourni.
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function withoutHeader(string $name): static
{
$new = clone $this;
$name = $this->normalizeHeaderName($name);
unset($new->_environment[$name]);
return $new;
}
/**
* Obtenez la méthode HTTP utilisée pour cette requête.
* Il existe plusieurs manières de spécifier une méthode.
*
* - Si votre client le prend en charge, vous pouvez utiliser des méthodes HTTP natives.
* - Vous pouvez définir l'en-tête HTTP-X-Method-Override.
* - Vous pouvez soumettre une entrée avec le nom `_method`
*
* Chacune de ces 3 approches peut être utilisée pour définir la méthode HTTP utilisée
* par BlitzPHP en interne, et affectera le résultat de cette méthode.
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function getMethod(): string
{
return (string) $this->getEnv('REQUEST_METHOD', $_SERVER['REQUEST_METHOD'] ?? 'GET');
}
/**
* Mettez à jour la méthode de requête et obtenez une nouvelle instance.
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function withMethod(string $method): static
{
$new = clone $this;
if (! preg_match('/^[!#$%&\'*+.^_`\|~0-9a-z-]+$/i', $method)) {
throw new InvalidArgumentException(sprintf(
'Méthode HTTP non prise en charge "%s" fournie',
$method
));
}
$new->_environment['REQUEST_METHOD'] = $method;
return $new;
}
/**
* Obtenez tous les paramètres de l'environnement du serveur.
*
* Lire toutes les données 'environnement' ou 'serveur' qui ont été
* utilisé pour créer cette requête.
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function getServerParams(): array
{
return $this->_environment;
}
/**
* Obtenez tous les paramètres de requête conformément aux spécifications PSR-7. Pour lire des valeurs de requête spécifiques
* utilisez la méthode alternative getQuery().
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function getQueryParams(): array
{
return $this->query;
}
/**
* Mettez à jour les données de la chaîne de requête et obtenez une nouvelle instance.
*
* @param array $query Les données de la chaîne de requête à utiliser
*
* @see http://www.php-fig.org/psr/psr-7/ Cette méthode fait partie de l'interface de requête du serveur PSR-7.
*/
public function withQueryParams(array $query): static
{
$new = clone $this;
$new->query = $query;
return $new;
}
/**
* Obtenez l'hôte sur lequel la demande a été traitée.
*/
public function host(): ?string
{
if ($this->trustProxy && $this->getEnv('HTTP_X_FORWARDED_HOST')) {
return $this->getEnv('HTTP_X_FORWARDED_HOST');
}
return $this->getEnv('HTTP_HOST');
}
/**
* Obtenez le port sur lequel la demande a été traitée.
*/
public function port(): ?string
{
if ($this->trustProxy && $this->getEnv('HTTP_X_FORWARDED_PORT')) {
return $this->getEnv('HTTP_X_FORWARDED_PORT');
}
return $this->getEnv('SERVER_PORT');
}
/**
* Obtenez le schéma d'URL actuel utilisé pour la demande.
*
* par exemple. 'http' ou 'https'
*/
public function scheme(): ?string
{
if ($this->trustProxy && $this->getEnv('HTTP_X_FORWARDED_PROTO')) {
return $this->getEnv('HTTP_X_FORWARDED_PROTO');
}
return $this->getEnv('HTTPS') ? 'https' : 'http';
}
/**
* Obtenez le nom de domaine et incluez les segments $tldLength du tld.
*
* @param int $tldLength Nombre de segments que contient votre tld. Par exemple : `example.com` contient 1 tld.
* Alors que `example.co.uk` contient 2.
*
* @return string Nom de domaine sans sous-domaines.
*/
public function domain(int $tldLength = 1): string
{
if (empty($host = $this->host())) {
return '';
}
$segments = explode('.', $host);
$domain = array_slice($segments, -1 * ($tldLength + 1));
return implode('.', $domain);
}