NetworkManager - Code Metrics - padosoft/laravel-affiliate-network - Measure and Improve Code Quality continuously with Scrutinizer

NetworkManager A
last analyzed 2021-06-03 10:42 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	226
Duplicated Lines	8.41 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	41
lcom	1
cbo	1
dl	19
loc	226
rs	9.1199
c	0
b	0
f	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	logCapture()	0	11	3
B	logFlush()	0	24	7
A	setLogger()	0	4	1
A	addNetwork()	0	12	3
A	getNetwork()	0	7	2
A	loadAvailableNetworks()	0	10	4
A	getAvailableNetworks()	0	3	1
A	hasNetwork()	0	7	3
A	getDeals()	0	13	3
A	getSales()	0	10	2
A	getStats()	0	7	2
A	getMerchants()	10	10	2
A	checkLogin()	9	9	2
A	login()	0	12	3
A	getTrackingParameter()	0	6	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like NetworkManager often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use NetworkManager, and based on these observations, apply Extract Interface, too.

<?php

namespace Padosoft\AffiliateNetwork;

use Padosoft\AffiliateNetwork\DealsResultset;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;


/**
 * Class NetworkManager
 * @package Padosoft\AffiliateNetwork
 */
class NetworkManager
{
    /**
     * Network/api
     * @var NetworkInterface
     */
    protected $networks = [];
    protected $avaliable_networks = [];
    protected $loggerService = null;

    /**
     * Register the dependencies
     */
    public function __construct()
    {
        $this->loadAvailableNetworks();
    }

    public function logCapture()
    {
        if (!is_null($this->loggerService)) {
            if (ob_get_contents() != '') {
                // flush any pending log
                $this->logFlush();
            }
            // Initialize output capture
            ob_start();
        }
    }

    /**
     * Flush the captured log messages
     */
    public function logFlush()
    {
        if (!is_null($this->loggerService)) {
            $messages = @ob_get_flush();
            $messages = str_replace('<BR>',PHP_EOL, $messages);
            $a_messages = explode(PHP_EOL, $messages);
            foreach ($a_messages as $message) {
                if (!empty(trim($message))) {
                    if (strpos(strtolower($message), 'error') !== false) {
                        $this->loggerService->error($message);
                    }
                    elseif (strpos(strtolower($message), 'warning') !== false) {
                        $this->loggerService->warning($message);
                    }
                    elseif (strpos(strtolower($message), 'debug') !== false) {
                        $this->loggerService->debug($message);
                    }
                    else {
                        $this->loggerService->info($message);
                    }
                }
            }
        }
    }

    /**
     * Inject an external Log service compatible with Psr\Log interface
     * @param Psr\Log\LoggerInterface $loggerService
     */
    public function setLogger(\Psr\Log\LoggerInterface $loggerService)
    {
        $this->loggerService = $loggerService;
    }

    /**
     * Add a network / api to use
     *
     * @param NetworkInterface $network
     * @param string $network_alias
     */
    public function addNetwork(NetworkInterface $network, $network_alias = '')
    {
        if (trim($network_alias)==''){
            $path = explode('\\', get_class($network));
            $network_alias = array_pop($path);
        }
        if (!array_key_exists( $network_alias, $this->networks )) {
            $this->networks[$network_alias] = $network;
        }
        $this->avaliable_networks[$network_alias]=get_class($network);

    }

    /**
     * Get a network
     * @return NetworkInterface|null
     */
    public function getNetwork($network_alias)
    {
        if (!$this->hasNetwork($network_alias)) {
            return null;
        }
        return $this->networks[$network_alias];
    }

    /**
     * @return array
     */
    protected function loadAvailableNetworks(){
        $classes=scandir(__DIR__.'/Networks');
        foreach ($classes AS $network_class){
            if ($network_class=='.' || $network_class=='..'){
                continue;
            }
            $class = new \ReflectionClass(__NAMESPACE__.'\\Networks\\'.substr($network_class,0,-4));
            $this->avaliable_networks[$class->getShortName()]=$class->getName();
        }
    }

    public function getAvailableNetworks():array {
        return $this->avaliable_networks;
    }

    /**
     * @param $network_alias
     * @param string $username
     * @param string $password
     * @param string $id_site
     * @param string $country
     * @return bool
     */
    public function hasNetwork($network_alias, $username = '', $password = '', string $id_site = '', string $country = '') {
        if (!array_key_exists($network_alias, $this->networks ) && array_key_exists($network_alias, $this->avaliable_networks)){
            $fully_className=$this->avaliable_networks[$network_alias];
            $this->networks[$network_alias]= new $fully_className($username, $password, $id_site, $country);
        }
        return array_key_exists($network_alias, $this->networks );
    }

    /**
     * @param $network_alias
     * @param int $merchantID
     *
     * @return \Padosoft\AffiliateNetwork\DealsResultset
     */
    public function getDeals($network_alias, int $merchantID = 0, int $page = 0, int $items_per_page = 0 ): DealsResultset
    {
        if (!$this->hasNetwork($network_alias)) {
            return DealsResultset::createInstance();
        }
        if (!isIntegerPositive($merchantID)){
            $merchantID=NULL;
        }
        $this->logCapture();
        $a_deals = $this->networks[$network_alias]->getDeals( $merchantID, $page, $items_per_page );
        $this->logFlush();
        return $a_deals;
    }

    /**
     * @param \DateTime $dateFrom
     * @param \DateTime $dateTo
     * @param int $merchantID
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return array of Transaction
     */
    public function getSales(string $network_alias, \DateTime $dateFrom, \DateTime $dateTo, array $arrMerchantID = array()): array
    {
        if (!$this->hasNetwork($network_alias)) {
            return [];
        }
        $this->logCapture();
        $a_sales = $this->networks[$network_alias]->getSales( $dateFrom, $dateTo, $arrMerchantID );
        $this->logFlush();
        return $a_sales;
    }

    /**
     * @param \DateTime $dateFrom
     * @param \DateTime $dateTo
     * @param int $merchantID
     *
     * @return array of Stat
     */
    public function getStats(string $network_alias, \DateTime $dateFrom, \DateTime $dateTo, int $merchantID = 0): array
    {
        if (!$this->hasNetwork($network_alias)) {
            return [];
        }
        return $this->networks[$network_alias]->getStats( $dateFrom, $dateTo, $merchantID );
    }

    public function getMerchants(string $network_alias) : array{

        if (!$this->hasNetwork($network_alias)) {
            return [];
        }
        $this->logCapture();
        $a_merchants = $this->networks[$network_alias]->getMerchants();
        $this->logFlush();
        return $a_merchants;

    }

    public function checkLogin(string $network_alias): bool{

        if (!$this->hasNetwork($network_alias)) {
            return false;
        }
        $this->logCapture();
        $success = $this->networks[$network_alias]->checkLogin();
        $this->logFlush();
        return $success;
    }

    public function login(string $network_alias, string $username, string $password, string $id_site = '', string $country = ''): bool{
        if (!$this->hasNetwork($network_alias, $username, $password, $id_site, $country)) {
            return false;
        }
        if (!$this->networks[$network_alias]->checkLogin()) {
            $this->logCapture();
            $success = $this->networks[$network_alias]->login($username, $password, $id_site, $country);
            $this->logFlush();
            return $success;
        }
        return true;
    }

    public function getTrackingParameter(string $network_alias):string {
        if (!$this->hasNetwork($network_alias)) {
            return false;
        }
        return $this->networks[$network_alias]->getTrackingParameter();
    }
}


1		<?php
2
3		namespace Padosoft\AffiliateNetwork;
4
5		use Padosoft\AffiliateNetwork\DealsResultset;
6		use Psr\Log\LoggerInterface;
7		use Psr\Log\LogLevel;
8
9
10		/**
11		* Class NetworkManager
12		* @package Padosoft\AffiliateNetwork
13		*/
14		class NetworkManager
15		{
16		/**
17		* Network/api
18		* @var NetworkInterface
19		*/
20		protected $networks = [];
21		protected $avaliable_networks = [];
22		protected $loggerService = null;
23
24		/**
25		* Register the dependencies
26		*/
27		public function __construct()
28		{
29		$this->loadAvailableNetworks();
30		}
31
32		public function logCapture()
33		{
34		if (!is_null($this->loggerService)) {
35		if (ob_get_contents() != '') {
36		// flush any pending log
37		$this->logFlush();
38		}
39		// Initialize output capture
40		ob_start();
41		}
42		}
43
44		/**
45		* Flush the captured log messages
46		*/
47		public function logFlush()
48		{
49		if (!is_null($this->loggerService)) {
50		$messages = @ob_get_flush();
51		$messages = str_replace('<BR>',PHP_EOL, $messages);
52		$a_messages = explode(PHP_EOL, $messages);
53		foreach ($a_messages as $message) {
54		if (!empty(trim($message))) {
55		if (strpos(strtolower($message), 'error') !== false) {
56		$this->loggerService->error($message);
57		}
58		elseif (strpos(strtolower($message), 'warning') !== false) {
59		$this->loggerService->warning($message);
60		}
61		elseif (strpos(strtolower($message), 'debug') !== false) {
62		$this->loggerService->debug($message);
63		}
64		else {
65		$this->loggerService->info($message);
66		}
67		}
68		}
69		}
70		}
71
72		/**
73		* Inject an external Log service compatible with Psr\Log interface
74		* @param Psr\Log\LoggerInterface $loggerService
75		*/
76		public function setLogger(\Psr\Log\LoggerInterface $loggerService)
77		{
78		$this->loggerService = $loggerService;
79		}
80
81		/**
82		* Add a network / api to use
83		*
84		* @param NetworkInterface $network
85		* @param string $network_alias
86		*/
87		public function addNetwork(NetworkInterface $network, $network_alias = '')
88		{
89		if (trim($network_alias)==''){
90		$path = explode('\\', get_class($network));
91		$network_alias = array_pop($path);
92		}
93		if (!array_key_exists( $network_alias, $this->networks )) {
94		$this->networks[$network_alias] = $network;
95		}
96		$this->avaliable_networks[$network_alias]=get_class($network);
97
98		}
99
100		/**
101		* Get a network
102		* @return NetworkInterface\|null
103		*/
104		public function getNetwork($network_alias)
105		{
106		if (!$this->hasNetwork($network_alias)) {
107		return null;
108		}
109		return $this->networks[$network_alias];
110		}
111
112		/**
113		* @return array
114		*/
115		protected function loadAvailableNetworks(){
116		$classes=scandir(__DIR__.'/Networks');
117		foreach ($classes AS $network_class){
118		if ($network_class=='.' \|\| $network_class=='..'){
119		continue;
120		}
121		$class = new \ReflectionClass(__NAMESPACE__.'\\Networks\\'.substr($network_class,0,-4));
122		$this->avaliable_networks[$class->getShortName()]=$class->getName();
123		}
124		}
125
126		public function getAvailableNetworks():array {
127		return $this->avaliable_networks;
128		}
129
130		/**
131		* @param $network_alias
132		* @param string $username
133		* @param string $password
134		* @param string $id_site
135		* @param string $country
136		* @return bool
137		*/
138		public function hasNetwork($network_alias, $username = '', $password = '', string $id_site = '', string $country = '') {
139		if (!array_key_exists($network_alias, $this->networks ) && array_key_exists($network_alias, $this->avaliable_networks)){
140		$fully_className=$this->avaliable_networks[$network_alias];
141		$this->networks[$network_alias]= new $fully_className($username, $password, $id_site, $country);
142		}
143		return array_key_exists($network_alias, $this->networks );
144		}
145
146		/**
147		* @param $network_alias
148		* @param int $merchantID
149		*
150		* @return \Padosoft\AffiliateNetwork\DealsResultset
151		*/
152		public function getDeals($network_alias, int $merchantID = 0, int $page = 0, int $items_per_page = 0 ): DealsResultset
153		{
154		if (!$this->hasNetwork($network_alias)) {
155		return DealsResultset::createInstance();
156		}
157		if (!isIntegerPositive($merchantID)){
158		$merchantID=NULL;
159		}
160		$this->logCapture();
161		$a_deals = $this->networks[$network_alias]->getDeals( $merchantID, $page, $items_per_page );
162		$this->logFlush();
163		return $a_deals;
164		}
165
166		/**
167		* @param \DateTime $dateFrom
168		* @param \DateTime $dateTo
169		* @param int $merchantID
		0 ignored issues – show Documentation introduced 2017-02-16 14:43 UTC by Report Bug Copy Issue Report There is no parameter named `$merchantID`. Did you maybe mean `$arrMerchantID`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
170		*
171		* @return array of Transaction
172		*/
173		public function getSales(string $network_alias, \DateTime $dateFrom, \DateTime $dateTo, array $arrMerchantID = array()): array
174		{
175		if (!$this->hasNetwork($network_alias)) {
176		return [];
177		}
178		$this->logCapture();
179		$a_sales = $this->networks[$network_alias]->getSales( $dateFrom, $dateTo, $arrMerchantID );
180		$this->logFlush();
181		return $a_sales;
182		}
183
184		/**
185		* @param \DateTime $dateFrom
186		* @param \DateTime $dateTo
187		* @param int $merchantID
188		*
189		* @return array of Stat
190		*/
191		public function getStats(string $network_alias, \DateTime $dateFrom, \DateTime $dateTo, int $merchantID = 0): array
192		{
193		if (!$this->hasNetwork($network_alias)) {
194		return [];
195		}
196		return $this->networks[$network_alias]->getStats( $dateFrom, $dateTo, $merchantID );
197		}
198
199	View Code Duplication	public function getMerchants(string $network_alias) : array{
		0 ignored issues – show Duplication introduced 2019-03-29 14:36 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
200		if (!$this->hasNetwork($network_alias)) {
201		return [];
202		}
203		$this->logCapture();
204		$a_merchants = $this->networks[$network_alias]->getMerchants();
205		$this->logFlush();
206		return $a_merchants;
207
208		}
209
210	View Code Duplication	public function checkLogin(string $network_alias): bool{
		0 ignored issues – show Duplication introduced 2019-03-29 14:36 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
211		if (!$this->hasNetwork($network_alias)) {
212		return false;
213		}
214		$this->logCapture();
215		$success = $this->networks[$network_alias]->checkLogin();
216		$this->logFlush();
217		return $success;
218		}
219
220		public function login(string $network_alias, string $username, string $password, string $id_site = '', string $country = ''): bool{
221		if (!$this->hasNetwork($network_alias, $username, $password, $id_site, $country)) {
222		return false;
223		}
224		if (!$this->networks[$network_alias]->checkLogin()) {
225		$this->logCapture();
226		$success = $this->networks[$network_alias]->login($username, $password, $id_site, $country);
227		$this->logFlush();
228		return $success;
229		}
230		return true;
231		}
232
233		public function getTrackingParameter(string $network_alias):string {
234		if (!$this->hasNetwork($network_alias)) {
235		return false;
236		}
237		return $this->networks[$network_alias]->getTrackingParameter();
238		}
239		}
240

padosoft / laravel-affiliate-network

NetworkManager A last analyzed 2021-06-03 10:42 UTC