Stats Functions

Note: The Standardized Hooks documentation is currently under revision. You should check back shortly for improvements to this information.

This document contains hook insertion points for stats functions.

Stats::RunAll (pre)

Stats::RunAll (post)

Stats::RunUser (pre)

Parameters

{
   'lastruntime' => "The Unix timestamp that indicates the last time stats were run for the user."
   'user' => "The user whose stats are being processed by the system."
   'homedir' => "The user's home directory."
   'rLOG_CONF' => "A hash reference that indicates which analytics programs will process each of the user's domains."
   'maindomain' => "The user's main domain."
   'rALLDOMAINS' => "An array reference that contains all of the cPanel user's domains."
   'logfiledesc' => "An array of hash references that contain an entry for each domain processed by cpanellogd. Not all of the user's domains are contained in this array. The array has 3 entries for each domain:"
   { 
       'domain' => "The domain being processed."
       'filename' => "The log file's filename."
       'logfile' => "The location of the log file being processed. Usually, this is a .bkup file. This file should be used for processing, rather than the file in domlogs."
   };
};

Stats::RunUser (post)

Parameters

{
   'lastruntime' => "The Unix timestamp that indicates the last time stats were run for the user."
   'user' => "The user whose stats are being processed by the system."
   'homedir' => "The user's home directory."
   'rLOG_CONF' => "A hash reference that indicates which analytics programs will process the user's domains."
   'maindomain' => "The user's main domain."
   'rALLDOMAINS' => "An array reference that contains all of the cPanel user's domains."
   'logfiledesc' => "An array of hash references that contain an entry for each domain processed by cpanellogd. Not all of the user's domains are contained in this array. The array has 3 entries for each domain:"
   { 
       'domain' => "The domain being processed."
       'filename' => "The log file's filename."
       'logfile' => "The location of the log file being processed. Usually, this is a .bkup file. This file should be used for processing, rather than the file in domlogs."
   };
};

Stats::RunUser (post)

Parameters

{
   'lastruntime' => "The Unix timestamp that indicates the last time stats were run for the specified user."
   'user' => "The user whose stats are being processed by the system."
   'homedir' => "The user's home directory."
   'rLOG_CONF' => "A hash reference that indicates which analytics programs will process the user's domains."
   'maindomain' => "The user's main domain."
   'rALLDOMAINS' => "An array reference that contains all of the cPanel user's domains."
   'logfiledesc' => "An array of hash references that contain an entry for each domain processed by cpanellogd. Not all of the user's domains are contained in this array. The array has 3 entries for each domain:"
   { 
       'domain' => "The domain being processed."
       'filename' => "The log file's filename."
       'logfile' => "The location of the log file being processed. Usually, this is a .bkup file. This file should be used for processing, rather than the file in domlogs."
   };
};