{{ message }}
Add maskRegex and maskPartialRegex#19526
Open
PhantomWatson wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends Cake\Utility\Text with two new masking helpers that operate on regular expressions, enabling masking of dynamic/sensitive substrings (e.g., numbers, words) without needing exact substring needles.
Changes:
- Added
Text::maskRegex()to mask full regex matches by replacing each match with repeated mask characters. - Added
Text::maskPartialRegex()to mask regex matches while preserving configurable leading/trailing characters. - Added PHPUnit coverage for both methods, including multi-pattern and multibyte scenarios.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1288
to
+1292
| * @param string $string The input string. | ||
| * @param string[]|string $patterns One or more regex patterns | ||
| * @param string $maskCharacter Single masking character. | ||
| * @return string | ||
| */ |
Comment on lines
+1326
to
+1328
| * Examples: | ||
| * - maskPartialRegex('Card used: 4242424242424242', '/\d{16}/', 0, 4) => Credit card used: ************4242 | ||
| * - maskPartialRegex('Secret Codeword', '/\b\w+\b/', 1, 1) => S****t C********d |
Comment on lines
+1334
to
+1336
| * @param string $maskCharacter Single masking character. | ||
| * @throws \InvalidArgumentException If $maskCharacter is not exactly a single character. | ||
| * @return string |
Comment on lines
+1338
to
+1339
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add
Text::maskRegex()andText::maskRegexPartial()static methods toCake\Utility\Textfor masking portions of strings by regex instead of by specific substrings.See issue #19525