Skip to content

Remove unnecessary functionality from escapeOrCleanHtml #4320

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
merged 6 commits into from
Apr 2, 2025
Merged

Remove unnecessary functionality from escapeOrCleanHtml #4320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
944866a
Make escapeOrCleanHtml more tolerant of null values.
demiankatz Apr 1, 2025
a03a07f
Improve comment.
demiankatz Apr 1, 2025
7b85d51
Might as well check ALL arguments.
demiankatz Apr 1, 2025
9337c7c
Simplify helper; improve typing.
demiankatz Apr 2, 2025
ab51736
Style.
demiankatz Apr 2, 2025
4c0db57
Merge branch 'dev' into fix-escapeorcleanhtml-null-handling
demiankatz Apr 2, 2025
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
16 changes: 7 additions & 9 deletions module/VuFind/src/VuFind/View/Helper/Root/EscapeOrCleanHtml.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,20 @@ public function __construct(protected Escaper $escaper, protected CleanHtml $cle
/**
* Invoke this helper: escape a value
*
* @param ?string $value Value to escape
* @param ?string $dataContext Data context (for fields that allow sanitized HTML)
* @param ?bool $allowHtml Whether to allow sanitized HTML if passed a PropertyString
* @param string $renderingContext Rendering context for cleaning HTML
* @param string|PropertyStringInterface $value Value to escape
* @param ?string $dataContext Data context (for fields that allow sanitized HTML)
* @param ?bool $allowHtml Whether to allow sanitized HTML if passed a
* PropertyString
* @param string $renderingContext Rendering context for cleaning HTML
*
* @return mixed Given a string, returns an escaped string, otherwise returns self
* @return mixed Returns an escaped or HTML-safe string
*/
public function __invoke(
$value = null,
string|PropertyStringInterface $value,
?string $dataContext = null,
?bool $allowHtml = null,
string $renderingContext = 'default'
) {
if (null === $value) {
return $this;
}
if ($value instanceof PropertyStringInterface) {
if (
($allowHtml ?? ($dataContext && ($this->htmlContexts[$dataContext] ?? false)))
Expand Down
13 changes: 0 additions & 13 deletions module/VuFind/tests/unit-tests/src/VuFindTest/View/Helper/Root/EscapeOrCleanHtmlTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,17 +110,4 @@ public function testEscapeOrCleanHtml(
$result = $escapeOrCleanHtml($input, $dataContext, $allowHtml, $renderingContext);
$this->assertEquals($expected, $result);
}

/**
* Test invoking without parameters
*
* @return void
*/
public function testInvokeWithoutParameters(): void
{
$escaper = new Escaper(false);
$cleanHtml = $this->createCleanHtmlHelper();
$escapeOrCleanHtml = new EscapeOrCleanHtml($escaper, $cleanHtml, []);
$this->assertEquals($escapeOrCleanHtml, $escapeOrCleanHtml());
}
}