GeminiLabs\Castor\Helpers\Log

Complexity

Total Complexity

24

Size/Duplication

Total Lines	184
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	__toString()	0	4	1
A	alert()	0	4	1
A	clear()	0	5	1
A	critical()	0	4	1
A	debug()	0	4	1
A	emergency()	0	4	1
A	error()	0	4	1
A	info()	0	4	1
A	notice()	0	4	1
A	warning()	0	4	1
B	interpolate()	0	20	8
A	log()	0	12	4

<?php

namespace GeminiLabs\Castor\Helpers;

use ReflectionClass;

class Log
{
	const EMERGENCY = 'emergency';
	const ALERT = 'alert';
	const CRITICAL  = 'critical';
	const ERROR = 'error';
	const WARNING = 'warning';
	const NOTICE = 'notice';
	const INFO = 'info';
	const DEBUG = 'debug';

	protected $file;
	protected $log;

	public function __construct( $filename )
	{
		$this->file = $filename;
		$this->log = file_exists( $filename )
			? file_get_contents( $filename )
			: '';
	}

	public function __toString()
	{
		return $this->log;
	}

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

	/**
	 * @return void
	 */
	public function clear()
	{
		$this->log = '';
		file_put_contents( $this->file, $this->log );
	}

	/**
	 * Critical conditions.
	 * Example: Application component unavailable, unexpected exception.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function critical( $message, array $context = [] )
	{
		$this->log( static::CRITICAL, $message, $context );
	}

	/**
	 * Detailed debug information.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function debug( $message, array $context = [] )
	{
		$this->log( static::DEBUG, $message, $context );
	}

	/**
	 * System is unusable.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function emergency( $message, array $context = [] )
	{
		$this->log( static::EMERGENCY, $message, $context );
	}

	/**
	 * Runtime errors that do not require immediate action but should typically
	 * be logged and monitored.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function error( $message, array $context = [] )
	{
		$this->log( static::ERROR, $message, $context );
	}

	/**
	 * Interesting events.
	 * Example: User logs in, SQL logs.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function info( $message, array $context = [] )
	{
		$this->log( static::INFO, $message, $context );
	}

	/**
	 * Normal but significant events.
	 *
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	public function notice( $message, array $context = [] )
	{
		$this->log( static::NOTICE, $message, $context );
	}

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

	/**
	 * @param string $message
	 * @param array $context
	 * @return array|string
	 */
	protected function interpolate( $message, array $context = [] )
	{
		if( is_array( $message )) {
			return htmlspecialchars( print_r( $array, true ), ENT_QUOTES, 'UTF-8' );

The variable $array does not exist. Did you forget to declare it?

		}
		$replace = [];
		foreach( $context as $key => $val ) {
			if( is_object( $val ) && get_class( $val ) === 'DateTime' ) {
				$val = $val->format( 'Y-m-d H:i:s' );
			}
			else if( is_object( $val ) || is_array( $val )) {
				$val = json_encode( $val );
			}
			else if( is_resource( $val )) {
				$val = (string) $val;
			}
			$replace['{'.$key.'}'] = $val;
		}
		return strtr( $message, $replace );
	}

	/**
	 * @param mixed $level
	 * @param string $message
	 * @param array $context
	 * @return void
	 */
	protected function log( $level, $message, array $context = [] )
	{
		if( !defined( 'CASTOR_DEBUG' )
			|| CASTOR_DEBUG !== true
			|| !in_array( $level, (new ReflectionClass( __NAMESPACE__.'\Log' ))->getConstants(), true )
		)return;
		$date = get_date_from_gmt( gmdate('Y-m-d H:i:s') );
		$level = strtoupper( $level );
		$message = $this->interpolate( $message, $context );
		$entry = "[$date] $level: $message" . PHP_EOL;
		file_put_contents( $this->file, $entry, FILE_APPEND|LOCK_EX );
	}
}