| 1: | <?php declare(strict_types=1); |
| 2: | |
| 3: | namespace Salient\Contract\Core; |
| 4: | |
| 5: | use Salient\Contract\Core\Entity\Normalisable; |
| 6: | |
| 7: | /** |
| 8: | * Normaliser flags |
| 9: | * |
| 10: | * @see Normalisable::normalise() |
| 11: | */ |
| 12: | interface NormaliserFlag |
| 13: | { |
| 14: | /** |
| 15: | * Normalise names by applying every available transformation |
| 16: | * |
| 17: | * This is the default. |
| 18: | */ |
| 19: | public const GREEDY = 1; |
| 20: | |
| 21: | /** |
| 22: | * Normalise names by changing them as little as possible |
| 23: | */ |
| 24: | public const LAZY = 2; |
| 25: | |
| 26: | /** |
| 27: | * If a name matches a hint passed to the normaliser, return it without |
| 28: | * applying further transformations |
| 29: | * |
| 30: | * The name and the hint are both {@see NormaliserFlag::LAZY}-normalised for |
| 31: | * comparison. |
| 32: | */ |
| 33: | public const CAREFUL = 4; |
| 34: | } |
| 35: |