Replace Filter Plus
ReplaceFilterPlus is an abstract filter. It cannot be used unless it is implemented. Although I only list concrete filters on this page I chose to include the ReplacePlusFilter because of the power a flexibility that it adds to Text-Zap.
The purpose of ReplaceFilterPlus is to perform some action other that direct replacment to a regex. For exampled I've used it from translation, numeric conversion and the ChangeCaseFilter supplied with Text-Zap.
Here are the basics of how to create a ReplaceFilterPlus.
- Create a class that extends ReplaceFilterPlus.
- Implement the modifiedReplacment function. (Be sure that it returns a string.)
- Compile the class and use it in a Text-Zap Task within a build file.
^topParameters
These parameters are available to any filter built on ReplaceFilterPlus.| Attribute | Description | Required |
|---|---|---|
| regex | the regex to be searched for | Yes |
| modifyGroup | the capturing group to be modified by the filter | No, defaults to 0 which is the entire regex |
| preGroup | the capturing group that should be placed before the modifyGroup in the new output | No |
| postGroup | the capturing group that should be placed after the modifyGroup in the new output | No |
| Any other parameters defined by the filter |