Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
|||
| 1 | <?php |
| 2 | |
| 3 | namespace MediaWiki\Wikispeech\Segment\TextFilter; |
| 4 | |
| 5 | /** |
| 6 | * @file |
| 7 | * @ingroup Extensions |
| 8 | * @license GPL-2.0-or-later |
| 9 | */ |
| 10 | |
| 11 | /** |
| 12 | * A rule that transforms a text to something else with the same meaning, e.g: |
| 13 | * '1' => 'one', |
| 14 | * '1 jan 2000' => 'january first, two thousand'. |
| 15 | * |
| 16 | * Each {@link FilterPart} that has been transformed with an alias |
| 17 | * is associated to the rule that caused the transformation. |
| 18 | * How this is used depends on the implementation of |
| 19 | * {@link \MediaWiki\Wikispeech\Segment\TextFilter\Filter} |
| 20 | * used to invoke the rule. |
| 21 | * |
| 22 | * In the case of {@link RegexFilter} any {@link FilterPart} with |
| 23 | * a rule set to {@link FilterPart::$rule} will not be further processed. |
| 24 | * |
| 25 | * A probable future implementation of {@link Filter} will be using a lexer/parser |
| 26 | * that produce an abstract syntax tree. Here rules will represent leafs in the tree. |
| 27 | * |
| 28 | * @since 0.1.10 |
| 29 | */ |
| 30 | interface FilterRule { |
| 31 | |
| 32 | } |