diff options
| author | Brian Fenton <bfenton@ku.edu> | 2010-10-07 14:34:20 -0500 |
|---|---|---|
| committer | Brian Fenton <bfenton@ku.edu> | 2010-10-07 14:34:20 -0500 |
| commit | 7feec007dbb680f9699c1f45438a082ddb86da3a (patch) | |
| tree | e9be9b0b5245613d5a6b0f7b5ab58ffa1444523e | |
| parent | 88ba97232a872932a1bd36442e74468ba72ed744 (diff) | |
| download | KLogger-7feec007dbb680f9699c1f45438a082ddb86da3a.zip KLogger-7feec007dbb680f9699c1f45438a082ddb86da3a.tar.gz KLogger-7feec007dbb680f9699c1f45438a082ddb86da3a.tar.bz2 | |
added property documentation
| -rwxr-xr-x | src/KLogger.php | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/src/KLogger.php b/src/KLogger.php index 496563d..f2cdeac 100755 --- a/src/KLogger.php +++ b/src/KLogger.php @@ -21,6 +21,9 @@ */
class KLogger
{
+ /**
+ * Error logging thresholds, from low to high
+ */
const DEBUG = 1; // Most Verbose
const INFO = 2; // ...
const WARN = 3; // ...
@@ -28,19 +31,58 @@ class KLogger const FATAL = 5; // Least Verbose
const OFF = 6; // Nothing at all.
+ /**
+ * Internal status codes
+ */
const LOG_OPEN = 1;
const OPEN_FAILED = 2;
const LOG_CLOSED = 3;
+ /**
+ * Current status of the log file
+ * @var integer
+ */
private $_logStatus = self::LOG_CLOSED;
+ /**
+ * Holds messages generated by the class
+ * @var array
+ */
private $_messageQueue = array();
+ /**
+ * Path to the log file
+ * @var string
+ */
private $_logFile = null;
+ /**
+ * Current minimum logging threshold
+ * @var integer
+ */
private $_priority = self::INFO;
+ /**
+ * This holds the file handle for this instance's log file
+ * @var resource
+ */
private $_fileHandle = null;
+ /**
+ * Default priority of log messages, if not specified
+ * @var integer
+ */
private static $_defaultPriority = self::DEBUG;
+ /**
+ * Valid PHP date() format string for log timestamps
+ * @var string
+ */
private static $_dateFormat = "Y-m-d G:i:s";
+ /**
+ * Octal notation for default permissions of the log file
+ * @var integer
+ */
private static $_defaultPermissions = 0777;
+ /**
+ * Array of KLogger instances, part of Singleton pattern
+ * @var array
+ */
private static $instances = array();
/**
|