lloc\Msls\ContentImport\ImportLogger

Complexity

Total Complexity

23

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	merge()	0	7	2
A	get_data()	0	3	1
B	save()	0	28	4
A	log_error()	0	3	1
A	log()	0	10	2
A	build_nested_array()	0	13	1
A	build_path()	0	5	1
A	get_levels_delimiter()	0	3	1
A	set_levels_delimiter()	0	3	1
A	log_success()	0	3	1
A	log_information()	0	3	1
A	get_error()	0	3	1
A	get_nested_value()	0	11	2
A	get_success()	0	3	1
A	get_information()	0	3	2

<?php

namespace lloc\Msls\ContentImport;


use lloc\Msls\ContentImport\LogWriters\AdminNoticeLogger;
use lloc\Msls\ContentImport\LogWriters\LogWriter;

class ImportLogger {

	protected $levels_delimiter = '/';

	protected $data = [
		'info'    => [],
		'error'   => [],
		'success' => [],
	];

	/**
	 * @var ImportCoordinates
	 */
	protected $import_coordinates;

	public function __construct( ImportCoordinates $import_coordinates ) {
		$this->import_coordinates = $import_coordinates;
	}

	/**
	 * Merges the specified log data into this log.
	 *
	 * @param ImportLogger|null $logger
	 */
	public function merge( ImportLogger $logger = null ) {
		if ( null === $logger ) {
			return;
		}

		$this->data = array_merge_recursive( $this->data, $logger->get_data() );
	}

	/**
	 * @return array
	 */
	public function get_data() {
		return $this->data;
	}

	/**
	 * Saves the log or prints it some place.
	 */
	public function save() {
		$log_writer = $default_log_writer = AdminNoticeLogger::instance();
		$log_writer->set_import_coordinates( $this->import_coordinates );

		/**
		 * Filters the log class or object that should be used to write the log to the destination.
		 *
		 * @param LogWriter $log_writer
		 * @param ImportCoordinates $import_coordinates
		 */
		$log_writer = apply_filters( 'msls_content_import_log_writer', $log_writer, $this->import_coordinates );

		if ( empty( $log_writer ) ) {
			// we assume that was done on purpose to prevent logging
			return;
		}

		if ( is_string( $log_writer ) ) {
			$log_writer = new $log_writer;
		}

		if ( ! $log_writer instanceof LogWriter ) {
			// something is fishy, let's use the default one
			$log_writer = $default_log_writer;
		}

		$log_writer->write( $this->get_data() );
	}

	/**
	 * Logs an error.
	 *
	 * @param string $where A location string using `/` as level format.
	 * @param mixed  $what  What should be stored in the log.
	 */
	public function log_error( $where, $what ) {
		$this->log( $where, $what, 'error' );
	}

	/**
	 * Logs something.
	 *
	 * @param string $where A location string using `/` as level format.
	 * @param mixed  $what  What should be stored in the log.
	 * @param string $root  Where to log the information.
	 */
	protected function log( $where, $what, $root = 'info' ) {
		if ( ! isset( $this->data[ $root ] ) ) {
			$this->data[ $root ] = [];
		}

		$data = $this->build_nested_array( $this->build_path( $where ), $what );

Functions must not contain multiple empty lines in a row; found 2 empty lines

		$this->data[ $root ] = array_merge_recursive( $this->data[ $root ], $data );
	}

	protected function build_nested_array( $path, $what = '' ) {
		$json = '{"'
		        . implode( '":{"', $path )
		        . '":' . json_encode( $what )
		        . implode(
			        '',
			        array_fill( 0, count( $path ),
				        '}' )

This line of the multi-line function call does not seem to be indented correctly. Expected 20 spaces, but found 24.

		        );
		$data = json_decode( $json, true );

		return $data;
	}

	/**
	 * @param $where
	 *
	 * @return array
	 */
	protected function build_path( $where ) {
		$where_path = explode( $this->levels_delimiter, $where );

		return $where_path;
	}

	/**
	 * Returns the string that will be used to split paths into levels.
	 *
	 * @return string
	 */
	public function get_levels_delimiter() {
		return $this->levels_delimiter;
	}

	/**
	 * Sets the string that will be used to split paths into levels.
	 *
	 * @param string $levels_delimiter
	 */
	public function set_levels_delimiter( $levels_delimiter ) {
		$this->levels_delimiter = $levels_delimiter;
	}

	/**
	 * Logs a success.
	 *
	 * @param string $where A location string using `/` as level format.
	 * @param mixed  $what  What should be stored in the log.
	 */
	public function log_success( $where, $what ) {
		$this->log( $where, $what, 'success' );
	}

	/**
	 * Logs some generic information.
	 *
	 * @param string $message
	 */
	public function log_information( $key, $message ) {
		$this->data['info'][ $key ] = $message;
	}

	public function get_error( $where ) {
		return $this->get_nested_value( 'error' . $this->levels_delimiter . $where );
	}

	/**
	 * @param $where
	 *
	 * @return mixed
	 */
	protected function get_nested_value( $where ) {
		$path = $this->build_path( $where );

		$data = $this->data[ array_shift( $path ) ];

		foreach ( $path as $frag ) {
			$data = $data[ $frag ];
		}

		return $data;
	}

	public function get_success( $where ) {
		return $this->get_nested_value( 'success' . $this->levels_delimiter . $where );
	}

	public function get_information( $key ) {
		return isset( $this->data['info'][ $key ] ) ? $this->data['info'][ $key ] : '';
	}
}