GenericLoggerFactory::create() - Code Metrics - Inspection of "Documention and code tweaks" - gamernetwork/yolk-log - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( c94dac...b0240c )

by Simon

created 2016-04-18 15:17 UTC

GenericLoggerFactory::create() B

↳ Parent: GenericLoggerFactory

Complexity

Conditions	4
Paths	4

Size

Total Lines	30
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
c	3
b	0
f	1
dl	0
loc	30
rs	8.5806
cc	4
eloc	19
nc	4
nop	1

<?php
/*
 * This file is part of Yolk - Gamer Network's PHP Framework.
 *
 * Copyright (c) 2014 Gamer Network Ltd.
 * 
 * Distributed under the MIT License, a copy of which is available in the
 * LICENSE file that was bundled with this package, or online at:
 * https://github.com/gamernetwork/yolk-logger
 */

namespace yolk\log;

use yolk\contracts\log\LoggerFactory;
use yolk\contracts\log\Logger;

class GenericLoggerFactory implements LoggerFactory {

	protected $classes;

	public function __construct( array $classes = [] ) {

		$this->classes = $classes + [
			'php'    => __NAMESPACE__. '\adapter\PHPLogger',
			'file'   => __NAMESPACE__. '\adapter\FileLogger',
			'stderr' => __NAMESPACE__. '\adapter\StdErrLogger',
			'stdout' => __NAMESPACE__. '\adapter\StdOutLogger',
			'syslog' => __NAMESPACE__. '\adapter\SysLogger',
			'null'   => __NAMESPACE__. '\adapter\NullLogger',
		];

	}

	public function create( $config ) {

		$config = $this->checkConfig($config);

		$factories = [
			'php'    => 'createPHPLogger',
			'file'   => 'createFileLogger',
			'syslog' => 'createSysLogger',
			'stderr' => 'createStdErrLogger',
			'stdout' => 'createStdOutLogger',
			'null'   => 'createNullLogger',
		];

		if( empty($factories[$config['type']]) )
			throw new Exception("Invalid logger type: {$config['type']}");

		$factory = $factories[$config['type']];

		if( $config['type'] == 'file' ) {
			$config = $config + ['file' => ''];
			return $this->$factory($config['file'], $config['threshold']);
		}
		elseif( $config['type'] == 'syslog' ) {
			$config = $config + ['prefix' => ''];
			return $this->$factory($config['prefix'], $config['threshold']);
		}

		return $this->$factory($config['threshold']);

	}

	/**
	 * Create a logger that outputs to the standard PHP error log.
	 * @param  integer $threshold
	 * @return Logger
	 */
	public function createPHPLogger( $threshold = LogLevel::WARNING ) {
		return $this->createLogger('php')
			->setThreshold($threshold);
	}

	/**
	 * Create a logger that outputs to the specified file.
	 * @param  integer $threshold
	 * @return Logger
	 */
	public function createFileLogger( $file, $threshold = LogLevel::WARNING ) {
		return $this->createLogger('file', $file)
			->setThreshold($threshold);
	}

	/**
	 * Create a logger that outputs to Syslog.
	 * @param  integer $threshold
	 * @return Logger
	 */
	public function createSysLogger( $prefix = '', $threshold = LogLevel::WARNING ) {
		return $this->createLogger('syslog', $prefix)
			->setThreshold($threshold);
	}

	/**
	 * Create a logger that outputs to StdOut.
	 * The StdOut logger is only available when running via the command-line.
	 * @param  integer $threshold
	 * @return Logger
	 */
	public function createStdOutLogger( $threshold = LogLevel::WARNING ) {
		return $this->createLogger('stdout')
			->setThreshold($threshold);
	}

	/**
	 * Create a logger that outputs to StdErr.
	 * The StdErr logger is only available when running via the command-line.
	 * @param  integer $threshold
	 * @return Logger
	 */
	public function createStdErrLogger( $threshold = LogLevel::WARNING ) {
		return $this->createLogger('stderr')
			->setThreshold($threshold);
	}

	/**
	 * Create a logger that performs no output.
	 * @param  integer $threshold
	 * @return Logger
	 */
	public function createNullLogger( $threshold = LogLevel::WARNING ) {
		return $this->createLogger('null')
			->setThreshold($threshold);
	}

	/**
	 * Ensure the configuration is in a consistant format.
	 * @param  array|string $config
	 * @return array
	 */
	protected function checkConfig( $config ) {

		// if config isn't an array then treat it as the log type
		// - some adapters don't require configuration options
		if( !is_array($config) ) {
			$config = [
				'type' => $config,
			];
		}

		$config = $config + [
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			'type'   => '',
			'threshold' => LogLevel::WARNING,
		];

	}

	protected function createLogger( $type, $arg1 = null, $arg2 = null, $arg3 = null ) {

		// check the class exists before we try and use it
		if( !class_exists($class = $this->classes[$type]) )
			throw new Exception(sprintf("Class '\\%s' not found for logger type '%s'", $class, $type));

		// create a new instance
		$log = new $class($arg1, $arg2, $arg3);

		// check the instance implements the correct interface
		if( !$log instanceof Logger )
			throw new Exception(sprintf("Class '\\%s' does not implement yolk\contracts\log\Logger", $class));

		return $log;

	}

}

// EOF

1			<?php
2			/*
3			* This file is part of Yolk - Gamer Network's PHP Framework.
4			*
5			* Copyright (c) 2014 Gamer Network Ltd.
6			*
7			* Distributed under the MIT License, a copy of which is available in the
8			* LICENSE file that was bundled with this package, or online at:
9			* https://github.com/gamernetwork/yolk-logger
10			*/
11
12			namespace yolk\log;
13
14			use yolk\contracts\log\LoggerFactory;
15			use yolk\contracts\log\Logger;
16
17			class GenericLoggerFactory implements LoggerFactory {
18
19			protected $classes;
20
21			public function __construct( array $classes = [] ) {
22
23			$this->classes = $classes + [
24			'php' => __NAMESPACE__. '\adapter\PHPLogger',
25			'file' => __NAMESPACE__. '\adapter\FileLogger',
26			'stderr' => __NAMESPACE__. '\adapter\StdErrLogger',
27			'stdout' => __NAMESPACE__. '\adapter\StdOutLogger',
28			'syslog' => __NAMESPACE__. '\adapter\SysLogger',
29			'null' => __NAMESPACE__. '\adapter\NullLogger',
30			];
31
32			}
33
34			public function create( $config ) {
35
36			$config = $this->checkConfig($config);
37
38			$factories = [
39			'php' => 'createPHPLogger',
40			'file' => 'createFileLogger',
41			'syslog' => 'createSysLogger',
42			'stderr' => 'createStdErrLogger',
43			'stdout' => 'createStdOutLogger',
44			'null' => 'createNullLogger',
45			];
46
47			if( empty($factories[$config['type']]) )
48			throw new Exception("Invalid logger type: {$config['type']}");
49
50			$factory = $factories[$config['type']];
51
52			if( $config['type'] == 'file' ) {
53			$config = $config + ['file' => ''];
54			return $this->$factory($config['file'], $config['threshold']);
55			}
56			elseif( $config['type'] == 'syslog' ) {
57			$config = $config + ['prefix' => ''];
58			return $this->$factory($config['prefix'], $config['threshold']);
59			}
60
61			return $this->$factory($config['threshold']);
62
63			}
64
65			/**
66			* Create a logger that outputs to the standard PHP error log.
67			* @param integer $threshold
68			* @return Logger
69			*/
70			public function createPHPLogger( $threshold = LogLevel::WARNING ) {
71			return $this->createLogger('php')
72			->setThreshold($threshold);
73			}
74
75			/**
76			* Create a logger that outputs to the specified file.
77			* @param integer $threshold
78			* @return Logger
79			*/
80			public function createFileLogger( $file, $threshold = LogLevel::WARNING ) {
81			return $this->createLogger('file', $file)
82			->setThreshold($threshold);
83			}
84
85			/**
86			* Create a logger that outputs to Syslog.
87			* @param integer $threshold
88			* @return Logger
89			*/
90			public function createSysLogger( $prefix = '', $threshold = LogLevel::WARNING ) {
91			return $this->createLogger('syslog', $prefix)
92			->setThreshold($threshold);
93			}
94
95			/**
96			* Create a logger that outputs to StdOut.
97			* The StdOut logger is only available when running via the command-line.
98			* @param integer $threshold
99			* @return Logger
100			*/
101			public function createStdOutLogger( $threshold = LogLevel::WARNING ) {
102			return $this->createLogger('stdout')
103			->setThreshold($threshold);
104			}
105
106			/**
107			* Create a logger that outputs to StdErr.
108			* The StdErr logger is only available when running via the command-line.
109			* @param integer $threshold
110			* @return Logger
111			*/
112			public function createStdErrLogger( $threshold = LogLevel::WARNING ) {
113			return $this->createLogger('stderr')
114			->setThreshold($threshold);
115			}
116
117			/**
118			* Create a logger that performs no output.
119			* @param integer $threshold
120			* @return Logger
121			*/
122			public function createNullLogger( $threshold = LogLevel::WARNING ) {
123			return $this->createLogger('null')
124			->setThreshold($threshold);
125			}
126
127			/**
128			* Ensure the configuration is in a consistant format.
129			* @param array\|string $config
130			* @return array
131			*/
132			protected function checkConfig( $config ) {
133
134			// if config isn't an array then treat it as the log type
135			// - some adapters don't require configuration options
136			if( !is_array($config) ) {
137			$config = [
138			'type' => $config,
139			];
140			}
141
142			$config = $config + [
			0 ignored issues – show Unused Code introduced 2016-04-18 15:20 UTC by Report Bug Copy Issue Report `$config` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
143			'type' => '',
144			'threshold' => LogLevel::WARNING,
145			];
146
147			}
148
149			protected function createLogger( $type, $arg1 = null, $arg2 = null, $arg3 = null ) {
150
151			// check the class exists before we try and use it
152			if( !class_exists($class = $this->classes[$type]) )
153			throw new Exception(sprintf("Class '\\%s' not found for logger type '%s'", $class, $type));
154
155			// create a new instance
156			$log = new $class($arg1, $arg2, $arg3);
157
158			// check the instance implements the correct interface
159			if( !$log instanceof Logger )
160			throw new Exception(sprintf("Class '\\%s' does not implement yolk\contracts\log\Logger", $class));
161
162			return $log;
163
164			}
165
166			}
167
168			// EOF

gamernetwork / yolk-log

Push — develop ( c94dac...b0240c )

GenericLoggerFactory::create() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like