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
NVData Module Documentation
The NVData module provides access to cPanel's non-volatile datastore. This datastore is used for saving data between sessions. 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.NVData::setall
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Setup a non-volatile datastore in /home/user/.cpanel/nvdata. |
| Parameters: | |
| any string (string) | |
| Each string (hash key) represents a file in /home/user/.cpanel/nvdata. The file will be filled with the data in the value. | |
| Returns: | |
<data> <set> A string value that contains your variable name.</set> </data> |
NVData::get
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve data from /home/user/.cpanel/nvdata stores. This directory contains data that will be saved between sessions. |
| Parameters: | |
| names (string) | |
| The file(s) in /home/user/.cpanel/nvdata that you wish to retrieve. To retrieve multiple files, separate each file with a pipe (|). (e.g. x3finder|x3_gettingstarted) . | |
| Returns: | |
<data> <value> A string value that contains the contents of the requested file.</value> <name> The file whose contents you are viewing.</name> </data> |
NVData::set
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Setup non-volatile datastore in /home/user/.cpanel/nvdata. |
| Parameters: | |
| names (strings separated by pipes) | |
| Each string represents a file in /home/user/.cpanel/nvdata. | |
| Returns: | |
<data> <set> A string value that contains the branding package.</set> </data> |
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 26 Mar 2012 - 16:18:04 - Main.JenniferDoubrava