2011-11-15 13:08:56 +00:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* Allows log files to be written to for debugging purposes.
|
|
|
|
*
|
2012-01-27 16:38:39 +00:00
|
|
|
* @class WC_Logger
|
2012-08-14 19:42:38 +00:00
|
|
|
* @version 1.6.4
|
2012-08-14 22:43:48 +00:00
|
|
|
* @package WooCommerce/Classes
|
2013-02-20 17:14:46 +00:00
|
|
|
* @category Class
|
2012-08-14 19:42:38 +00:00
|
|
|
* @author WooThemes
|
2011-11-15 13:08:56 +00:00
|
|
|
*/
|
2012-01-27 16:38:39 +00:00
|
|
|
class WC_Logger {
|
2012-08-14 19:42:38 +00:00
|
|
|
|
2012-08-15 17:08:42 +00:00
|
|
|
/**
|
2012-12-14 22:00:04 +00:00
|
|
|
* @var array Stores open file _handles.
|
2012-08-15 17:08:42 +00:00
|
|
|
* @access private
|
|
|
|
*/
|
2012-12-14 21:57:23 +00:00
|
|
|
private $_handles;
|
2012-08-14 19:42:38 +00:00
|
|
|
|
|
|
|
/**
|
2012-08-15 17:08:42 +00:00
|
|
|
* Constructor for the logger.
|
2012-08-14 19:42:38 +00:00
|
|
|
*
|
|
|
|
* @access public
|
|
|
|
* @return void
|
|
|
|
*/
|
2012-12-14 21:44:43 +00:00
|
|
|
public function __construct() {
|
2012-12-14 22:00:04 +00:00
|
|
|
$this->_handles = array();
|
2011-11-15 13:08:56 +00:00
|
|
|
}
|
|
|
|
|
2012-08-14 19:42:38 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Destructor.
|
|
|
|
*
|
|
|
|
* @access public
|
|
|
|
* @return void
|
|
|
|
*/
|
2012-12-14 21:44:43 +00:00
|
|
|
public function __destruct() {
|
2014-05-28 10:12:35 +00:00
|
|
|
foreach ( $this->_handles as $handle ) {
|
2012-10-24 10:28:05 +00:00
|
|
|
@fclose( escapeshellarg( $handle ) );
|
2014-05-28 10:12:35 +00:00
|
|
|
}
|
2011-11-15 13:08:56 +00:00
|
|
|
}
|
2012-08-14 19:42:38 +00:00
|
|
|
|
|
|
|
|
2011-11-15 13:08:56 +00:00
|
|
|
/**
|
2012-08-14 19:42:38 +00:00
|
|
|
* Open log file for writing.
|
|
|
|
*
|
|
|
|
* @access private
|
|
|
|
* @param mixed $handle
|
|
|
|
* @return bool success
|
2011-11-15 13:08:56 +00:00
|
|
|
*/
|
|
|
|
private function open( $handle ) {
|
2014-05-28 10:12:35 +00:00
|
|
|
if ( isset( $this->_handles[ $handle ] ) ) {
|
2012-08-14 19:42:38 +00:00
|
|
|
return true;
|
2014-05-28 10:12:35 +00:00
|
|
|
}
|
2012-08-14 19:42:38 +00:00
|
|
|
|
2014-05-28 14:08:33 +00:00
|
|
|
if ( $this->_handles[ $handle ] = @fopen( wc_get_log_file_path( $handle ), 'a' ) ) {
|
2012-08-14 19:42:38 +00:00
|
|
|
return true;
|
2014-05-28 10:12:35 +00:00
|
|
|
}
|
2012-08-14 19:42:38 +00:00
|
|
|
|
2011-11-15 13:08:56 +00:00
|
|
|
return false;
|
|
|
|
}
|
2012-08-14 19:42:38 +00:00
|
|
|
|
|
|
|
|
2011-11-15 13:08:56 +00:00
|
|
|
/**
|
2012-08-14 19:42:38 +00:00
|
|
|
* Add a log entry to chosen file.
|
|
|
|
*
|
|
|
|
* @access public
|
|
|
|
* @param mixed $handle
|
|
|
|
* @param mixed $message
|
|
|
|
* @return void
|
2011-11-15 13:08:56 +00:00
|
|
|
*/
|
|
|
|
public function add( $handle, $message ) {
|
2013-01-10 14:56:07 +00:00
|
|
|
if ( $this->open( $handle ) && is_resource( $this->_handles[ $handle ] ) ) {
|
2014-05-28 10:12:35 +00:00
|
|
|
$time = date_i18n( 'm-d-Y @ H:i:s -' ); // Grab Time
|
2013-01-10 14:56:38 +00:00
|
|
|
@fwrite( $this->_handles[ $handle ], $time . " " . $message . "\n" );
|
2012-08-14 19:42:38 +00:00
|
|
|
}
|
2011-11-15 13:08:56 +00:00
|
|
|
}
|
2012-08-14 19:42:38 +00:00
|
|
|
|
|
|
|
|
2011-11-15 13:08:56 +00:00
|
|
|
/**
|
2013-03-03 17:07:31 +00:00
|
|
|
* Clear entries from chosen file.
|
2012-08-14 19:42:38 +00:00
|
|
|
*
|
|
|
|
* @access public
|
|
|
|
* @param mixed $handle
|
|
|
|
* @return void
|
2011-11-15 13:08:56 +00:00
|
|
|
*/
|
|
|
|
public function clear( $handle ) {
|
2014-05-28 10:12:35 +00:00
|
|
|
if ( $this->open( $handle ) && is_resource( $this->_handles[ $handle ] ) ) {
|
2013-01-10 14:56:38 +00:00
|
|
|
@ftruncate( $this->_handles[ $handle ], 0 );
|
2014-05-28 10:12:35 +00:00
|
|
|
}
|
2011-11-15 13:08:56 +00:00
|
|
|
}
|
2012-11-27 16:22:47 +00:00
|
|
|
|
2014-05-28 14:08:33 +00:00
|
|
|
}
|