Skip to content

Commit ee71d44

Browse files
odanodan
authored
Ensure fetchTemplate method always returns string (#107)
* Fix doc blocks and code style * Ensure fetchTemplate method always returns string * Update section Exceptions * Optimize tests * Change phpstan level from 5 to 9
1 parent 45a4b88 commit ee71d44

File tree

4 files changed

+71
-46
lines changed

4 files changed

+71
-46
lines changed

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,5 +199,7 @@ Hello <?= html($name) ?>
199199

200200
## Exceptions
201201

202-
* `\RuntimeException` - If template does not exist
202+
* `\Slim\Views\Exception\PhpTemplateNotFoundException` - If template layout does not exist
203+
* `\Slim\Views\Exception\PhpTemplateNotFoundException` - If template does not exist
204+
* `\RuntimeException` - If the template output could not be fetched
203205
* `\InvalidArgumentException` - If $data contains 'template'

‎phpstan.neon‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
parameters:
2-
level: 5
2+
level: 8
33
paths:
44
- src
55
- tests

‎src/PhpRenderer.php‎

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,24 @@
1212

1313
use InvalidArgumentException;
1414
use Psr\Http\Message\ResponseInterface;
15+
use RuntimeException;
1516
use Slim\Views\Exception\PhpTemplateNotFoundException;
1617
use Throwable;
1718

1819
class PhpRenderer
1920
{
2021
protected string $templatePath;
2122

23+
/**
24+
* @var array<string, mixed>
25+
*/
2226
protected array $attributes;
2327

2428
protected string $layout;
2529

2630
/**
2731
* @param string $templatePath
28-
* @param array $attributes
32+
* @param array<string, mixed> $attributes
2933
* @param string $layout
3034
*/
3135
public function __construct(string $templatePath = '', array $attributes = [], string $layout = '')
@@ -37,12 +41,12 @@ public function __construct(string $templatePath = '', array $attributes = [], s
3741

3842
/**
3943
* @param ResponseInterface $response
40-
* @param string $template
41-
* @param array $data
42-
*
43-
* @return ResponseInterface
44+
* @param string $template
45+
* @param array<string, mixed> $data
4446
*
4547
* @throws Throwable
48+
*
49+
* @return ResponseInterface
4650
*/
4751
public function render(ResponseInterface $response, string $template, array $data = []): ResponseInterface
4852
{
@@ -59,16 +63,12 @@ public function getLayout(): string
5963
return $this->layout;
6064
}
6165

62-
/**
63-
* @param string $layout
64-
*/
65-
6666
/**
6767
* @param string $layout
6868
*
69-
* @return void
70-
*
7169
* @throws PhpTemplateNotFoundException
70+
*
71+
* @return void
7272
*/
7373
public function setLayout(string $layout): void
7474
{
@@ -80,15 +80,15 @@ public function setLayout(string $layout): void
8080
}
8181

8282
/**
83-
* @return array
83+
* @return array<string, mixed>
8484
*/
8585
public function getAttributes(): array
8686
{
8787
return $this->attributes;
8888
}
8989

9090
/**
91-
* @param array $attributes
91+
* @param array<string, mixed> $attributes
9292
*
9393
* @return void
9494
*/
@@ -99,7 +99,7 @@ public function setAttributes(array $attributes): void
9999

100100
/**
101101
* @param string $key
102-
* @param $value
102+
* @param mixed $value
103103
*
104104
* @return void
105105
*/
@@ -140,12 +140,12 @@ public function setTemplatePath(string $templatePath): void
140140

141141
/**
142142
* @param string $template
143-
* @param array $data
144-
* @param bool $useLayout
145-
*
146-
* @return string
143+
* @param array<string, mixed> $data
144+
* @param bool $useLayout
147145
*
148146
* @throws Throwable
147+
*
148+
* @return string
149149
*/
150150
public function fetch(string $template, array $data = [], bool $useLayout = false): string
151151
{
@@ -160,11 +160,11 @@ public function fetch(string $template, array $data = [], bool $useLayout = fals
160160

161161
/**
162162
* @param string $template
163-
* @param array $data
164-
*
165-
* @return string
163+
* @param array<string, mixed> $data
166164
*
167165
* @throws Throwable
166+
*
167+
* @return string
168168
*/
169169
public function fetchTemplate(string $template, array $data = []): string
170170
{
@@ -173,15 +173,19 @@ public function fetchTemplate(string $template, array $data = []): string
173173
}
174174

175175
if (!$this->templateExists($template)) {
176-
throw new PhpTemplateNotFoundException('View cannot render "' . $template
177-
. '" because the template does not exist');
176+
throw new PhpTemplateNotFoundException(
177+
'View cannot render "' . $template . '" because the template does not exist'
178+
);
178179
}
179180

180181
$data = array_merge($this->attributes, $data);
181182
try {
182183
ob_start();
183184
$this->protectedIncludeScope($this->templatePath . $template, $data);
184185
$output = ob_get_clean();
186+
if ($output === false) {
187+
throw new RuntimeException('Failed to fetch the template output');
188+
}
185189
} catch (Throwable $e) {
186190
ob_end_clean();
187191
throw $e;
@@ -205,7 +209,7 @@ public function templateExists(string $template): bool
205209

206210
/**
207211
* @param string $template
208-
* @param array $data
212+
* @param array<string, mixed> $data
209213
*
210214
* @return void
211215
*/

‎tests/PhpRendererTest.php‎

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,15 @@
1818
use Slim\Views\Exception\PhpTemplateNotFoundException;
1919
use Slim\Views\PhpRenderer;
2020
use Throwable;
21+
use UnexpectedValueException;
2122

2223
class PhpRendererTest extends TestCase
2324
{
2425
public function testRenderer(): void
2526
{
2627
$renderer = new PhpRenderer(__DIR__ . '/_files/');
2728
$headers = new Headers();
28-
$body = new Stream(fopen('php://temp', 'r+'));
29+
$body = $this->createStream();
2930
$response = new Response(200, $headers, $body);
3031
$newResponse = $renderer->render($response, 'template.phtml', ['hello' => 'Hi']);
3132
$newResponse->getBody()->rewind();
@@ -36,7 +37,7 @@ public function testRenderConstructor(): void
3637
{
3738
$renderer = new PhpRenderer(__DIR__ . '/_files');
3839
$headers = new Headers();
39-
$body = new Stream(fopen('php://temp', 'r+'));
40+
$body = $this->createStream();
4041
$response = new Response(200, $headers, $body);
4142
$newResponse = $renderer->render($response, 'template.phtml', ['hello' => 'Hi']);
4243
$newResponse->getBody()->rewind();
@@ -45,12 +46,11 @@ public function testRenderConstructor(): void
4546

4647
public function testAttributeMerging(): void
4748
{
48-
4949
$renderer = new PhpRenderer(__DIR__ . '/_files/', [
5050
'hello' => 'Hello'
5151
]);
5252
$headers = new Headers();
53-
$body = new Stream(fopen('php://temp', 'r+'));
53+
$body = $this->createStream();
5454
$response = new Response(200, $headers, $body);
5555
$newResponse = $renderer->render($response, 'template.phtml', [
5656
'hello' => 'Hi'
@@ -63,12 +63,12 @@ public function testExceptionInTemplate(): void
6363
{
6464
$renderer = new PhpRenderer(__DIR__ . '/_files/');
6565
$headers = new Headers();
66-
$body = new Stream(fopen('php://temp', 'r+'));
66+
$body = $this->createStream();
6767
$response = new Response(200, $headers, $body);
6868
try {
6969
$newResponse = $renderer->render($response, 'exception_layout.phtml');
7070
} catch (Throwable $t) {
71-
// Simulates an error template
71+
// Simulates an error template
7272
$newResponse = $renderer->render($response, 'template.phtml', [
7373
'hello' => 'Hi'
7474
]);
@@ -82,7 +82,7 @@ public function testExceptionForTemplateInData(): void
8282
{
8383
$renderer = new PhpRenderer(__DIR__ . '/_files/');
8484
$headers = new Headers();
85-
$body = new Stream(fopen('php://temp', 'r+'));
85+
$body = $this->createStream();
8686
$response = new Response(200, $headers, $body);
8787
$this->expectException(InvalidArgumentException::class);
8888
$renderer->render($response, 'template.phtml', [
@@ -94,7 +94,7 @@ public function testTemplateNotFound(): void
9494
{
9595
$renderer = new PhpRenderer(__DIR__ . '/_files/');
9696
$headers = new Headers();
97-
$body = new Stream(fopen('php://temp', 'r+'));
97+
$body = $this->createStream();
9898
$response = new Response(200, $headers, $body);
9999
$this->expectException(PhpTemplateNotFoundException::class);
100100
$renderer->render($response, 'adfadftemplate.phtml', []);
@@ -105,37 +105,43 @@ public function testLayout(): void
105105
$renderer = new PhpRenderer(__DIR__ . '/_files/', ['title' => 'My App']);
106106
$renderer->setLayout('layout.phtml');
107107
$headers = new Headers();
108-
$body = new Stream(fopen('php://temp', 'r+'));
108+
$body = $this->createStream();
109109
$response = new Response(200, $headers, $body);
110110
$newResponse = $renderer->render($response, 'template.phtml', ['title' => 'Hello - My App', 'hello' => 'Hi']);
111111
$newResponse->getBody()->rewind();
112-
$this->assertEquals('<html><head><title>Hello - My App</title></head><body>Hi<footer>This is the footer'
113-
. '</footer></body></html>', $newResponse->getBody()->getContents());
112+
$this->assertEquals(
113+
'<html><head><title>Hello - My App</title></head><body>Hi<footer>This is the footer'
114+
. '</footer></body></html>',
115+
$newResponse->getBody()->getContents()
116+
);
114117
}
115118

116119
public function testLayoutConstructor(): void
117120
{
118121
$renderer = new PhpRenderer(__DIR__ . '/_files', ['title' => 'My App'], 'layout.phtml');
119122
$headers = new Headers();
120-
$body = new Stream(fopen('php://temp', 'r+'));
123+
$body = $this->createStream();
121124
$response = new Response(200, $headers, $body);
122125
$newResponse = $renderer->render($response, 'template.phtml', ['title' => 'Hello - My App', 'hello' => 'Hi']);
123126
$newResponse->getBody()->rewind();
124-
$this->assertEquals('<html><head><title>Hello - My App</title></head><body>Hi<footer>This is the footer'
125-
. '</footer></body></html>', $newResponse->getBody()->getContents());
127+
$this->assertEquals(
128+
'<html><head><title>Hello - My App</title></head><body>Hi<footer>This is the footer'
129+
. '</footer></body></html>',
130+
$newResponse->getBody()->getContents()
131+
);
126132
}
127133

128134
public function testExceptionInLayout(): void
129135
{
130136
$renderer = new PhpRenderer(__DIR__ . '/_files/');
131137
$renderer->setLayout('exception_layout.phtml');
132138
$headers = new Headers();
133-
$body = new Stream(fopen('php://temp', 'r+'));
139+
$body = $this->createStream();
134140
$response = new Response(200, $headers, $body);
135141
try {
136142
$newResponse = $renderer->render($response, 'template.phtml');
137143
} catch (Throwable $t) {
138-
// PHP 7+
144+
// PHP 7+
139145
// Simulates an error template
140146
$renderer->setLayout('');
141147
$newResponse = $renderer->render($response, 'template.phtml', [
@@ -159,22 +165,35 @@ public function testContentDataKeyShouldBeIgnored(): void
159165
$renderer = new PhpRenderer(__DIR__ . '/_files/');
160166
$renderer->setLayout('layout.phtml');
161167
$headers = new Headers();
162-
$body = new Stream(fopen('php://temp', 'r+'));
168+
$body = $this->createStream();
163169
$response = new Response(200, $headers, $body);
164170
$newResponse = $renderer->render(
165171
$response,
166172
'template.phtml',
167173
['title' => 'Hello - My App', 'hello' => 'Hi', 'content' => 'Ho']
168174
);
169175
$newResponse->getBody()->rewind();
170-
$this->assertEquals('<html><head><title>Hello - My App</title></head><body>Hi<footer>This is the footer'
171-
. '</footer></body></html>', $newResponse->getBody()->getContents());
176+
$this->assertEquals(
177+
'<html><head><title>Hello - My App</title></head><body>Hi<footer>This is the footer'
178+
. '</footer></body></html>',
179+
$newResponse->getBody()->getContents()
180+
);
172181
}
173182

174-
public function testTemplateExists()
183+
public function testTemplateExists(): void
175184
{
176185
$renderer = new PhpRenderer(__DIR__ . '/_files/');
177186
$this->assertTrue($renderer->templateExists('layout.phtml'));
178187
$this->assertFalse($renderer->templateExists('non-existant-template'));
179188
}
189+
190+
private function createStream(): Stream
191+
{
192+
$resource = fopen('php://temp', 'r+');
193+
if ($resource === false) {
194+
throw new UnexpectedValueException();
195+
}
196+
197+
return new Stream($resource);
198+
}
180199
}

0 commit comments

Comments
 (0)