Skip to content

Fix incompatibility with laminas-escaper (2.7.1) #33353

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 5 commits into from
Jul 30, 2021
Merged

Fix incompatibility with laminas-escaper (2.7.1) #33353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
64e6731
cast incoming untyped parameters to string type
tufahu Jun 25, 2021
94e140f
add unit tests for encodeUrlParam and escapeCss methods
tufahu Jun 25, 2021
a8c323c
move type cast from Escaper to RouteParamsResolver and add type hints
tufahu Jun 28, 2021
9f2af73
Apply suggestions from code review
tufahu Jul 6, 2021
733dec5
Fix incompatibility with laminas-escaper (2.7.1)
ihor-sviziev Jul 30, 2021
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
4 changes: 2 additions & 2 deletions lib/internal/Magento/Framework/Escaper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ public function escapeUrl($string)
*/
public function encodeUrlParam($string)
{
return $this->getEscaper()->escapeUrl($string);
return $this->getEscaper()->escapeUrl((string)$string);
}

/**
Expand Down Expand Up @@ -330,7 +330,7 @@ function ($matches) {
*/
public function escapeCss($string)
{
return $this->getEscaper()->escapeCss($string);
return $this->getEscaper()->escapeCss((string)$string);
}

/**
Expand Down
70 changes: 70 additions & 0 deletions lib/internal/Magento/Framework/Test/Unit/EscaperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,76 @@ public function testEscapeUrl(string $data, string $expected): void
$this->assertEquals($expected, $this->escaper->escapeUrl($expected));
}

/**
* @covers \Magento\Framework\Escaper::escapeCss
*
* @param string $data
* @param string $expected
* @return void
*
* @dataProvider escapeCssDataProvider
*/
public function testEscapeCss($data, string $expected): void
{
$this->assertEquals($expected, $this->escaper->escapeCss($data));
}

/**
* @return array
*/
public function escapeCssDataProvider(): array
{
return [
[
'data' => 1,
'expected' => '1',
],
[
'data' => '*%string{foo}%::',
'expected' => '\2A \25 string\7B foo\7D \25 \3A \3A ',
]
];
}

/**
* @covers \Magento\Framework\Escaper::encodeUrlParam
*
* @param string $data
* @param string $expected
* @return void
*
* @dataProvider encodeUrlParamDataProvider
*/
public function testEncodeUrlParam($data, string $expected): void
{
$this->assertEquals($expected, $this->escaper->encodeUrlParam($data));
}

/**
* @return array
*/
public function encodeUrlParamDataProvider(): array
{
return [
[
'data' => "a3==",
'expected' => "a3%3D%3D",
],
[
'data' => "example string",
'expected' => "example%20string",
],
[
'data' => 1,
'expected' => "1",
],
[
'data' => null,
'expected' => "",
]
];
}

/**
* @return array
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/Magento/Framework/Url/RouteParamsResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ public function setRouteParams(array $data, $unsetOldParams = true)
} else {
$this->setRouteParam(
$this->getEscaper()->encodeUrlParam($key),
$this->getEscaper()->encodeUrlParam($value)
$this->getEscaper()->encodeUrlParam((string)$value)
);
}
}
Expand Down