Docs For Class Log for the log package

Class Overview

Log facility utilizing the function error_log()

 Usage:
   Log::insert(__FILE__,__LINE__,$myInsertMessage); // SQL
   Log::update(__FILE__,__LINE__,$myUpdateMessage);
   Log::delete(__FILE__,__LINE__,$myDeleteMessage);
   Log::query (__FILE__,__LINE__,$myQueryMessage);
 
   Log::debug (__FILE__,__LINE__,$myDebugMessage);
   Log::info  (__FILE__,__LINE__,$myInfoMessage);
   Log::warn  (__FILE__,__LINE__,$myWarnMessage);
   Log::error (__FILE__,__LINE__,$myErrorMessage);
   Log::fatal (__FILE__,__LINE__,$myFatalMessage);
 
   Log::email (__FILE__,__LINE__,$myEmailMessage); // Email
   Log::sms   (__FILE__,__LINE__,$mySmsMessage);   // SMS
 
   Log::referer($info); // Log referer info, where did the user came from
   Log::domain ($info); // Log domain info,  where did user come from
   Log::phrase ($info); // Log phase info,   what did user seached for
 
   Log::user();         // Log user data
 
   Log::getRequestInfo();

Located in /myphp-1.9/myphp-1.9-log/html/util/Log.php [line 49]

Methods

[ Top ]

Methods

Constructor Log [line 54]

Log Log(
)

Constructor

[ Top ]

add [line 74]

void add(
String
$file, String
$line, [String
$text = ''], [String
$level = ''] 
)

Add an entry to the log file

 Usage:
    Log::add($file,$line,$text,$level);
 The funtion will log the data with a filename as
 no-level-hostname.log  where
 no,       is a number from 0-365 (day of the year)
 level,    is the log level defined i.e. ERROR
 hostname, is the domain host name

Parameters:

String	$file:	The file name, use: __FILE__
String	$line:	The line number, use: __LINE__
String	$text:	The text to log
String	$level:	The log level to log

API Tags:

Static:

[ Top ]

debug [line 254]

void debug(
mixed
$file, mixed
$line, [mixed
$text = ''] 
)

[ Top ]

delete [line 250]

void delete(
mixed
$file, mixed
$line, [mixed
$text = ''] 
)

[ Top ]

domain [line 230]

void domain(
[mixed
$text = ''] 
)

[ Top ]

email [line 274]

void email(
mixed
$file, mixed
$line, [mixed
$text = ''] 
)

[ Top ]

error [line 266]

void error(
mixed
$file, mixed
$line, [mixed
$text = ''] 
)

[ Top ]

fatal [line 270]

void fatal(
mixed
$file, mixed
$line, [mixed
$text = ''] 
)

[ Top ]

getLevelName [line 150]

String getLevelName(
mixed
$level, String
$level, 
)

Get the level name

Get the name of the current loglevel

 Usage:
    Log::getLevelName($level);

Parameters:

String

$level,:

The log level to use

API Tags:

Return:	The name of the log level
Static:

[ Top ]

getRequestInfo [line 291]

String getRequestInfo(
)

Get the request information

 Usage:
    $requestInfo = Log::getRequestInfo();

API Tags:

Return:	The request as a string
Static:

[ Top ]

info [line 258]

void info(
mixed
$file, mixed
$line, [mixed
$text = ''] 
)

[ Top ]

insert [line 242]

void insert(
mixed
$file, mixed
$line, [mixed
$text = ''] 
)

[ Top ]

isEnabled [line 348]

boolean isEnabled(
[int
$level = LOG_LEVEL_DEBUG] 
)

Check to se, if the requested log level is active or not

 Usage:
    $isEnabled = Log::isEnabled($level);

Parameters:

int

$level:

The level to check. I.e. LOG_LEVEL_DEBUG

API Tags:

Return:	True if active, else false
Static:

[ Top ]

mkdir [line 128]

String mkdir(
String
$path, String
$name 
)

Create a new log directory $path.'/'.$name or

return the name of log directory if already exists

 Usage:
    Log::mkdir($path,$name);

Parameters:

String	$path:	The path of the existing log directory
String	$name:	The name of the new directory to use

API Tags:

Return:	The name of the new log directory or the old one
Static:

[ Top ]

phrase [line 234]

void phrase(
[mixed
$text = ''] 
)

[ Top ]

query [line 238]

void query(
mixed
$file, mixed
$line, [mixed
$text = ''] 
)

[ Top ]

referer [line 226]

void referer(
[String
$text = ''], String
$file, String
$line, String
$level 
)

Helper function

 Usage:
   Log::xxx(__FILE__,__LINE__,$message);
   Where xxx is one of:
   query, user, debug, info, warn, error, fatal or email

Parameters:

String	$file:	The file, use __FILE__
String	$line:	The line, use __LINE__
String	$text:	The text to log
String	$level:	The log level to use

API Tags:

Static:

[ Top ]

sms [line 278]

void sms(
mixed
$file, mixed
$line, [mixed
$text = ''] 
)

[ Top ]

update [line 246]

void update(
mixed
$file, mixed
$line, [mixed
$text = ''] 
)

[ Top ]

user [line 334]

void user(
[String
$text = ''] 
)

Add an entry to the log file with the request params

 Usage:
    Log::user($text);

Parameters:

String

$text:

The text to log

API Tags:

Static:

[ Top ]

warn [line 262]

void warn(
mixed
$file, mixed
$line, [mixed
$text = ''] 
)

[ Top ]

Class: Log

Class Log