class-webservice-logger.php

<?php
/**
 * File containing \Crowdsignal_Forms\Logging\Webservice_Logger
 *
 * @package crowdsignal-forms/Logging
 * @since 0.9.0
 */

namespace Crowdsignal_Forms\Logging;

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Class Webservice_Logger
 *
 * @package Crowdsignal_Forms\Logging
 */
class Webservice_Logger {
	/**
	 * Hook the default stuff.
	 *
	 * @since 0.9.0
	 *
	 * @return $this
	 */
	public function hook_defaults() {
		add_filter( 'crowdsignal_forms_webservice_logging_enabled', '__return_false', 10, 1 );
		return $this;
	}

	/**
	 * Unhook the defaults. Used when implementing logging in a companion plugin.
	 *
	 * @since 0.9.0
	 *
	 * @return $this
	 */
	public function unhook_defaults() {
		remove_filter( 'crowdsignal_forms_webservice_logging_enabled', '__return_false', 10 );
		return $this;
	}

	/**
	 * Log the webservice event.
	 *
	 * @param string $name The event we want to log.
	 * @param array  $data The data we want to log.
	 * @since 0.9.0
	 *
	 * @return $this
	 */
	public function log( $name, $data ) {
		/**
		 * Figure if we should log anything.
		 *
		 * @param bool $should_log Should we log events at all.
		 *
		 * @return array $data The event data to log.
		 *
		 * @since 0.9.0
		 */
		$should_log = (bool) apply_filters( 'crowdsignal_forms_webservice_logging_enabled', false );

		if ( $should_log ) {
			/**
			 * Record the webservice event using some form of "backend".
			 *
			 * @param string $name The event name to log.
			 * @param array $data The event data to log.
			 *
			 * @since 0.9.0
			 */
			do_action( 'crowdsignal_forms_webservice_log_event', $name, $data );
		}

		return $this;
	}
}