Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit e20e5b7

Browse files
committed
Fixed PHP code doc blocks
1 parent d51dd6c commit e20e5b7

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

src/guides/v2.3/extension-dev-guide/framework/url-library.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The [`Magento\Framework\Url\EncoderInterface`]({{ site.mage2bloburl }}/{{ page.g
2525

2626
The [`Magento\Framework\Url\DecoderInterface`]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/Url/DecoderInterface.php){:target="_blank"} provides a method to `decode` the base64 encoded URL provided to it and also decodes the special characters described in the table below.
2727

28-
|Special Character|Encoded Value|
28+
|Special Character|Decoded Value|
2929
|--- |--- |
3030
| `-` | `+` |
3131
| `_` | `/` |
@@ -49,7 +49,12 @@ private $encoder;
4949
*/
5050
private $decoder;
5151

52-
52+
/**
53+
* QuickCartTaxInput constructor.
54+
*
55+
* @param EncoderInterface $encoder
56+
* @param DecoderInterface $decoder
57+
*/
5358
public function __construct(
5459
EncoderInterface $encoder,
5560
DecoderInterface $decoder
@@ -59,19 +64,26 @@ public function __construct(
5964
}
6065

6166
/**
62-
* Encodes URL to base64 format and escapes special characters
67+
* Encodes URL to base64 format and escapes special characters.
68+
*
69+
* @param string $url
70+
*
71+
* @return string
6372
*/
64-
public function encodeURL($url)
73+
public function encodeURL($url): string
6574
{
6675
return $this->encoder->encode($url);
6776
}
6877

6978
/**
70-
* Decodes URL from base64 format and special characters
79+
* Decodes URL from base64 format and special characters.
80+
*
81+
* @param string $encodedUrl
82+
*
83+
* @return string
7184
*/
72-
public function decodeURL($encodedUrl)
85+
public function decodeURL($encodedUrl): string
7386
{
7487
return $this->decoder->decode($encodedUrl);
7588
}
76-
...
7789
```

0 commit comments

Comments
 (0)