ContextSource::getOpt() - Code Metrics - Inspection of "shorthand" - Daimona/BotRiconferme - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4cf7bd...148f21 )

by Daimona

created 2019-04-15 16:37 UTC

ContextSource::getOpt() A

↳ Parent: ContextSource

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	2
rs	10
c	0
b	0
f	0

<?php declare( strict_types=1 );

namespace BotRiconferme;

use BotRiconferme\Wiki\Controller;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;

/**
 * Base class with a few utility methods available to get a logger, the config and a wiki controller
 */
abstract class ContextSource implements LoggerAwareInterface {
	/** @var LoggerInterface */
	private $logger;

	/** @var Config */
	private $config;

	/** @var Controller */
	private $controller;

	public function __construct() {
		$this->setLogger( new Logger );
		$this->setConfig( Config::getInstance() );
		$this->setController( new Controller );
	}

	/**
	 * @return LoggerInterface
	 */
	protected function getLogger() : LoggerInterface {
		return $this->logger;
	}

	/**
	 * @inheritDoc
	 */
	public function setLogger( LoggerInterface $logger ) {
		$this->logger = $logger;
	}

	/**
	 * Shorthand to $this->getConfig()->get
	 *
	 * @param string $optname
	 * @return mixed
	 */
	protected function getOpt( string $optname ) {
		return $this->getConfig()->get( $optname );
	}

	/**
	 * @return Config
	 */
	protected function getConfig() : Config {
		return $this->config;
	}

	/**
	 * @param Config $cfg
	 */
	protected function setConfig( Config $cfg ) {
		$this->config = $cfg;
	}

	/**
	 * @return Controller
	 */
	protected function getController() : Controller {
		return $this->controller;
	}

	/**
	 * @param Controller $controller
	 */
	protected function setController( Controller $controller ) {
		$this->controller = $controller;
	}

	/**
	 * Get a message
	 *
	 * @param string $key
	 * @return Message
	 */
	protected function msg( string $key ) : Message {
		return new Message( $key );
	}
}


1			<?php declare( strict_types=1 );
2
3			namespace BotRiconferme;
4
5			use BotRiconferme\Wiki\Controller;
6			use Psr\Log\LoggerAwareInterface;
7			use Psr\Log\LoggerInterface;
8
9			/**
10			* Base class with a few utility methods available to get a logger, the config and a wiki controller
11			*/
12			abstract class ContextSource implements LoggerAwareInterface {
13			/** @var LoggerInterface */
14			private $logger;
15
16			/** @var Config */
17			private $config;
18
19			/** @var Controller */
20			private $controller;
21
22			public function __construct() {
23			$this->setLogger( new Logger );
24			$this->setConfig( Config::getInstance() );
25			$this->setController( new Controller );
26			}
27
28			/**
29			* @return LoggerInterface
30			*/
31			protected function getLogger() : LoggerInterface {
32			return $this->logger;
33			}
34
35			/**
36			* @inheritDoc
37			*/
38			public function setLogger( LoggerInterface $logger ) {
39			$this->logger = $logger;
40			}
41
42			/**
43			* Shorthand to $this->getConfig()->get
44			*
45			* @param string $optname
46			* @return mixed
47			*/
48			protected function getOpt( string $optname ) {
49			return $this->getConfig()->get( $optname );
50			}
51
52			/**
53			* @return Config
54			*/
55			protected function getConfig() : Config {
56			return $this->config;
57			}
58
59			/**
60			* @param Config $cfg
61			*/
62			protected function setConfig( Config $cfg ) {
63			$this->config = $cfg;
64			}
65
66			/**
67			* @return Controller
68			*/
69			protected function getController() : Controller {
70			return $this->controller;
71			}
72
73			/**
74			* @param Controller $controller
75			*/
76			protected function setController( Controller $controller ) {
77			$this->controller = $controller;
78			}
79
80			/**
81			* Get a message
82			*
83			* @param string $key
84			* @return Message
85			*/
86			protected function msg( string $key ) : Message {
87			return new Message( $key );
88			}
89			}
90

Daimona / BotRiconferme

Push — master ( 4cf7bd...148f21 )

ContextSource::getOpt() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like