<?php declare(strict_types = 1);

namespace RemoteDataBlocks\Logging;

/**
 * Describes a simplified (non-PSR-compliant) logger instance.
 *
 * The message MUST be a string.
 *
 * The context array can contain arbitrary data. The only assumption that
 * can be made by implementors is that if an Exception instance is given
 * to produce a stack trace, it MUST be in a key named "exception".
 *
 * See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
 * for the full interface specification.
 */
interface LoggerInterface {

	/**
	 * System is unusable.
	 *
	 * @param mixed[] $context
	 */
	public function emergency( string $message, array $context = [] ): void;

	/**
	 * Action must be taken immediately.
	 *
	 * Example: Entire website down, database unavailable, etc. This should
	 * trigger the SMS alerts and wake you up.
	 *
	 * @param mixed[] $context
	 */
	public function alert( string $message, array $context = [] ): void;

	/**
	 * Critical conditions.
	 *
	 * Example: Application component unavailable, unexpected exception.
	 *
	 * @param mixed[] $context
	 */
	public function critical( string $message, array $context = [] ): void;

	/**
	 * Runtime errors that do not require immediate action but should typically
	 * be logged and monitored.
	 *
	 * @param mixed[] $context
	 */
	public function error( string $message, array $context = [] ): void;

	/**
	 * Exceptional occurrences that are not errors.
	 *
	 * Example: Use of deprecated APIs, poor use of an API, undesirable things
	 * that are not necessarily wrong.
	 *
	 * @param mixed[] $context
	 */
	public function warning( string $message, array $context = [] ): void;

	/**
	 * Normal but significant events.
	 *
	 * @param mixed[] $context
	 */
	public function notice( string $message, array $context = [] ): void;

	/**
	 * Interesting events.
	 *
	 * Example: User logs in, SQL logs.
	 *
	 * @param mixed[] $context
	 */
	public function info( string $message, array $context = [] ): void;

	/**
	 * Detailed debug information.
	 *
	 * @param mixed[] $context
	 */
	public function debug( string $message, array $context = [] ): void;

	/**
	 * Logs with an arbitrary level.
	 *
	 * @param mixed[] $context
	 *
	 * @throws \Exception
	 */
	public function log( string $level, string $message, array $context = [] ): void;
}
