Added typing / comments to the ScrubberInterface
and Scrubber
class
#591
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.
Description of the change
This PR adds better typing and comments to the
ScrubberInterface
to make implementation less error prone. In the process it seemed best to add these same updates to theScrubber
class as well.The update of the
Scrubber
class required some additional updates around the serialization of thePayload
class. Since theScubber::scrub()
method is only ever given the output ofPayload::serialize()
, I updated thescrub()
method to only accept anarray
as the$data
argument. This is stricter than it was previously, however, the only usage that deviates fromarray
is in the tests. Additionally, if scrubbing of other types is needed, theScrubber::internalScrub()
method is unlike its name would lead you to believepublic
.Other changes
MalformedPayloadDataTransformer
serialized payload was changed fromfalse
to an empty array.array_walk()
inScrubber::scrubArray()
.Type of change
Related issues
None
Checklists
Development
Code review