EbayEx::getTransactionList() - Code Metrics - Inspection of "Update dependencies" - padosoft/laravel-affiliate-network - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d6ee27...51558c )

unknown

created 2017-09-01 10:08 UTC

EbayEx::getTransactionList() B

↳ Parent: EbayEx

Complexity

Conditions	7
Paths	12

Size

Total Lines	67
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	67
rs	7.0237
c	0
b	0
f	0
cc	7
eloc	38
nc	12
nop	3

How to fix Long Method

<?php
/**
 * Copyright (c) Padosoft.com 2017.
 * Created by Paolo Nardini - 2017-08-31
 */


namespace Padosoft\AffiliateNetwork;
use Oara\Network\Publisher\Ebay as EbayOara;

class EbayEx extends EbayOara
{
    protected $_serverNumber = 6;
    protected $_merchantIdList = array();     // To avoid repeated calls to \Oara\Utilities::getMerchantIdMapFromMerchantList

    /**
     * @param $credentials
     */
    public function login($credentials)
    {
        $this->_credentials = $credentials;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->_client = new \Oara\Curl\Access($credentials);

        /*

        $valuesLogin = array(
            new \Oara\Curl\Parameter('login_username', $this->_credentials['user']),
            new \Oara\Curl\Parameter('login_password', $this->_credentials['password']),
            new \Oara\Curl\Parameter('submit_btn', 'GO'),
            new \Oara\Curl\Parameter('hubpage', 'y')
        );
        $loginUrl = 'https://ebaypartnernetwork.com/PublisherLogin?hubpage=y&lang=en-US?';

        $urls = array();
        $urls[] = new \Oara\Curl\Request($loginUrl, $valuesLogin);
        $this->_client->post($urls);
        */
    }

    /**
     * @return array
     */
    public function getNeededCredentials()
    {
        $credentials = array();

        $parameter = array();
        $parameter["description"] = "User Log in";
        $parameter["required"] = true;
        $parameter["name"] = "User";
        $credentials["user"] = $parameter;

        $parameter = array();
        $parameter["description"] = "Password to Log in";
        $parameter["required"] = true;
        $parameter["name"] = "Password";
        $credentials["password"] = $parameter;

        return $credentials;
    }

    /**
     * @return bool
     */
    public function checkConnection()
    {
        //If not login properly the construct launch an exception
        $connection = true;
        /*

        $yesterday = new \DateTime();
        $yesterday->sub(new \DateInterval('P2D'));

        $urls = array();
        $urls[] = new \Oara\Curl\Request("https://publisher.ebaypartnernetwork.com/PublisherReportsTx?pt=2&start_date={$yesterday->format("n/j/Y")}&end_date={$yesterday->format("n/j/Y")}&user_name={$this->_credentials['user']}&user_password={$this->_credentials['password']}&advIdProgIdCombo=&tx_fmt=2&submit_tx=Download", array());
        $exportReport = $this->_client->get($urls);

        if (\preg_match("/DOCTYPE html PUBLIC/", $exportReport[0])) {
            $connection = false;
        }
        */
        return $connection;
    }

    /**
     * @param string $idSite
     */
    public function addAllowedSite(string $idSite){
        $this->_sitesAllowed[]=$idSite;
    }

    /**
     * @return array
     */
    public function getMerchantList()
    {
        $merchants = array();

        $obj = array();
        $obj['cid'] = "1";
        $obj['name'] = "Ebay";
        $obj['url'] = "https://publisher.ebaypartnernetwork.com";
        $merchants[] = $obj;

        return $merchants;
    }

    /**
     * @param null $merchantList
     * @param \DateTime|null $dStartDate
     * @param \DateTime|null $dEndDate
     * @return array
     */
    public function getTransactionList($merchantList = null, \DateTime $dStartDate = null, \DateTime $dEndDate = null)
    {
        $totalTransactions = array();

        $urls = array();

        $postParams = array(
            new \Oara\Curl\Parameter('username', $this->_credentials['user']),
            new \Oara\Curl\Parameter('password', $this->_credentials['password']),
            new \Oara\Curl\Parameter('isEnc', 'false'),
            new \Oara\Curl\Parameter('fileFormat', 'txt'),
            new \Oara\Curl\Parameter('eventType', 'earnings'),  // use 'all' to download all events
            new \Oara\Curl\Parameter('startPostDate', $dStartDate->format('Y-m-d')),
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
            new \Oara\Curl\Parameter('endPostDate', $dEndDate->format('Y-m-d')),
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
        );
        $url = new \Oara\Curl\Request("https://api.epn.ebay.com/rpt/events/v1/detail/tdr", $postParams );


        $urls[] = $url;
        $exportData = array();

        try {
            $exportReport = $this->_client->post($urls, 0);
            $exportData = \str_getcsv($exportReport[0], "\n");
        } catch (\Exception $e) {
            // ignore any error
        }

        // OLD Version - URL Doesn't work anymore - 2017-08-31 <PN>
        /*

        $urls = array();
        $urls[] = new \Oara\Curl\Request("https://publisher.ebaypartnernetwork.com/PublisherReportsTx?pt=2&start_date={$dStartDate->format("n/j/Y")}&end_date={$dEndDate->format("n/j/Y")}&user_name={$this->_credentials['user']}&user_password={$this->_credentials['password']}&advIdProgIdCombo=&tx_fmt=3&submit_tx=Download", array());
        $exportData = array();
        try {
            $exportReport = $this->_client->get($urls, 'content', 5);
            $exportData = \str_getcsv($exportReport[0], "\n");
        } catch (\Exception $e) {

        */
        $num = \count($exportData);
        for ($i = 1; $i < $num; $i++) {
            $transactionExportArray = \str_getcsv($exportData[$i], "\t");

            if ($transactionExportArray[2] == "Winning Bid (Revenue)" && (empty($this->_sitesAllowed) || \in_array($transactionExportArray[5], $this->_sitesAllowed))) {
                $transaction = Array();
                $transaction['merchantId'] = 0;
                $transaction['merchantName'] = '';
                $transaction['unique_id']  = $transactionExportArray[18];
                $transactionDate = \DateTime::createFromFormat("Y-m-d", $transactionExportArray[0]);
                $transaction['date'] = $transactionDate->format("Y-m-d") . ' 00:00:00';
                $postDate = \DateTime::createFromFormat("Y-m-d", $transactionExportArray[1]);
                $transaction['post_date'] = $postDate->format("Y-m-d") . ' 00:00:00';
                if ($transactionExportArray[10] != null) {
                    $transaction['custom_id'] = $transactionExportArray[10];
                }
                $transaction['click_date'] = $transactionExportArray[11];
                $transaction['amount'] = (float) $transactionExportArray[3];
                $transaction['commission'] = (float) $transactionExportArray[20];
                // Set status as Pending
                // ... real status (approved / denied) must be calculated by summing all negative/positive records
                // ... and checking final amount for a positive or zero value
                $transaction['status'] = \Oara\Utilities::STATUS_PENDING;
                $totalTransactions[] = $transaction;
            }
        }
        return $totalTransactions;
    }
}


1			<?php
2			/**
3			* Copyright (c) Padosoft.com 2017.
4			* Created by Paolo Nardini - 2017-08-31
5			*/
6
7
8			namespace Padosoft\AffiliateNetwork;
9			use Oara\Network\Publisher\Ebay as EbayOara;
10
11			class EbayEx extends EbayOara
12			{
13			protected $_serverNumber = 6;
14			protected $_merchantIdList = array(); // To avoid repeated calls to \Oara\Utilities::getMerchantIdMapFromMerchantList
15
16			/**
17			* @param $credentials
18			*/
19			public function login($credentials)
20			{
21			$this->_credentials = $credentials;
			0 ignored issues – show Bug introduced 2017-09-01 10:13 UTC by Report Bug Copy Issue Report The property `_credentials` 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...
22			$this->_client = new \Oara\Curl\Access($credentials);
23
24			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-01 10:13 UTC by Report Bug Copy Issue Report `61%` 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...
25			$valuesLogin = array(
26			new \Oara\Curl\Parameter('login_username', $this->_credentials['user']),
27			new \Oara\Curl\Parameter('login_password', $this->_credentials['password']),
28			new \Oara\Curl\Parameter('submit_btn', 'GO'),
29			new \Oara\Curl\Parameter('hubpage', 'y')
30			);
31			$loginUrl = 'https://ebaypartnernetwork.com/PublisherLogin?hubpage=y&lang=en-US?';
32
33			$urls = array();
34			$urls[] = new \Oara\Curl\Request($loginUrl, $valuesLogin);
35			$this->_client->post($urls);
36			*/
37			}
38
39			/**
40			* @return array
41			*/
42			public function getNeededCredentials()
43			{
44			$credentials = array();
45
46			$parameter = array();
47			$parameter["description"] = "User Log in";
48			$parameter["required"] = true;
49			$parameter["name"] = "User";
50			$credentials["user"] = $parameter;
51
52			$parameter = array();
53			$parameter["description"] = "Password to Log in";
54			$parameter["required"] = true;
55			$parameter["name"] = "Password";
56			$credentials["password"] = $parameter;
57
58			return $credentials;
59			}
60
61			/**
62			* @return bool
63			*/
64			public function checkConnection()
65			{
66			//If not login properly the construct launch an exception
67			$connection = true;
68			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-01 10:13 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...
69			$yesterday = new \DateTime();
70			$yesterday->sub(new \DateInterval('P2D'));
71
72			$urls = array();
73			$urls[] = new \Oara\Curl\Request("https://publisher.ebaypartnernetwork.com/PublisherReportsTx?pt=2&start_date={$yesterday->format("n/j/Y")}&end_date={$yesterday->format("n/j/Y")}&user_name={$this->_credentials['user']}&user_password={$this->_credentials['password']}&advIdProgIdCombo=&tx_fmt=2&submit_tx=Download", array());
74			$exportReport = $this->_client->get($urls);
75
76			if (\preg_match("/DOCTYPE html PUBLIC/", $exportReport[0])) {
77			$connection = false;
78			}
79			*/
80			return $connection;
81			}
82
83			/**
84			* @param string $idSite
85			*/
86			public function addAllowedSite(string $idSite){
87			$this->_sitesAllowed[]=$idSite;
88			}
89
90			/**
91			* @return array
92			*/
93			public function getMerchantList()
94			{
95			$merchants = array();
96
97			$obj = array();
98			$obj['cid'] = "1";
99			$obj['name'] = "Ebay";
100			$obj['url'] = "https://publisher.ebaypartnernetwork.com";
101			$merchants[] = $obj;
102
103			return $merchants;
104			}
105
106			/**
107			* @param null $merchantList
108			* @param \DateTime\|null $dStartDate
109			* @param \DateTime\|null $dEndDate
110			* @return array
111			*/
112			public function getTransactionList($merchantList = null, \DateTime $dStartDate = null, \DateTime $dEndDate = null)
113			{
114			$totalTransactions = array();
115
116			$urls = array();
117
118			$postParams = array(
119			new \Oara\Curl\Parameter('username', $this->_credentials['user']),
120			new \Oara\Curl\Parameter('password', $this->_credentials['password']),
121			new \Oara\Curl\Parameter('isEnc', 'false'),
122			new \Oara\Curl\Parameter('fileFormat', 'txt'),
123			new \Oara\Curl\Parameter('eventType', 'earnings'), // use 'all' to download all events
124			new \Oara\Curl\Parameter('startPostDate', $dStartDate->format('Y-m-d')),
			0 ignored issues – show Bug introduced 2017-09-01 10:13 UTC by Report Bug Copy Issue Report It seems like `$dStartDate` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
125			new \Oara\Curl\Parameter('endPostDate', $dEndDate->format('Y-m-d')),
			0 ignored issues – show Bug introduced 2017-09-01 10:13 UTC by Report Bug Copy Issue Report It seems like `$dEndDate` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
126			);
127			$url = new \Oara\Curl\Request("https://api.epn.ebay.com/rpt/events/v1/detail/tdr", $postParams );
128
129
130			$urls[] = $url;
131			$exportData = array();
132
133			try {
134			$exportReport = $this->_client->post($urls, 0);
135			$exportData = \str_getcsv($exportReport[0], "\n");
136			} catch (\Exception $e) {
137			// ignore any error
138			}
139
140			// OLD Version - URL Doesn't work anymore - 2017-08-31 <PN>
141			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-01 10:13 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...
142			$urls = array();
143			$urls[] = new \Oara\Curl\Request("https://publisher.ebaypartnernetwork.com/PublisherReportsTx?pt=2&start_date={$dStartDate->format("n/j/Y")}&end_date={$dEndDate->format("n/j/Y")}&user_name={$this->_credentials['user']}&user_password={$this->_credentials['password']}&advIdProgIdCombo=&tx_fmt=3&submit_tx=Download", array());
144			$exportData = array();
145			try {
146			$exportReport = $this->_client->get($urls, 'content', 5);
147			$exportData = \str_getcsv($exportReport[0], "\n");
148			} catch (\Exception $e) {
149
150			*/
151			$num = \count($exportData);
152			for ($i = 1; $i < $num; $i++) {
153			$transactionExportArray = \str_getcsv($exportData[$i], "\t");
154
155			if ($transactionExportArray[2] == "Winning Bid (Revenue)" && (empty($this->_sitesAllowed) \|\| \in_array($transactionExportArray[5], $this->_sitesAllowed))) {
156			$transaction = Array();
157			$transaction['merchantId'] = 0;
158			$transaction['merchantName'] = '';
159			$transaction['unique_id'] = $transactionExportArray[18];
160			$transactionDate = \DateTime::createFromFormat("Y-m-d", $transactionExportArray[0]);
161			$transaction['date'] = $transactionDate->format("Y-m-d") . ' 00:00:00';
162			$postDate = \DateTime::createFromFormat("Y-m-d", $transactionExportArray[1]);
163			$transaction['post_date'] = $postDate->format("Y-m-d") . ' 00:00:00';
164			if ($transactionExportArray[10] != null) {
165			$transaction['custom_id'] = $transactionExportArray[10];
166			}
167			$transaction['click_date'] = $transactionExportArray[11];
168			$transaction['amount'] = (float) $transactionExportArray[3];
169			$transaction['commission'] = (float) $transactionExportArray[20];
170			// Set status as Pending
171			// ... real status (approved / denied) must be calculated by summing all negative/positive records
172			// ... and checking final amount for a positive or zero value
173			$transaction['status'] = \Oara\Utilities::STATUS_PENDING;
174			$totalTransactions[] = $transaction;
175			}
176			}
177			return $totalTransactions;
178			}
179			}
180

padosoft / laravel-affiliate-network

Push — master ( d6ee27...51558c )

EbayEx::getTransactionList() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like