Skip to content

Commit

Permalink
updated docs for base64UrlEncode()
Browse files Browse the repository at this point in the history
as discussed in
#13411 (comment)
  • Loading branch information
cebe committed Apr 11, 2017
1 parent 9445e55 commit ed99125
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions framework/helpers/BaseStringHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -315,10 +315,13 @@ public static function normalizeNumber($value)

/**
* Encodes string into "Base 64 Encoding with URL and Filename Safe Alphabet" (RFC 4648)
* @see https://tools.ietf.org/html/rfc4648#page-7
*
* @param string $input
* @return string
* > Note: Base 64 padding `=` may be at the end of the returned string.
* > `=` is not transparent to URL encoding.
*
* @see https://tools.ietf.org/html/rfc4648#page-7
* @param string $input the string to encode.
* @return string encoded string.
* @since 2.0.12
*/
public static function base64UrlEncode($input)
Expand All @@ -328,10 +331,10 @@ public static function base64UrlEncode($input)

/**
* Decodes "Base 64 Encoding with URL and Filename Safe Alphabet" (RFC 4648)
* @see https://tools.ietf.org/html/rfc4648#page-7
*
* @param string $input
* @return string
* @see https://tools.ietf.org/html/rfc4648#page-7
* @param string $input encoded string.
* @return string decoded string.
* @since 2.0.12
*/
public static function base64UrlDecode($input)
Expand Down

0 comments on commit ed99125

Please sign in to comment.