xConverter Introduction

This documentation will guide you through the functionality of the thc_xc module.

xConverter is a multifunctional tool for manipulating data. Its strength lies in its easy expandability with built-in PHP functions or your own custom functions. Without this module, ModGlue would be extremely restricted as it can extract, save, load, and manipulate other data (from previously executed modules).

Interface Parameters:

1. Select Option: Depending on your function selection, other options will appear.

ModGlue Variables:

1. $_CONTEXT['thc_xc']['optionfile']: (string) Absolute path to the convertopt.php file located in the module's root folder.
2. $_CONTEXT['thc_xc']['items']: (int) Number of functions in xConverter.
3. $_CONTEXT['thc_xc']['array_index']: (int) Index of the requested function.
4. $_CONTEXT['thc_xc']['function']: (string) Name of the function being executed.
5. $_CONTEXT['thc_xc']['converter_function_file']: (string) If PHP doesn't have your function built-in, xConverter will search for this file in the CONVERTERS folder in the module's directory.
6. $_CONTEXT['thc_xc']['output']: (mixed) Output of the function.

Resource Settings:

• Time Limit: PHP default
• Memory Limit: PHP default

Dependencies:

N/A

Expanding xConverter:

You can expand xConverter's functionality by adding files to the module's data file convertopt.php. There are two different scenarios when adding new functions: either the function you want to use is a built-in PHP function, or you want to create your own function. In the latter case, you will have to create a file containing that function.

The structure of the convertopt.php file is straightforward:

• Label: Title of the function
• Description: Brief description of the function
• Type: Number of parameters for the function. For example, if there are three parameters, the first is a string (1), and the second and third (0) are expected to be integer values.
• Group: Name of the group; all functions with the same name will be grouped together.
• Fieldnames: This corresponds with the type index and creates the HTML field description on the index interface.
• Position: Position in the group
• Function: Name of the function. If this is not a built-in PHP function, you would create the function (e.g., substr), save the file as substr.php, and place it in the module's CONVERTERS folder.
• nl2br: New lines in the output will be converted to newline HTML tags.

Finally, after defining each function, include $_OPT++; to create the next array index.

Known Issues:

N/A