|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Zenstruck\Browser; |
|
4
|
|
|
|
|
5
|
|
|
use Behat\Mink\Session; |
|
6
|
|
|
use Symfony\Component\VarDumper\VarDumper; |
|
7
|
|
|
use Zenstruck\Assert; |
|
8
|
|
|
use Zenstruck\Browser\Response\DomResponse; |
|
9
|
|
|
use Zenstruck\Browser\Response\HtmlResponse; |
|
10
|
|
|
use Zenstruck\Browser\Response\JsonResponse; |
|
11
|
|
|
use Zenstruck\Browser\Response\XmlResponse; |
|
12
|
|
|
|
|
13
|
|
|
/** |
|
14
|
|
|
* @author Kevin Bond <[email protected]> |
|
15
|
|
|
*/ |
|
16
|
|
|
class Response |
|
17
|
|
|
{ |
|
18
|
|
|
private Session $session; |
|
19
|
|
|
|
|
20
|
|
|
/** |
|
21
|
|
|
* @internal |
|
22
|
|
|
*/ |
|
23
|
|
|
final public function __construct(Session $session) |
|
24
|
|
|
{ |
|
25
|
|
|
$this->session = $session; |
|
26
|
|
|
} |
|
27
|
|
|
|
|
28
|
|
|
final public function statusCode(): int |
|
29
|
|
|
{ |
|
30
|
|
|
return $this->session->getStatusCode(); |
|
31
|
|
|
} |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* @internal |
|
35
|
|
|
*/ |
|
36
|
|
|
final public static function createFor(Session $session): self |
|
37
|
|
|
{ |
|
38
|
|
|
$contentType = (string) $session->getResponseHeader('content-type'); |
|
39
|
|
|
|
|
40
|
|
|
if (str_contains($contentType, 'json')) { |
|
41
|
|
|
return new JsonResponse($session); |
|
42
|
|
|
} |
|
43
|
|
|
|
|
44
|
|
|
if (str_contains($contentType, 'html')) { |
|
45
|
|
|
return new HtmlResponse($session); |
|
46
|
|
|
} |
|
47
|
|
|
|
|
48
|
|
|
if (str_contains($contentType, 'xml')) { |
|
49
|
|
|
return new XmlResponse($session); |
|
50
|
|
|
} |
|
51
|
|
|
|
|
52
|
|
|
return new self($session); |
|
53
|
|
|
} |
|
54
|
|
|
|
|
55
|
|
|
final public function body(): string |
|
56
|
|
|
{ |
|
57
|
|
|
return $this->session->getPage()->getContent(); |
|
58
|
|
|
} |
|
59
|
|
|
|
|
60
|
|
|
final public function assertJson(): JsonResponse |
|
61
|
|
|
{ |
|
62
|
|
|
if (!$this instanceof JsonResponse) { |
|
63
|
|
|
Assert::fail('Not a json response.'); |
|
64
|
|
|
} |
|
65
|
|
|
|
|
66
|
|
|
return $this; |
|
67
|
|
|
} |
|
68
|
|
|
|
|
69
|
|
|
final public function assertXml(): XmlResponse |
|
70
|
|
|
{ |
|
71
|
|
|
if (!$this instanceof XmlResponse) { |
|
72
|
|
|
Assert::fail('Not an xml response.'); |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
return $this; |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
final public function assertHtml(): HtmlResponse |
|
79
|
|
|
{ |
|
80
|
|
|
if (!$this instanceof HtmlResponse) { |
|
81
|
|
|
Assert::fail('Not an html response.'); |
|
82
|
|
|
} |
|
83
|
|
|
|
|
84
|
|
|
return $this; |
|
85
|
|
|
} |
|
86
|
|
|
|
|
87
|
|
|
final public function assertDom(): DomResponse |
|
88
|
|
|
{ |
|
89
|
|
|
if (!$this instanceof DomResponse) { |
|
90
|
|
|
Assert::fail('Not an DOM response.'); |
|
91
|
|
|
} |
|
92
|
|
|
|
|
93
|
|
|
return $this; |
|
94
|
|
|
} |
|
95
|
|
|
|
|
96
|
|
|
final public function raw(): string |
|
97
|
|
|
{ |
|
98
|
|
|
return "{$this->rawMetadata()}\n{$this->rawBody()}"; |
|
99
|
|
|
} |
|
100
|
|
|
|
|
101
|
|
|
final public function isSuccessful(): bool |
|
102
|
|
|
{ |
|
103
|
|
|
return $this->statusCode() >= 200 && $this->statusCode() < 300; |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
|
|
final public function isRedirect(): bool |
|
107
|
|
|
{ |
|
108
|
|
|
return $this->statusCode() >= 300 && $this->statusCode() < 400; |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
public function dump(?string $selector = null): void |
|
112
|
|
|
{ |
|
113
|
|
|
if (null !== $selector) { |
|
114
|
|
|
throw new \LogicException('$selector cannot be used with this response type.'); |
|
115
|
|
|
} |
|
116
|
|
|
|
|
117
|
|
|
VarDumper::dump($this->raw()); |
|
118
|
|
|
} |
|
119
|
|
|
|
|
120
|
|
|
/** |
|
121
|
|
|
* @internal |
|
122
|
|
|
*/ |
|
123
|
|
|
final protected function session(): Session |
|
124
|
|
|
{ |
|
125
|
|
|
return $this->session; |
|
126
|
|
|
} |
|
127
|
|
|
|
|
128
|
|
|
/** |
|
129
|
|
|
* @internal |
|
130
|
|
|
*/ |
|
131
|
|
|
protected function rawMetadata(): string |
|
132
|
|
|
{ |
|
133
|
|
|
$ret = "URL: {$this->session->getCurrentUrl()} ({$this->statusCode()})\n\n"; |
|
134
|
|
|
|
|
135
|
|
|
foreach ($this->session->getResponseHeaders() as $header => $values) { |
|
136
|
|
|
foreach ($values as $value) { |
|
137
|
|
|
$ret .= "{$header}: {$value}\n"; |
|
138
|
|
|
} |
|
139
|
|
|
} |
|
140
|
|
|
|
|
141
|
|
|
return $ret; |
|
142
|
|
|
} |
|
143
|
|
|
|
|
144
|
|
|
/** |
|
145
|
|
|
* @internal |
|
146
|
|
|
*/ |
|
147
|
|
|
protected function rawBody(): string |
|
148
|
|
|
{ |
|
149
|
|
|
return $this->body(); |
|
150
|
|
|
} |
|
151
|
|
|
} |
|
152
|
|
|
|
zenstruck /
browser
