MO Regex filter: mo_regex_filter.module File Reference
Use Regex filter to transform data in your nodes. More...
Enumerations | |
| enum | MO_REGEX_FILTER_VERSION |
Define the version of the MO Regex Filter module. More... | |
Functions | |
| mo_regex_filter_help ($section) | |
| The help pages for the MO Regex filter module. | |
| mo_regex_filter_filter ($op, $delta=0, $format=-1, $text= '') | |
| Define the filter itself. | |
| mo_regex_filter_filter_tips ($delta, $format, $long=FALSE) | |
| Return tips on how to use the filter. | |
Detailed Description
Implementation of the functions used to handle the MO Regex filter module.
Copyright (c) 2009-2011 Made to Order Software Corp.
http://www.m2osw.com/mo_regex_filter contact@m2osw.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Enumeration Type Documentation
This variable defines the version of the MO Regex Filter module. This will always be the same as the version defined in Drupal (throught the .info file.)
Function Documentation
| mo_regex_filter_filter | ( | $ | op, | |
| $ | delta = 0, |
|||
| $ | format = -1, |
|||
| $ | text = '' | |||
| ) |
This function reacts to the filter operations ($op) as expected.
- Parameters:
-
[in] $op The operation to apply to this filter [in] $delta The filter being called (always 0 at this time) [in] $format The format using this filter [in] $text The text being filtered
- Returns:
- Mixed: depends on the operation.
References _mo_regex_filter_process(), and _mo_regex_filter_settings_form().
| mo_regex_filter_filter_tips | ( | $ | delta, | |
| $ | format, | |||
| $ | long = FALSE | |||
| ) |
This function is used by the system to retrieve the tips on how to use this filter.
- Parameters:
-
[in] $delta Expected to be 0 [in] $format The format where the filter is currently being used [in] $long Whether the short (false) or long (true) tips are returned
- Returns:
- A string with the filter tips.
| mo_regex_filter_help | ( | $ | section | ) |
Display some help whenever the user goes to the Drupal help section of the website.
- Parameters:
-
[in] $section The section of help the user is interested in
- Returns:
- The help strings.
on Sat Mar 12 16:05:40 2011