Software Development Kit
cPanel & WHM's API [+] cPanel & WHM's API [-]Modules and Plugins [+] Modules and Plugins [-]
cPanel Modules
Writing cPanel Modules PHP Accounting Module cPanel::Accounting Perl Module Writing cPanel Plugins
Writing cPanel Plugins PHP in cPanel Plugin Interfaces cPanel CGI Scripts Live PHP in cPanel Plugins Plugin Variables Installing cPanel Plugins Adding Icons and Groups Plugin Installation File Generator Plugin Security Policy (
.pdf)
WHM Plugins
Creating WHM Plugins ACL Reference Table The swapip Utility cPanel Logger Module Pluggable dnsadmin Modules EasyApache Modules
Custom Modules?
cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]
Standardized Hooks Introduction Taxonomy Getting Started Hooks Management Interface Hookable Events Advanced Usage Troubleshooting
Legacy Hooks Introduction Writing Function Hooks Script Hooks Custom Event Handlers cPanel Logger Module Universal Password Trap Hooking into EasyApache
EasyApache Hooks?
cPAddons (Site Software) [+] cPAddons (Site Software) [-]
System Administration [+] System Administration [-]
Developer Software [+] Developer Software [-]
Back to All Documentation
LangMods Module Documentation
The LangMods module allows you to install modules for various scripting languages. The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.LangMods::magic_status
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Determine whether 'magic' status is enabled for a specific language module system. When 'magic' status is enabled, users can install modules so that they will not have to modify 'includes' in their scripts. |
| Parameters: | |
| lang (string) | |
| The language module system you wish to examine. You can retrieve a list of acceptable values from the 'lang' tag output of LangMods::langlist. | |
| Returns: | |
<data> <result> A boolean value that indicates whether or not the system uses 'magic' status. '1' if magic status is enabled. '0' if magic status is disabled.</result> </data> |
LangMods::setup
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Check to ensure that your directory infrastructure and other requirements are in place for the cPanel module installer. It is considered good practice to run LangMods::prerun after using this function. |
| Parameters: | |
| lang (string) | |
| The language module system you wish to check. You can retrieve a list of acceptable values from the 'lang' tag output of LangMods::langlist. | |
| Returns: | |
<data> <result> A string value that contains any relevant information. This output variable may be undefined. An undefined value does not necessarily indicate failure.</result> <status> A boolean value that indicates success or failure. '1' indicates that the requirements are in place. '0' indicates that the requirements are missing.</status> </data> |
LangMods::update
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Update a specific module for a language supported by the cPanel language module system. |
| Parameters: | |
| lang (string) | |
| The language module system you wish to update. You can retrieve a list of acceptable values from the 'lang' tag output of LangMods::langlist. | |
| mod (string) | |
| The name of the module you wish to update. | |
| Returns: | |
<data> <result> A string value that contains any relevant output.</result> <status> A boolean value that indicates success or failure. '1' indicates that the module was updated successfully. '0' indicates that the module was not updated.</status> </data> |
LangMods::uninstall
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Uninstall a specific module for a language supported by the cPanel language module system. |
| Parameters: | |
| lang (string) | |
| The language corresponding to the module you wish to uninstall. You can retrieve a list of acceptable values from the 'lang' tag output of LangMods::langlist. | |
| mod (string) | |
| The name of the module you want to uninstall. | |
| Returns: | |
<data> <result> A string value that contains any relevant output.</result> <status> A boolean value that indicates success or failure. '1' if the module was removed. '0' if the module was not removed.</status> </data> |
LangMods::search
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Search available language modules using regular expressions. |
| Parameters: | |
| lang (string) | |
| The language module system you wish to search. You can retrieve a list of acceptable values from the 'lang' tag output of LangMods::langlist. | |
| skip (integer (optional)) | |
| The number of responses you wish to skip at the beginning of the output. You can use this parameter in conjunction with the 'want' parameter to paginate your results. | |
| want (integer (optional)) | |
| The number of responses you want in the output. This parameter defaults to 100. You can use this parameter in conjunction with the 'skip' parameter to paginate your results. If you would like to see all of the function's output, you will need to specify a large number in this parameter. | |
| regex (perl regular expression) | |
| A perl regular expression used to filter results. A simple keyword will suffice. | |
| Returns: | |
<data> <stable> A string value that contains the stable version of the module.</stable> <module> A string value that contains the name of the module.</module> <latest> A string value that contains the latest version number available for module.</latest> <docurl> A string value that contains the module's homepage.</docurl> <info> A string value that contains any relevant information stored on the module.</info> </data> |
LangMods::install
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Install a specific module for a language supported by cPanel's language module system. This feature relies on a compiler and may take over 5 minutes to return data. This function is not available in demo mode. |
| Parameters: | |
| lang (string) | |
| The language module system you wish to examine. You can retrieve a list of acceptable values from the 'lang' tag output of LangMods::langlist. | |
| mod (string) | |
| The name of the module you want to install. | |
| Returns: | |
<data> <result> A string value that contains any relevant output information.</result> <status> A boolean value indicating success or failure. '1' indicates that the module was installed. '0' indicates the function encountered an error.</status> </data> |
LangMods::list_installed
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | List installed modules for the specified language module system. |
| Parameters: | |
| lang (string) | |
| The language module system you wish to examine. You can retrieve a list of acceptable values from the 'lang' tag output of LangMods::langlist. | |
| sys (boolean) | |
| If this parameter is left undefined, the function will return locally installed modules for the entire system. Setting this parameter to '1' causes the function to return modules installed system-wide. Setting this parameter to '0' causes the function to only list modules installed for your account. | |
| Returns: | |
<data> <stable> A string value that contains the stable version of the module.</stable> <module> A string value that contains the name of the module.</module> <latest> A string value that contains the latest version of the module.</latest> <docurl> A string value that contains the system's homepage.</docurl> <info> A string value that contains any relevant information.</info> </data> |
LangMods::pre_run
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Update indexes and actions for a specific language module system. It is good practice to run this function after running LandMods::setup. |
| Parameters: | |
| lang (string) | |
| The language module system you wish to update. You can retrieve a list of acceptable values from the 'lang' tag output of LangMods::langlist. | |
| Returns: | |
<data> <result> A string value that contains the action that was taken. (e.g. Updating channel "pecl.php.net")</result> <status> A boolean value indicating success or failure. '1' indicates that the function completes successfully. '0' if the function failed.</status> </data> |
LangMods::list_available
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | List available modules for a specific language module system. |
| Parameters: | |
| lang (string) | |
| The language module system you wish to examine. You can retrieve a list of acceptable values from the 'lang' tag output of LangMods::langlist. | |
| skip (integer (optional)) | |
| The number of responses you wish to skip at the beginning of the function's output. You can use this parameter in conjunction with 'want' to paginate the function's output. | |
| want (integer (optional)) | |
| The number of responses you would like in the function's output. This value defaults to 100. You can use this parameter in conjunction with 'skip' to paginate the function's output. If you would like view every piece of the function's output, you will need to specify a very large number. | |
| Returns: | |
<data> <stable> A string value that contains the stable version of the module.</stable> <module> A string value that contains the name of the module.</module> <latest> A string value that contains the latest version of the module.</latest> <docurl> A string value that contains the system's homepage.</docurl> <info> A string value that contains any relevant information.</info> </data> |
LangMods::getprefix
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve the base directory for modules of a specified language. |
| Parameters: | |
| lang (string) | |
| The language corresponding to the base directory to be retrieved. You can retrieve potential values from the 'lang' tag output from LangMods::langlist. | |
| Returns: | |
<data> <status> A boolean value that indicates success or failure. '1' indicates that the base directory was retrieved. '0' indicates that the function has failed.</status> <prefix> The path to the base modules directory corresponding to the specified language.</prefix> </data> |
LangMods::langlist
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | List language module management systems available on your server. This function does not depend on any input, nor does it run any tests. This function simply returns available systems. |
| Returns: | |
<data> <lang> A string value that contains the system's short name. (e.g. 'php-pecl' or 'ruby')</lang> <name> A string value that contains the system's full name. (e.g. 'PHP Pecl' or 'Ruby Gem')</name> </data> |
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 26 Mar 2012 - 16:05:33 - Main.JenniferDoubrava