Effiliation::getMerchants() - Code Metrics - Inspection of "Handle more info in merchant class / import additi..." - padosoft/laravel-affiliate-network - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0da1fc...5080df )

unknown

created 2018-04-24 11:14 UTC

Effiliation::getMerchants() B

↳ Parent: Effiliation

Complexity

Conditions	3
Paths	3

Size

Total Lines	25
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	25
rs	8.8571
c	0
b	0
f	0
cc	3
eloc	18
nc	3
nop	0

<?php

namespace Padosoft\AffiliateNetwork\Networks;

use Padosoft\AffiliateNetwork\Transaction;
use Padosoft\AffiliateNetwork\Merchant;
use Padosoft\AffiliateNetwork\Stat;
use Padosoft\AffiliateNetwork\Deal;
use Padosoft\AffiliateNetwork\AbstractNetwork;
use Padosoft\AffiliateNetwork\NetworkInterface;
use Padosoft\AffiliateNetwork\DealsResultset;
use Padosoft\AffiliateNetwork\ProductsResultset;

// require "../vendor/fubralimited/php-oara/Oara/Network/Publisher/Effiliation/Zapi/ApiClient.php";

/**
 * Class Effiliation
 * @package Padosoft\AffiliateNetwork\Networks
 */
class Effiliation extends AbstractNetwork implements NetworkInterface
{
    /**
     * @var object
     */
    private $_network = null;
    private $_apiClient = null;
    private $_password = '';
    protected $_tracking_parameter    = 'effi_id';
    /**
     * @method __construct
     */
    public function __construct(string $username, string $password,string $idSite='')

    {
        $this->_network = new \Padosoft\AffiliateNetwork\EffiliationEx;
        $this->_username = $username;

        $this->_password = $password;
        $this->login( $this->_username, $this->_password );

        $this->_apiClient = null;
    }
    public function login(string $username, string $password,string $idSite=''): bool{

        $this->_logged = false;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        if (isNullOrEmpty( $password )) {

            return false;
        }
        $this->_username = $username;

        $this->_password = $password;
        $credentials = array();
        $credentials["apiPassword"] = $this->_password;
        $this->_network->login($credentials);
        if ($this->_network->checkConnection()) {
            $this->_logged = true;

        }

        return $this->_logged;
    }

    /**
     * @return bool
     */
    public function checkLogin() : bool
    {
        return $this->_logged;
    }

    /**
     * @return array of Merchants
     */
    public function getMerchants() : array
    {
        $arrResult = array();
        $url = 'http://api.effiliation.com/apiv2/programs.xml?key=' . $this->_password . "&filter=all";
        echo "effiliation getMerchant url ",PHP_EOL;
        $content = @\file_get_contents($url);
        $xml = \simplexml_load_string($content, null, LIBXML_NOERROR | LIBXML_NOWARNING);
        foreach ($xml->program as $merchant) {
            $Merchant = Merchant::createInstance();
            $Merchant->merchant_ID = (string)$merchant->id_programme;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
            $Merchant->name = (string)$merchant->nom;
            // Added more info - 2018-04-23 <PN>
            $Merchant->launch_date = (string)$merchant->date_debut;
            $Merchant->termination_date = (string)$merchant->date_fin;
            $Merchant->status = (string)$merchant->etat;
            if (empty($Merchant->status)) {
                // Empty means "not applied"
                $Merchant->status = 'not-applied';
            }
            $Merchant->url = (string)$merchant->url;
            $arrResult[] = $Merchant;
        }

        return $arrResult;
    }

    /**
     * @param int $merchantID
     * @return array of Deal
     */
    public function getDeals($merchantID=NULL,int $page=0,int $items_per_page=10 ): DealsResultset
    {
        $result = DealsResultset::createInstance();

        $url = 'http://apiv2.effiliation.com/apiv2/commercialtrades.json?filter=mines&key='.$this->_password;
        $json = file_get_contents($url);

        $arrResult = array();
        $arrResponse = json_decode($json, true);
        if(!is_array($arrResponse) || count($arrResponse) <= 0 || !array_key_exists('supports', $arrResponse)) {
            return $arrResult;
        }
        $arrPrograms = $arrResponse['supports'];
        foreach($arrPrograms as $voucher) {
            $Deal = Deal::createInstance();
            $Deal->setValues($voucher, [
                'id_lien' => 'deal_ID' ,
                'id_programme' => 'merchant_ID' ,
                'date_debut' => 'start_date' ,
                'date_fin' => 'end_date' ,
                'nom' => 'name' ,
                'description' => 'description' ,
                'intitule' => 'code' ,
                'url_redir' => 'default_track_uri' ,
                'exclusivite' => 'is_exclusive' ,
                'type' => 'deal_type',
            ]);
            switch ($voucher['type']) {
                case 'Code de réduction':
                    $Deal->deal_type = \Oara\Utilities::OFFER_TYPE_VOUCHER;
                    break;
                case 'Bon plan':
                    $Deal->deal_type = \Oara\Utilities::OFFER_TYPE_DISCOUNT;
                    break;
                default:
                    $Deal->deal_type = \Oara\Utilities::OFFER_TYPE_DISCOUNT;
                    break;
            }
            if($merchantID > 0) {
                if($merchantID == $voucher['id_programme']) {
                    $arrResult[] = $Deal;
                }
            }
            else {
                $arrResult[] = $Deal;
            }
        }

        $result->deals[]=$arrResult;
        return $result;
    }

    /**
     * @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(\DateTime $dateFrom, \DateTime $dateTo, array $arrMerchantID = array()) : array
    {
        $arrResult = array();
        try {
            if (count( $arrMerchantID ) < 1) {

                $merchants = $this->getMerchants();
                foreach ($merchants as $merchant) {
                    $arrMerchantID[$merchant->merchant_ID] = ['cid' => $merchant->merchant_ID, 'name' => $merchant->name];
                }
            }
             $transactionList = $this->_network->getTransactionList($arrMerchantID, $dateFrom, $dateTo);

            foreach($transactionList as $transaction) {
                $myTransaction = Transaction::createInstance();
                try {
                    $myTransaction->merchant_ID = $transaction['merchantId'];
                    $myTransaction->title ='';
                    $myTransaction->currency ='EUR';
                    //echo "txdate: ".$transaction['date']."<br>";

                    if (!empty($transaction['date'])) {
                        $date = new \DateTime($transaction['date']);
                        $myTransaction->date = $date; // $date->format('Y-m-d H:i:s');

                    }
                    $myTransaction->unique_ID = $transaction['unique_id'];
                    $myTransaction->custom_ID = $transaction['custom_id'];
                    //var_dump($transaction);
                    $myTransaction->status = $transaction['status'];
                    $myTransaction->amount = $transaction['amount'];
                    $myTransaction->commission = $transaction['commission'];
                    $myTransaction->approved = false;
                    if ($transaction['status'] == \Oara\Utilities::STATUS_CONFIRMED){
                        $myTransaction->approved = true;
                    }
                    $arrResult[] = $myTransaction;
                } catch (\Exception $e) {
                    //echo "stepE ";
                    echo "<br><br>errore transazione effilitation, id: ".$myTransaction->unique_ID." msg: ".$e->getMessage()."<br><br>";
                    var_dump($e->getTraceAsString());

                    //throw new \Exception($e);

                }
            }
        } catch (\Exception $e) {
            //echo "stepE ";
            echo "<br><br>errore generico transazione effiliation: ".$e->getMessage()."<br><br>";
            var_dump($e->getTraceAsString());
            throw new \Exception($e);
        }

        return $arrResult;
    }

    /**
     * @param \DateTime $dateFrom
     * @param \DateTime $dateTo
     * @param int $merchantID
     * @return array of Stat
     */
    public function getStats(\DateTime $dateFrom, \DateTime $dateTo, int $merchantID = 0) : array
    {
        return array();
        /*

        $this->_apiClient->setConnectId($this->_username);
        $this->_apiClient->setSecretKey($this->_password);
        $dateFromIsoEngFormat = $dateFrom->format('Y-m-d');
        $dateToIsoEngFormat = $dateTo->format('Y-m-d');
        $response = $this->_apiClient->getReportBasic($dateFromIsoEngFormat, $dateToIsoEngFormat);
        $arrResponse = json_decode($response, true);
        $reportItems = $arrResponse['reportItems'];
        $Stat = Stat::createInstance();
        $Stat->reportItems = $reportItems;

        return array($Stat);
        */
    }


    /**
     * @param  array $params
     *
     * @return ProductsResultset
     */
    public function getProducts(array $params = []): ProductsResultset
    {
        // TODO: Implement getProducts() method.
        throw new \Exception("Not implemented yet");
    }

    public function getTrackingParameter(){
        return $this->_tracking_parameter;
    }
}


1		<?php
2
3		namespace Padosoft\AffiliateNetwork\Networks;
4
5		use Padosoft\AffiliateNetwork\Transaction;
6		use Padosoft\AffiliateNetwork\Merchant;
7		use Padosoft\AffiliateNetwork\Stat;
8		use Padosoft\AffiliateNetwork\Deal;
9		use Padosoft\AffiliateNetwork\AbstractNetwork;
10		use Padosoft\AffiliateNetwork\NetworkInterface;
11		use Padosoft\AffiliateNetwork\DealsResultset;
12		use Padosoft\AffiliateNetwork\ProductsResultset;
13
14		// require "../vendor/fubralimited/php-oara/Oara/Network/Publisher/Effiliation/Zapi/ApiClient.php";
15
16		/**
17		* Class Effiliation
18		* @package Padosoft\AffiliateNetwork\Networks
19		*/
20		class Effiliation extends AbstractNetwork implements NetworkInterface
21		{
22		/**
23		* @var object
24		*/
25		private $_network = null;
26		private $_apiClient = null;
27		private $_password = '';
28		protected $_tracking_parameter = 'effi_id';
29		/**
30		* @method __construct
31		*/
32		public function __construct(string $username, string $password,string $idSite='')
		0 ignored issues – show Unused Code introduced 2017-09-01 10:13 UTC by Report Bug Copy Issue Report The parameter `$idSite` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
33		{
34		$this->_network = new \Padosoft\AffiliateNetwork\EffiliationEx;
35		$this->_username = $username;
		0 ignored issues – show Bug introduced 2017-03-15 09:20 UTC by Report Bug Copy Issue Report The property `_username` does not seem to exist. Did you mean `username`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
36		$this->_password = $password;
37		$this->login( $this->_username, $this->_password );
		0 ignored issues – show Bug introduced 2017-03-15 09:20 UTC by Report Bug Copy Issue Report The property `_username` does not seem to exist. Did you mean `username`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
38		$this->_apiClient = null;
39		}
40		public function login(string $username, string $password,string $idSite=''): bool{
		0 ignored issues – show Unused Code introduced 2017-09-01 10:13 UTC by Report Bug Copy Issue Report The parameter `$idSite` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
41		$this->_logged = false;
		0 ignored issues – show Bug introduced 2017-03-15 09:20 UTC by Report Bug Copy Issue Report The property `_logged` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
42		if (isNullOrEmpty( $password )) {
43
44		return false;
45		}
46		$this->_username = $username;
		0 ignored issues – show Bug introduced 2017-03-15 09:20 UTC by Report Bug Copy Issue Report The property `_username` does not seem to exist. Did you mean `username`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
47		$this->_password = $password;
48		$credentials = array();
49		$credentials["apiPassword"] = $this->_password;
50		$this->_network->login($credentials);
51		if ($this->_network->checkConnection()) {
52		$this->_logged = true;
53
54		}
55
56		return $this->_logged;
57		}
58
59		/**
60		* @return bool
61		*/
62		public function checkLogin() : bool
63		{
64		return $this->_logged;
65		}
66
67		/**
68		* @return array of Merchants
69		*/
70		public function getMerchants() : array
71		{
72		$arrResult = array();
73		$url = 'http://api.effiliation.com/apiv2/programs.xml?key=' . $this->_password . "&filter=all";
74		echo "effiliation getMerchant url ",PHP_EOL;
75		$content = @\file_get_contents($url);
76		$xml = \simplexml_load_string($content, null, LIBXML_NOERROR \| LIBXML_NOWARNING);
77		foreach ($xml->program as $merchant) {
78		$Merchant = Merchant::createInstance();
79		$Merchant->merchant_ID = (string)$merchant->id_programme;
		0 ignored issues – show Documentation Bug introduced 2016-11-23 17:23 UTC by Report Bug Copy Issue Report The property `$merchant_ID` was declared of type `integer`, but `(string) $merchant->id_programme` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
80		$Merchant->name = (string)$merchant->nom;
81		// Added more info - 2018-04-23 <PN>
82		$Merchant->launch_date = (string)$merchant->date_debut;
83		$Merchant->termination_date = (string)$merchant->date_fin;
84		$Merchant->status = (string)$merchant->etat;
85		if (empty($Merchant->status)) {
86		// Empty means "not applied"
87		$Merchant->status = 'not-applied';
88		}
89		$Merchant->url = (string)$merchant->url;
90		$arrResult[] = $Merchant;
91		}
92
93		return $arrResult;
94		}
95
96		/**
97		* @param int $merchantID
98		* @return array of Deal
99		*/
100		public function getDeals($merchantID=NULL,int $page=0,int $items_per_page=10 ): DealsResultset
101		{
102		$result = DealsResultset::createInstance();
103
104		$url = 'http://apiv2.effiliation.com/apiv2/commercialtrades.json?filter=mines&key='.$this->_password;
105		$json = file_get_contents($url);
106
107		$arrResult = array();
108		$arrResponse = json_decode($json, true);
109		if(!is_array($arrResponse) \|\| count($arrResponse) <= 0 \|\| !array_key_exists('supports', $arrResponse)) {
110		return $arrResult;
111		}
112		$arrPrograms = $arrResponse['supports'];
113		foreach($arrPrograms as $voucher) {
114		$Deal = Deal::createInstance();
115		$Deal->setValues($voucher, [
116		'id_lien' => 'deal_ID' ,
117		'id_programme' => 'merchant_ID' ,
118		'date_debut' => 'start_date' ,
119		'date_fin' => 'end_date' ,
120		'nom' => 'name' ,
121		'description' => 'description' ,
122		'intitule' => 'code' ,
123		'url_redir' => 'default_track_uri' ,
124		'exclusivite' => 'is_exclusive' ,
125		'type' => 'deal_type',
126		]);
127		switch ($voucher['type']) {
128		case 'Code de réduction':
129		$Deal->deal_type = \Oara\Utilities::OFFER_TYPE_VOUCHER;
130		break;
131		case 'Bon plan':
132		$Deal->deal_type = \Oara\Utilities::OFFER_TYPE_DISCOUNT;
133		break;
134		default:
135		$Deal->deal_type = \Oara\Utilities::OFFER_TYPE_DISCOUNT;
136		break;
137		}
138		if($merchantID > 0) {
139		if($merchantID == $voucher['id_programme']) {
140		$arrResult[] = $Deal;
141		}
142		}
143		else {
144		$arrResult[] = $Deal;
145		}
146		}
147
148		$result->deals[]=$arrResult;
149		return $result;
150		}
151
152		/**
153		* @param \DateTime $dateFrom
154		* @param \DateTime $dateTo
155		* @param int $merchantID
		0 ignored issues – show Documentation introduced 2016-11-28 10:35 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...
156		* @return array of Transaction
157		*/
158		public function getSales(\DateTime $dateFrom, \DateTime $dateTo, array $arrMerchantID = array()) : array
159		{
160		$arrResult = array();
161		try {
162	View Code Duplication	if (count( $arrMerchantID ) < 1) {
		0 ignored issues – show Duplication introduced 2017-03-15 09:20 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
163		$merchants = $this->getMerchants();
164		foreach ($merchants as $merchant) {
165		$arrMerchantID[$merchant->merchant_ID] = ['cid' => $merchant->merchant_ID, 'name' => $merchant->name];
166		}
167		}
168		$transactionList = $this->_network->getTransactionList($arrMerchantID, $dateFrom, $dateTo);
169
170		foreach($transactionList as $transaction) {
171		$myTransaction = Transaction::createInstance();
172		try {
173		$myTransaction->merchant_ID = $transaction['merchantId'];
174		$myTransaction->title ='';
175		$myTransaction->currency ='EUR';
176		//echo "txdate: ".$transaction['date']."<br>";
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-05-05 16:47 UTC by Report Bug Copy Issue Report `73%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
177		if (!empty($transaction['date'])) {
178		$date = new \DateTime($transaction['date']);
179		$myTransaction->date = $date; // $date->format('Y-m-d H:i:s');
		0 ignored issues – show Documentation Bug introduced 2016-11-22 16:39 UTC by Report Bug Copy Issue Report It seems like `$date` of type `object<DateTime>` is incompatible with the declared type `string` of property `$date`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history... Unused Code Comprehensibility introduced 2017-04-26 16:08 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
180		}
181		$myTransaction->unique_ID = $transaction['unique_id'];
182		$myTransaction->custom_ID = $transaction['custom_id'];
183		//var_dump($transaction);
184		$myTransaction->status = $transaction['status'];
185		$myTransaction->amount = $transaction['amount'];
186		$myTransaction->commission = $transaction['commission'];
187		$myTransaction->approved = false;
188		if ($transaction['status'] == \Oara\Utilities::STATUS_CONFIRMED){
189		$myTransaction->approved = true;
190		}
191		$arrResult[] = $myTransaction;
192		} catch (\Exception $e) {
193		//echo "stepE ";
194		echo "<br><br>errore transazione effilitation, id: ".$myTransaction->unique_ID." msg: ".$e->getMessage()."<br><br>";
195		var_dump($e->getTraceAsString());
		0 ignored issues – show Security Debugging Code introduced 2017-06-26 13:22 UTC by Report Bug Copy Issue Report `var_dump($e->getTraceAsString());` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
196		//throw new \Exception($e);
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-04-26 17:02 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
197		}
198		}
199		} catch (\Exception $e) {
200		//echo "stepE ";
201		echo "<br><br>errore generico transazione effiliation: ".$e->getMessage()."<br><br>";
202		var_dump($e->getTraceAsString());
203		throw new \Exception($e);
204		}
205
206		return $arrResult;
207		}
208
209		/**
210		* @param \DateTime $dateFrom
211		* @param \DateTime $dateTo
212		* @param int $merchantID
213		* @return array of Stat
214		*/
215		public function getStats(\DateTime $dateFrom, \DateTime $dateTo, int $merchantID = 0) : array
216		{
217		return array();
218		/*
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-04-13 14:00 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
219		$this->_apiClient->setConnectId($this->_username);
220		$this->_apiClient->setSecretKey($this->_password);
221		$dateFromIsoEngFormat = $dateFrom->format('Y-m-d');
222		$dateToIsoEngFormat = $dateTo->format('Y-m-d');
223		$response = $this->_apiClient->getReportBasic($dateFromIsoEngFormat, $dateToIsoEngFormat);
224		$arrResponse = json_decode($response, true);
225		$reportItems = $arrResponse['reportItems'];
226		$Stat = Stat::createInstance();
227		$Stat->reportItems = $reportItems;
228
229		return array($Stat);
230		*/
231		}
232
233
234		/**
235		* @param array $params
236		*
237		* @return ProductsResultset
238		*/
239		public function getProducts(array $params = []): ProductsResultset
240		{
241		// TODO: Implement getProducts() method.
242		throw new \Exception("Not implemented yet");
243		}
244
245		public function getTrackingParameter(){
246		return $this->_tracking_parameter;
247		}
248		}
249

padosoft / laravel-affiliate-network

Push — master ( 0da1fc...5080df )

Effiliation::getMerchants() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like