Cpanel::StatsBar::stat

This article documents the usage of the Cpanel::StatsBar::stat function in relation to the cPanel interface. This tag can be used inside cPanel pages.

SYNOPSIS

DESCRIPTION

This function outputs statistical information about the cPanel user's account.

VARIABLES

INPUT

warnings (boolean): Determines whether or not to show statistical warnings. warnings=1 will show warnings.
warninglevel (string): Percentage of usage to show warning at. I.e. warninglevel=80 would show a warning when 80% of the item is used.
warnout (boolean): Only output statistics that would generate a warning. (1 = Yes, 0 = No)
infinitylang (string): Outputs the language tag ``infinity'' if present and the statistic is infinity. Usage: infinitylang=true
graph (string): NOT YET IMPLEMENTED
infinityimg (string): Outputs an image if used and the statistic is infinity. Usage: infintiyimg=imagename.extension
display (string): Variables to display when outputting information.
VARIABLE LIST
diskusage (string): Disk space usage information for the account.
bandwidthusage (string): Bandwidth usage information for the account.
mysqldiskusage (string): MySQL disk usage infromatio for the account.
postgresdiskusage (string): PostgreSQL disk usage information for the account.
emailac_counts (string): Email account information for the account.
subdomains (string): Subdomain information for the account.
parkeddomains (string): Parked domain information for the account.
addondomains (string): Addon domain information for the account.
ftpaccounts (string): FTP account information for the account.
sqldatabases (string): SQL database information for the account (MySQL and PostgreSQL).
mailinglists (string): Mailing list information for the account.
hostingpackage (string): Name of the hosting package associated with the account.
cpanelversion (string): Version of cPanel software installed.
theme (string): Name of the cPanel theme used on the account / domain.
apacheversion (string): Installed version of Apache.
phpversion (string): Installed version of PHP.
mysqlversion (string): Installed version of MySQL.
machinetype (string): Hardware architecture (i386, i686).
operatingsystem (string): Operating System type.
sharedip (string): Shared IP address the domain resides on.
dedicatedip (string): Dedicated IP address of the domain / cPanel account.
sendmailpath (string): Absolute path to sendmail.
perlpath (string): Absolute path to perl.
kernelversion (string): Kernel version being booted on the server.

OUTPUT

item (string): Name of the statistic or item.
value (string): Value of the statistic.

EXAMPLES

<?cp StatsBar::stat([tr][td]%[/td][td]%[/td][/tr],item,value) display=sendmailpath|perlpath|kernelversion| ?>

This example will output table rows with the names: Path to sendmail, Path to Perl and Kernel version as well as the values of those items.