GravityView_Logging

Complexity

Total Complexity

18

Size/Duplication

Total Lines	145
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

48.08%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	add_debug_bar()	0	14	3
A	enable_gform_logging()	0	4	1
A	get_notices()	0	3	1
A	get_errors()	0	3	1
A	get_print_function()	0	9	2
A	log_debug()	0	18	3
A	log_error()	0	19	4
A	is_logging_active()	0	12	2

<?php

final class GravityView_Logging {

	private static $errors = array();
	private static $notices = array();

	function __construct() {

It is generally recommended to explicitly declare the visibility for methods.

		add_action( 'gravityview_log_error', array( $this, 'log_error'), 10, 2 );

		add_action( 'gravityview_log_debug', array( $this, 'log_debug'), 10, 2 );

		// Enable debug with Gravity Forms Logging Add-on
	    add_filter( 'gform_logging_supported', array( $this, 'enable_gform_logging' ) );

	    // Load Debug Bar integration
	    add_filter( 'debug_bar_panels', array( $this, 'add_debug_bar' ) );

	}

	/**
	 * Add integration with the Debug Bar plugin. It's awesome.
	 *
	 * @see http://wordpress.org/plugins/debug-bar/
	 */
	public function add_debug_bar( $panels ) {

		if ( ! class_exists( 'Debug_Bar_Panel' ) ) {
			return;
		}

		if ( ! class_exists( 'GravityView_Debug_Bar' ) ) {
			include_once( GRAVITYVIEW_DIR . 'includes/class-debug-bar.php' );
		}

		$panels[] = new GravityView_Debug_Bar;

		return $panels;
	}

	/**
	 * Enables debug with Gravity Forms logging add-on
	 * @param array $supported_plugins List of plugins
	 */
	public function enable_gform_logging( $supported_plugins ) {
	    $supported_plugins['gravityview'] = 'GravityView';
	    return $supported_plugins;
	}

	/**
	 * @static
	 * @return array Array of notices (with `message`, `data`, and `backtrace` keys), if any
	 */
	public static function get_notices() {
		return self::$notices;
	}

	/**
	 * @static
	 * @return array Array of errors (with `message`, `data`, and `backtrace` keys), if any
	 */
	public static function get_errors() {
		return self::$errors;
	}

	/**
	 * Get the name of the function to print messages for debugging
	 *
	 * This is necessary because `ob_start()` doesn't allow `print_r()` inside it.
	 *
	 * @return string "print_r" or "var_export"
	 */
	static function get_print_function() {

It is generally recommended to explicitly declare the visibility for methods.

		if( ob_get_level() > 0 ) {
			$function = 'var_export';
		} else {
			$function = 'print_r';
		}

		return $function;
	}

	static function log_debug( $message = '', $data = null ) {

It is generally recommended to explicitly declare the visibility for methods.

		$function = self::get_print_function();

		$notice = array(
			'message' => $function( $message, true ),
			'data' => $data,
		);

		if( !in_array( $notice, self::$notices ) ) {
			self::$notices[] = $notice;
		}

		if ( class_exists("GFLogging") ) {
			GFLogging::include_logger();
	        GFLogging::log_message( 'gravityview', $function( $message, true ) . $function($data, true), KLogger::DEBUG );
	    }
	}

	static function log_error( $message = '', $data = null  ) {

It is generally recommended to explicitly declare the visibility for methods.

		$function = self::get_print_function();

		$error = array(
			'message' => $message,
			'data' => $data,
			'backtrace' => function_exists( 'wp_debug_backtrace_summary' ) ? wp_debug_backtrace_summary( null, 3 ) : '',
		);

		if( !in_array( $error, self::$errors ) ) {
			self::$errors[] = $error;
		}

		if ( class_exists("GFLogging") ) {
		    GFLogging::include_logger();
		    GFLogging::log_message( 'gravityview', $function ( $message, true ) . $function ( $error, true), KLogger::ERROR );
		}
	}

	/**
	 * Check whether a plugin is active
	 *
	 * @param string $plugin
	 *
	 * @since 2.5.1
	 *
	 * @param string $plugin The slug for the plugin used when setting up logging (default: "gravityview")
	 *
	 * @return bool
	 */
	static function is_logging_active( $plugin = 'gravityview' ) {

It is generally recommended to explicitly declare the visibility for methods.

		if( ! class_exists( 'GFLogging') ) {
			return false;
		}

		GFLogging::include_logger();

		$plugin_setting = GFLogging::get_instance()->get_plugin_setting( $plugin );

		return ! rgempty( 'enable', $plugin_setting );
	}

}

new GravityView_Logging;