wpdk-watchdog.php

Go to the documentation of this file.

<?php

/*
 * [DRAFT]
 *
 * THE FOLLOWING CODE IS A DRAFT. FEEL FREE TO USE IT TO MAKE SOME EXPERIMENTS, BUT DO NOT USE IT IN ANY CASE IN
 * PRODUCTION ENVIRONMENT. ALL CLASSES AND RELATIVE METHODS BELOW CAN CHNAGE IN THE FUTURE RELEASES.
 *
 */

class WPDKWatchDog {

  const LOG_SEPARATOR = '---------------------------------------------------------------------------------------------';

  public $enabled;

  public $triggerError;

  public $separator;

  public $path;

  public $logname;

  public $available;

  public $extensionFilename;

  public $prefix;

  public function __construct( $path, $folder = 'logs', $extension = 'php' )
  {
    $this->path              = trailingslashit( trailingslashit( $path ) . $folder );
    $this->enabled           = true;
    $this->triggerError      = false;
    $this->separator         = self::LOG_SEPARATOR;
    $this->extensionFilename = $extension;

    /* Under the plugin path ($path) create a log/ folder */
    if ( !file_exists( $this->path ) ) {
      @wp_mkdir_p( $this->path );
    }

    $this->logname = sprintf( '%s%s.%s', $this->path, date( 'Ymd' ), $this->extensionFilename );

    /* Check if log file is available */
    $handle          = @fopen( $this->logname, "a+" );
    $this->available = ( false !== $handle );

    /* Remove old zero logs. */
    $yesterday_log = sprintf( '%s%s.%s', $this->path, date( 'Ymd', strtotime( '-1 days' ) ), $this->extensionFilename );
    if ( file_exists( $yesterday_log ) ) {
      $size = @filesize( $yesterday_log );
      if ( empty( $size ) ) {
        @unlink( $yesterday_log );
      }
    }
  }

  public function log( $txt, $title = '' )
  {
    if ( $this->enabled && $this->available ) {

      /* If not a pre-formatted string, grab the var dump object, array or mixed for output */
      if ( !is_string( $txt ) && !is_numeric( $txt ) ) {
        ob_start();
        var_dump( $txt );
        $content = ob_get_contents();
        ob_end_clean();
        $txt = $content;

        /* @since 1.4.3 */
        do_action( 'wpdk_watchdog_log', $content );
      }

      $date   = sprintf( '[%s]', date( 'Y-m-d H:i:s' ) );
      $sepa   = substr( $this->separator, 0, ( strlen( $this->separator ) - strlen( $date ) - 1 ) );
      $output = sprintf( "%s (%s) %s\n%s\n\n", $date, $title, $sepa, $txt );
      $handle = fopen( $this->logname, 'a+' );
      if ( false !== $handle ) {
        fwrite( $handle, $output );
        fclose( $handle );
      }
      else {
        $this->available = false;
      }

      if ( $this->triggerError ) {
        trigger_error( $output );
      }
    }
    return $this->available;
  }
}