Skip to content

Add beforeInput() and afterInput() methods to BooleanInputTag #276

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
vjik merged 1 commit into from
Jun 4, 2026
Merged

Add beforeInput() and afterInput() methods to BooleanInputTag #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## 4.1.1 under development

- no changes in this release.
- New #276: Add `beforeInput()` and `afterInput()` methods to abstract `BooleanInputTag`, extended by `Radio`
and `Checkbox` (@vjik)

## 4.1.0 May 19, 2026

Expand Down
41 changes: 36 additions & 5 deletions src/Tag/Base/BooleanInputTag.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
private array $labelAttributes = [];
private bool $labelWrap = true;
private bool $labelEncode = true;
private string|Stringable $beforeInput = '';
private string|Stringable $afterInput = '';

/**
* @link https://www.w3.org/TR/html52/sec-forms.html#element-attrdef-input-checked
Expand Down Expand Up @@ -86,6 +88,26 @@
return $new;
}

/**
* @param string|Stringable $content Content to be rendered before the input.
*/
final public function beforeInput(string|Stringable $content): static
{
$new = clone $this;
$new->beforeInput = $content;
return $new;
}

/**
* @param string|Stringable $content Content to be rendered after the input.
*/
final public function afterInput(string|Stringable $content): static
{
$new = clone $this;
$new->afterInput = $content;
return $new;
}

final protected function prepareAttributes(): void
{
$this->attributes['type'] = $this->getType();
Expand All @@ -97,23 +119,32 @@
? null
: Html::generateId();

return $this->renderUncheckInput()
. ($this->labelWrap ? $this->renderLabelOpenTag($this->labelAttributes) : '');
$html = $this->renderUncheckInput();

if ($this->labelWrap) {
$html .= $this->renderLabelOpenTag($this->labelAttributes);
}

$html .= $this->beforeInput;

return $html;
}

final protected function after(): string
{
$html = (string) $this->afterInput;

if ($this->label === null) {
return '';
return $html;
}

if ($this->labelWrap) {
$html = $this->label === '' ? '' : ' ';
$html .= $this->label === '' ? '' : ' ';
} else {
$labelAttributes = array_merge($this->labelAttributes, [
'for' => $this->attributes['id'],
]);
$html = ' ' . $this->renderLabelOpenTag($labelAttributes);
$html .= ' ' . $this->renderLabelOpenTag($labelAttributes);
}

$html .= $this->labelEncode ? Html::encode($this->label) : $this->label;
Expand All @@ -127,7 +158,7 @@

private function renderUncheckInput(): string
{
$name = (string) ($this->attributes['name'] ?? '');

Check warning on line 161 in src/Tag/Base/BooleanInputTag.php

View workflow job for this annotation

GitHub Actions / mutation / PHP 8.5-ubuntu-latest 

Escaped Mutant for Mutator "CastString":

@@ @@
 
     private function renderUncheckInput(): string
     {
-        $name = (string) ($this->attributes['name'] ?? '');
+        $name = $this->attributes['name'] ?? '';
         if (empty($name) || $this->uncheckValue === null) {
             return '';
         }
if (empty($name) || $this->uncheckValue === null) {
return '';
}
Expand Down
127 changes: 127 additions & 0 deletions tests/Tag/Base/BooleanInputTagTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@

use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Stringable;
use Yiisoft\Html\IdGenerator;
use Yiisoft\Html\Tests\Objects\StringableObject;
use Yiisoft\Html\Tests\Objects\TestBooleanInputTag;

final class BooleanInputTagTest extends TestCase
Expand Down Expand Up @@ -226,6 +229,128 @@ public function testUncheckValueWithLabel(): void
);
}

public static function dataBeforeInput(): iterable
{
yield [
'Before',
'Before',
];
yield [
'<span>Before</span>',
'<span>Before</span>',
];
yield [
'Before',
new StringableObject('Before'),
];
yield [
'<span>Before</span>',
new StringableObject('<span>Before</span>'),
];
}

#[DataProvider('dataBeforeInput')]
public function testBeforeInput(string $expectedBefore, string|Stringable $content): void
{
$input = (new TestBooleanInputTag())->beforeInput($content);
$this->assertSame(
$expectedBefore . '<input type="test">',
(string) $input,
);
}

public function testBeforeInputWithLabel(): void
{
$input = (new TestBooleanInputTag())
->label('One')
->beforeInput('Before');
$this->assertSame(
'<label>Before<input type="test"> One</label>',
(string) $input,
);
}

public function testBeforeInputWithSideLabel(): void
{
IdGenerator\disableSeed();
IdGenerator\reset();

try {
$result = (new TestBooleanInputTag())
->sideLabel('One')
->beforeInput('Before')
->render();
} finally {
IdGenerator\enableSeed();
}

$this->assertSame(
'Before<input id="i1" type="test"> <label for="i1">One</label>',
$result,
);
}

public static function dataAfterInput(): iterable
{
yield [
'After',
'After',
];
yield [
'<span>After</span>',
'<span>After</span>',
];
yield [
'After',
new StringableObject('After'),
];
yield [
'<span>After</span>',
new StringableObject('<span>After</span>'),
];
}

#[DataProvider('dataAfterInput')]
public function testAfterInput(string $expectedAfter, string|Stringable $content): void
{
$input = (new TestBooleanInputTag())->AfterInput($content);
$this->assertSame(
'<input type="test">' . $expectedAfter,
(string) $input,
);
}

public function testAfterInputWithLabel(): void
{
$input = (new TestBooleanInputTag())
->label('One')
->afterInput('After');
$this->assertSame(
'<label><input type="test">After One</label>',
(string) $input,
);
}

public function testAfterInputWithSideLabel(): void
{
IdGenerator\disableSeed();
IdGenerator\reset();

try {
$result = (new TestBooleanInputTag())
->sideLabel('One')
->afterInput('After')
->render();
} finally {
IdGenerator\enableSeed();
}

$this->assertSame(
'<input id="i1" type="test">After <label for="i1">One</label>',
$result,
);
}

public function testImmutability(): void
{
$input = new TestBooleanInputTag();
Expand All @@ -234,5 +359,7 @@ public function testImmutability(): void
$this->assertNotSame($input, $input->sideLabel(''));
$this->assertNotSame($input, $input->labelEncode(true));
$this->assertNotSame($input, $input->uncheckValue(null));
$this->assertNotSame($input, $input->beforeInput(''));
$this->assertNotSame($input, $input->afterInput(''));
}
}
Loading