Public Member Functions | |
| check ($str) | |
| parse ($str) | |
| isLast () | |
| isFirst () | |
| doc () | |
Static Public Member Functions | |
| static | get_preparse_chain () |
Detailed Description
The base module for preparsing input
Preparse modules are all checked for every input. These modueles may modify the input string.
Member Function Documentation
| PreParser::check | ( | $str) |
Check whether the module handles this input
- Parameters
-
$str The input string
- Returns
- True The module handles this input. The parse method() will be called next.
- False The module does not handle this input. The parse method() will not be called and processing will proceed to the next Parser module.
| PreParser::doc | ( | ) |
Display documentation
- Returns
- A string describing the module
Ideally you should note what your module it does and what the input format is.
|
static |
Gather preparse modules
- Returns
- array of Parser class names
Scan the preparse directory for module files. Return an array of available modules.
| PreParser::isFirst | ( | ) |
Make this module first
- Returns
- True or False
Modules are not run in any guaranteed order. Return True will force this module to be first (or nearly first if multiple modules override this method)
| PreParser::isLast | ( | ) |
Make this module last
- Returns
- True or False
Modules are not run in any guaranteed order. Return True will force this module to be last.
BE VERY VERY CAREFUL IF YOU OVERRIDE THIS. Quantity is the last preparse module and DefaultTender is the last parse module. Making your own module last will break one of these and probably make a mess.
| PreParser::parse | ( | $str) |
Deal with the input
- Parameters
-
$str The input string
- Returns
- mixed
Preparse modules should return a string. This value will replace the input string for remaining parsing.
The documentation for this class was generated from the following file:
- pos/is4c-nf/parser-class-lib/PreParser.php
