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
LogManager Module Documentation
This module allows the ability to change a user's log retention policies 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.LogManager::savesettings
| API Version: | 1 - Click here for documentation |
|---|---|
| Syntax: | LogManager::savesettings( archive, remarchive ) |
| Description: | Change the account's log archival settings. |
| Parameters: | |
| archive (boolean) | |
| This parameter allows you to specify whether or not to archive logs. A value of 1 indicates that logs should be archived. | |
| remarchive (boolean) | |
| Whether to remove existing logs. A value of 1 indicates that logs should be removed. | |
| Returns: | |
This function does not produce any output.
|
LogManager::showsettings
| API Version: | 1 - Click here for documentation |
|---|---|
| Syntax: | LogManager::showsettings( ) |
| Description: | Retrieve the current log archival settings. |
| Returns: | |
The output will contain a chunk of HTML similar to: <input value=1 type=checkbox name=archivelogs> Archive Logs in your home directory at the end of each month <br /> <input value=1 type=checkbox name=remoldarchivedlogs> Remove the previous month's archived logs from your home directory at the end of each month <br /> |
LogManager::listdownloads
| API Version: | 1 - Click here for documentation |
|---|---|
| Syntax: | LogManager::listdownloads( ) |
| Description: | List raw access logs available for download. |
| Returns: | |
The output will contain the following chunk of HTML, repeated for each log available: <a href="/getlogarchive/$logfile">$logfile</a> |
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 27 Mar 2012 - 18:45:33 - Main.JenniferDoubrava