Skip to content

Add validation for non-string keys in ViewTrait::withRenderers() #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samdark merged 4 commits into from
Jan 15, 2026
Merged

Add validation for non-string keys in ViewTrait::withRenderers() #296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bc75770
Initial plan
Copilot Jan 14, 2026
5f1e91e
Add validation and tests for numeric keys in withRenderers
Copilot Jan 14, 2026
176f2b5
Fix expected error message to use 'int' instead of 'integer'
Copilot Jan 14, 2026
beb2880
Fix testImmutability to use string key for renderer
Copilot Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/ViewTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,16 @@
public function withRenderers(array $renderers): static
{
foreach ($renderers as $extension => $renderer) {
if (!is_string($extension)) {

Check failure on line 91 in src/ViewTrait.php

View workflow job for this annotation

GitHub Actions / psalm / PHP 8.3-ubuntu-latest

DocblockTypeContradiction 

src/ViewTrait.php:91:18: DocblockTypeContradiction: Docblock-defined type string for $extension is always string (see https://psalm.dev/155)

Check failure on line 91 in src/ViewTrait.php

View workflow job for this annotation

GitHub Actions / psalm / PHP 8.2-ubuntu-latest

DocblockTypeContradiction 

src/ViewTrait.php:91:18: DocblockTypeContradiction: Docblock-defined type string for $extension is always string (see https://psalm.dev/155)

Check failure on line 91 in src/ViewTrait.php

View workflow job for this annotation

GitHub Actions / psalm / PHP 8.1-ubuntu-latest

DocblockTypeContradiction 

src/ViewTrait.php:91:18: DocblockTypeContradiction: Docblock-defined type string for $extension is always string (see https://psalm.dev/155)
throw new InvalidArgumentException(
sprintf(
'Extension must be a non-empty string, %s provided for %s.',
get_debug_type($extension),
$renderer::class
)
);
}

if ($extension === '') {
throw new InvalidArgumentException(
sprintf(
Expand Down
30 changes: 29 additions & 1 deletion tests/ViewTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,34 @@ public function testWithRenderersInvalidRendererTypeThrowsException(): void
]);
}

public function testWithRenderersNumericKeyImplicitThrowsException(): void
{
$view = TestHelper::createView();

$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage(
'Extension must be a non-empty string, int provided for ' . PhpTemplateRenderer::class . '.'
);

$view->withRenderers([
new PhpTemplateRenderer(),
]);
}

public function testWithRenderersNumericKeyExplicitThrowsException(): void
{
$view = TestHelper::createView();

$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage(
'Extension must be a non-empty string, int provided for ' . PhpTemplateRenderer::class . '.'
);

$view->withRenderers([
0 => new PhpTemplateRenderer(),
]);
}

public function testLocalize(): void
{
$view = $this->createViewWithBasePath($this->tempDirectory);
Expand Down Expand Up @@ -628,7 +656,7 @@ public function testImmutability(): void
$view = TestHelper::createView();

$this->assertNotSame($view, $view->withBasePath(''));
$this->assertNotSame($view, $view->withRenderers([new PhpTemplateRenderer()]));
$this->assertNotSame($view, $view->withRenderers(['php' => new PhpTemplateRenderer()]));
$this->assertNotSame($view, $view->withSourceLocale('en'));
$this->assertNotSame($view, $view->withContext($this->createContext($this->tempDirectory)));
$this->assertNotSame($view, $view->withContextPath(__DIR__));
Expand Down
Loading