Client - Code Metrics - Inspection of "Tests" - Werkspot/BingAdsApiBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4)

by Laurens

created 2016-03-04 15:56 UTC

Client C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	402
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	20

Importance

Changes	24
Bugs	2	Features	6

Metric	Value
wmc	43
c	24
b	2
f	6
lcom	1
cbo	20
dl	0
loc	402
rs	5.2826

16 Methods

Rating	Name	Size	Complexity
A	__construct()	18	1
A	setApiDetails()	4	1
A	setConfig()	6	1
A	getRefreshToken()	4	1
B	get()	25	2
A	setProxy()	4	1
A	getCacheDir()	9	2
A	getFilesFromReportRequest()	11	1
A	submitGenerateReport()	11	2
A	getReportRequest()	6	1
D	waitForStatus()	35	9
A	pollGenerateReport()	10	2
A	fixFile()	15	3
A	moveFirstFile()	7	1
A	clearCache()	17	3
C	parseSoapFault()	30	12

How to fix Complexity

<?php
namespace Werkspot\BingAdsApiBundle\Api;

use BingAds\Proxy\ClientProxy;
use BingAds\Reporting\PollGenerateReportRequest;
use BingAds\Reporting\ReportRequest;
use BingAds\Reporting\ReportTimePeriod;
use BingAds\Reporting\SubmitGenerateReportRequest;
use Exception;
use SoapFault;
use SoapVar;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Finder;
use Werkspot\BingAdsApiBundle\Api\Helper\Csv;
use Werkspot\BingAdsApiBundle\Api\Helper\File;
use Werkspot\BingAdsApiBundle\Api\Helper\Time;
use Werkspot\BingAdsApiBundle\Api\Report\ReportInterface;
use Werkspot\BingAdsApiBundle\Guzzle\OauthTokenService;
use Werkspot\BingAdsApiBundle\Model\AccessToken;
use Werkspot\BingAdsApiBundle\Model\ApiDetails;

class Client
{
    /**
     * @var array
     */
    private $config = [];

    /**
     * @var string
     */
    private $fileName;

    /**
     * @var ClientProxy
     */
    private $proxy;

    /**
     * @var array
     */
    public $report;

    /**
     * @var string
     */
    private $files;

    /**
     * @var OauthTokenService
     */
    private $oauthTokenService;

    /**
     * @var ApiDetails
     */
    private $apiDetails;

    /**
     * @var ClientProxy
     */
    private $clientProxy;

    /**
     * @var File
     */
    private $fileHelper;

    /**
     * @var Csv
     */
    private $csvHelper;

    /**
     * @var Time
     */
    private $timeHelper;

    /**
     * Client constructor.
     *
     * @param OauthTokenService $oauthTokenService
     * @param ApiDetails $apiDetails
     * @param ClientProxy $clientProxy
     * @param File $file
     * @param Csv $csv
     * @param Time $timeHelper
     */
    public function __construct(OauthTokenService $oauthTokenService, ApiDetails $apiDetails, ClientProxy $clientProxy, File $file, Csv $csv, Time $timeHelper)
    {
        $this->oauthTokenService = $oauthTokenService;
        $this->apiDetails = $apiDetails;
        $this->clientProxy = $clientProxy;
        $this->fileHelper = $file;
        $this->csvHelper = $csv;
        $this->timeHelper = $timeHelper;

        ini_set('soap.wsdl_cache_enabled', '0');
        ini_set('soap.wsdl_cache_ttl', '0');

        $this->fileName = 'report.zip';

        $this->report = [
            'GeoLocationPerformanceReport' => new Report\GeoLocationPerformanceReport(),
        ];
    }

    public function setApiDetails(ApiDetails $apiDetails)
    {
        $this->apiDetails = $apiDetails;
    }

    /**
     * Sets the configuration
     *
     * @param $config
     */
    public function setConfig($config)
    {
        $this->config = $config;
        $this->config['cache_dir'] = $this->config['cache_dir'] . '/' . 'BingAdsApiBundle'; //<-- important for the cache clear function
        $this->config['csv']['fixHeader']['removeColumnHeader'] = true; //-- fix till i know how to do this
    }

    public function getRefreshToken()
    {
        return $this->apiDetails->getRefreshToken();
    }

    /**
     * @param array $columns
     * @param string $name
     * @param $timePeriod
     * @param null|string $fileLocation
     *
     * @return array|string
     */
    public function get(array $columns, $name = 'GeoLocationPerformanceReport', $timePeriod = ReportTimePeriod::LastWeek, $fileLocation = null)
    {
        $tokens = $this->oauthTokenService->refreshToken(
            $this->apiDetails->getClientId(),
            $this->apiDetails->getSecret(),
            $this->apiDetails->getRedirectUri(),
            new AccessToken(null, $this->apiDetails->getRefreshToken())
        );

        $accessToken = $tokens->getAccessToken();
        $this->apiDetails->setRefreshToken($tokens->getRefreshToken());

        $report = $this->report[$name];
        $reportRequest = $report->getRequest($columns, $timePeriod);
        $this->setProxy($report::WSDL, $accessToken);
        $files = $this->getFilesFromReportRequest($reportRequest, $name, "{$this->getCacheDir()}/{$this->fileName}", $report);

        if ($fileLocation) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->moveFirstFile($fileLocation);

            return $fileLocation;
        } else {
            return $files;
        }
    }

    /**
     * @param string $wsdl
     * @param string $accessToken
     */
    private function setProxy($wsdl, $accessToken)
    {
        $this->proxy = $this->clientProxy->ConstructWithCredentials($wsdl, null, null, $this->apiDetails->getDevToken(), $accessToken);
    }

    /**
     * @return string
     */
    private function getCacheDir()
    {
        $fs = new Filesystem();
        if (!$fs->exists($this->config['cache_dir'])) {
            $fs->mkdir($this->config['cache_dir'], 0700);
        }

        return $this->config['cache_dir'];
    }

    /**
     * @param ReportRequest $reportRequest
     * @param string $name
     * @param string $downloadFile
     * @param ReportInterface $report
     *
     * @throws Exception
     *
     * @return array
     */
    private function getFilesFromReportRequest(ReportRequest $reportRequest, $name, $downloadFile, ReportInterface $report)
    {
        $reportRequestId = $this->submitGenerateReport($reportRequest, $name);
        $reportRequestStatus = $this->waitForStatus($reportRequestId);
        $reportDownloadUrl = $reportRequestStatus->ReportDownloadUrl;
        $zipFile = $this->fileHelper->getFile($reportDownloadUrl, $downloadFile);
        $this->files = $this->fileHelper->unZip($zipFile);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $this->fixFile($report);

        return $this->files;
    }

    /**
     * SubmitGenerateReport helper method calls the corresponding Bing Ads service operation
     * to request the report identifier. The identifier is used to check report generation status
     * before downloading the report.
     *
     * @param mixed  $report
     * @param string $name
     *
     * @return string ReportRequestId
     */
    private function submitGenerateReport($report, $name)
    {
        $request = new SubmitGenerateReportRequest();
        try {
            $request->ReportRequest = $this->getReportRequest($report, $name);

            return $this->proxy->GetService()->SubmitGenerateReport($request)->ReportRequestId;
        } catch (SoapFault $e) {
            $this->parseSoapFault($e);
        }
    }

    /**
     * @param mixed  $report
     * @param string $name
     *
     * @return SoapVar
     */
    private function getReportRequest($report, $name)
    {
        $name = "{$name}Request";

        return new SoapVar($report, SOAP_ENC_OBJECT, $name, $this->proxy->GetNamespace());
    }

    /**
     * Check if the report is ready for download
     * if not wait 10 sec and retry. (up to 6,5 hour)
     * After 30 tries check every 1 minute
     * After 34 tries check every 5 minutes
     * After 39 tries check every 15 minutes
     * After 43 tries check every 30 minutes
     *
     * @param string  $reportRequestId
     * @param int     $count
     * @param int     $maxCount
     * @param int     $sleep
     * @param bool $incrementTime
     *
     * @throws Exceptions\ReportRequestErrorException
     * @throws Exceptions\RequestTimeoutException
     *
     * @return string
     */
    private function waitForStatus($reportRequestId, $count = 1, $maxCount = 48, $sleep = 10, $incrementTime = true)
    {
        if ($count > $maxCount) {
            throw new Exceptions\RequestTimeoutException("The request is taking longer than expected.\nSave the report ID ({$reportRequestId}) and try again later.");
        }

        $reportRequestStatus = $this->pollGenerateReport($reportRequestId);
        if ($reportRequestStatus->Status == 'Pending') {
            ++$count;
            $this->timeHelper->sleep($sleep);
            if ($incrementTime) {
                switch ($count) {
                    case 31: // after 5 minutes
                        $sleep = (1 * 60);
                        break;
                    case 35: // after 10 minutes
                        $sleep = (5 * 60);
                        break;
                    case 40: // after 30 minutes
                        $sleep = (15 * 60);
                        break;
                    case 44: // after 1,5 hours

                        $sleep = (30 * 60);
                        break;
                }
            }
            $reportRequestStatus = $this->waitForStatus($reportRequestId, $count, $maxCount, $sleep, $incrementTime);
        }

        if ($reportRequestStatus->Status == 'Error') {
            throw new Exceptions\ReportRequestErrorException("The request failed. Try requesting the report later.\nIf the request continues to fail, contact support.", $reportRequestStatus->Status, $reportRequestId);
        }

        return $reportRequestStatus;
    }

    /**
     * Check the status of the report request. The guidance of how often to poll
     * for status is from every five to 15 minutes depending on the amount
     * of data being requested. For smaller reports, you can poll every couple
     * of minutes. You should stop polling and try again later if the request
     * is taking longer than an hour.
     *
     * @param string $reportRequestId
     *
     * @return string ReportRequestStatus
     */
    private function pollGenerateReport($reportRequestId)
    {
        $request = new PollGenerateReportRequest();
        $request->ReportRequestId = $reportRequestId;
        try {
            return $this->proxy->GetService()->PollGenerateReport($request)->ReportRequestStatus;
        } catch (SoapFault $e) {
            $this->parseSoapFault($e);
        }
    }

    /**
     * @param array|null $files
     *
     * @return self
     */
    private function fixFile(ReportInterface $report, array $files = null)
    {
        $files = (!$files) ? $this->files : $files;
        foreach ($files as $file) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $lines = file($file);
            $lines = $this->csvHelper->removeHeaders($lines, $this->config['csv']['fixHeader']['removeColumnHeader'], $report::FILE_HEADERS, $report::COLUMN_HEADERS);
            $lines = $this->csvHelper->removeLastLines($lines);
            $lines = $this->csvHelper->convertDateMDYtoYMD($lines);
            $fp = fopen($file, 'w');
            fwrite($fp, implode('', $lines));
            fclose($fp);
        }

        return $this;
    }

    /**
     * Move first file form array $this->files to the target location
     *
     * @param string $target
     *
     * @return self
     */
    private function moveFirstFile($target)
    {
        $fs = new Filesystem();
        $fs->rename($this->files[0], $target);

        return $this;
    }

    /**
     * Clear Bundle Cache directory
     *
     * @param bool $allFiles delete all files in bundles cache, if false deletes only extracted files ($this->files)
     *
     * @return self
     *
     * @codeCoverageIgnore
     */
    public function clearCache($allFiles = false)
    {
        $fileSystem = new Filesystem();

        if ($allFiles) {
            $finder = new Finder();
            $files = $finder->files()->in($this->config['cache_dir']);
        } else {
            $files = $this->files;
        }

        foreach ($files as $file) {
            $fileSystem->remove($file);
        }

        return $this;
    }

    /**
     * @param SoapFault $e
     *
     * @throws Exceptions\SoapInternalErrorException
     * @throws Exceptions\SoapInvalidCredentialsException
     * @throws Exceptions\SoapNoCompleteDataAvailableException
     * @throws Exceptions\SoapReportingServiceInvalidReportIdException
     * @throws Exceptions\SoapUnknownErrorException
     * @throws Exceptions\SoapUserIsNotAuthorizedException
     */
    private function parseSoapFault(SoapFault $e)
    {
        if (isset($e->detail->AdApiFaultDetail)) {
            $error = $e->detail->AdApiFaultDetail->Errors->AdApiError;

        } elseif (isset($e->detail->ApiFaultDetail)) {
            if (!empty($e->detail->ApiFaultDetail->BatchErrors)) {
                $error = $error = $e->detail->ApiFaultDetail->Errors->AdApiError;
            } elseif (!empty($e->detail->ApiFaultDetail->OperationErrors)) {
                $error = $e->detail->ApiFaultDetail->OperationErrors->OperationError;
            }
        }
        $errors = is_array($error) ? $error : ['error' => $error];
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        foreach ($errors as $error) {
            switch ($error->Code) {
                case 0:
                    throw new Exceptions\SoapInternalErrorException($error->Message, $error->Code);
                case 105:
                    throw new Exceptions\SoapInvalidCredentialsException($error->Message, $error->Code);
                case 106:
                    throw new Exceptions\SoapUserIsNotAuthorizedException($error->Message, $error->Code);
                case 2004:
                    throw new Exceptions\SoapNoCompleteDataAvailableException($error->Message, $error->Code);
                case 2100:
                    throw new Exceptions\SoapReportingServiceInvalidReportIdException($error->Message, $error->Code);
                default:
                    $errorMessage = "[{$error->Code}]\n{$error->Message}";
                    throw new Exceptions\SoapUnknownErrorException($errorMessage, $error->Code);
            }
        }
    }
}


Pull Request — master (#4)

Client C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

How to fix Complexity

Complex Class

Available Fixes

1			<?php
2			namespace Werkspot\BingAdsApiBundle\Api;
3
4			use BingAds\Proxy\ClientProxy;
5			use BingAds\Reporting\PollGenerateReportRequest;
6			use BingAds\Reporting\ReportRequest;
7			use BingAds\Reporting\ReportTimePeriod;
8			use BingAds\Reporting\SubmitGenerateReportRequest;
9			use Exception;
10			use SoapFault;
11			use SoapVar;
12			use Symfony\Component\Filesystem\Filesystem;
13			use Symfony\Component\Finder\Finder;
14			use Werkspot\BingAdsApiBundle\Api\Helper\Csv;
15			use Werkspot\BingAdsApiBundle\Api\Helper\File;
16			use Werkspot\BingAdsApiBundle\Api\Helper\Time;
17			use Werkspot\BingAdsApiBundle\Api\Report\ReportInterface;
18			use Werkspot\BingAdsApiBundle\Guzzle\OauthTokenService;
19			use Werkspot\BingAdsApiBundle\Model\AccessToken;
20			use Werkspot\BingAdsApiBundle\Model\ApiDetails;
21
22			class Client
23			{
24			/**
25			* @var array
26			*/
27			private $config = [];
28
29			/**
30			* @var string
31			*/
32			private $fileName;
33
34			/**
35			* @var ClientProxy
36			*/
37			private $proxy;
38
39			/**
40			* @var array
41			*/
42			public $report;
43
44			/**
45			* @var string
46			*/
47			private $files;
48
49			/**
50			* @var OauthTokenService
51			*/
52			private $oauthTokenService;
53
54			/**
55			* @var ApiDetails
56			*/
57			private $apiDetails;
58
59			/**
60			* @var ClientProxy
61			*/
62			private $clientProxy;
63
64			/**
65			* @var File
66			*/
67			private $fileHelper;
68
69			/**
70			* @var Csv
71			*/
72			private $csvHelper;
73
74			/**
75			* @var Time
76			*/
77			private $timeHelper;
78
79			/**
80			* Client constructor.
81			*
82			* @param OauthTokenService $oauthTokenService
83			* @param ApiDetails $apiDetails
84			* @param ClientProxy $clientProxy
85			* @param File $file
86			* @param Csv $csv
87			* @param Time $timeHelper
88			*/
89			public function __construct(OauthTokenService $oauthTokenService, ApiDetails $apiDetails, ClientProxy $clientProxy, File $file, Csv $csv, Time $timeHelper)
90			{
91			$this->oauthTokenService = $oauthTokenService;
92			$this->apiDetails = $apiDetails;
93			$this->clientProxy = $clientProxy;
94			$this->fileHelper = $file;
95			$this->csvHelper = $csv;
96			$this->timeHelper = $timeHelper;
97
98			ini_set('soap.wsdl_cache_enabled', '0');
99			ini_set('soap.wsdl_cache_ttl', '0');
100
101			$this->fileName = 'report.zip';
102
103			$this->report = [
104			'GeoLocationPerformanceReport' => new Report\GeoLocationPerformanceReport(),
105			];
106			}
107
108			public function setApiDetails(ApiDetails $apiDetails)
109			{
110			$this->apiDetails = $apiDetails;
111			}
112
113			/**
114			* Sets the configuration
115			*
116			* @param $config
117			*/
118			public function setConfig($config)
119			{
120			$this->config = $config;
121			$this->config['cache_dir'] = $this->config['cache_dir'] . '/' . 'BingAdsApiBundle'; //<-- important for the cache clear function
122			$this->config['csv']['fixHeader']['removeColumnHeader'] = true; //-- fix till i know how to do this
123			}
124
125			public function getRefreshToken()
126			{
127			return $this->apiDetails->getRefreshToken();
128			}
129
130			/**
131			* @param array $columns
132			* @param string $name
133			* @param $timePeriod
134			* @param null\|string $fileLocation
135			*
136			* @return array\|string
137			*/
138			public function get(array $columns, $name = 'GeoLocationPerformanceReport', $timePeriod = ReportTimePeriod::LastWeek, $fileLocation = null)
139			{
140			$tokens = $this->oauthTokenService->refreshToken(
141			$this->apiDetails->getClientId(),
142			$this->apiDetails->getSecret(),
143			$this->apiDetails->getRedirectUri(),
144			new AccessToken(null, $this->apiDetails->getRefreshToken())
145			);
146
147			$accessToken = $tokens->getAccessToken();
148			$this->apiDetails->setRefreshToken($tokens->getRefreshToken());
149
150			$report = $this->report[$name];
151			$reportRequest = $report->getRequest($columns, $timePeriod);
152			$this->setProxy($report::WSDL, $accessToken);
153			$files = $this->getFilesFromReportRequest($reportRequest, $name, "{$this->getCacheDir()}/{$this->fileName}", $report);
154
155			if ($fileLocation) {
			0 ignored issues – show Bug Best Practice introduced 2016-03-04 15:37 UTC by Report Bug Copy Issue Report The expression `$fileLocation` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
156			$this->moveFirstFile($fileLocation);
157
158			return $fileLocation;
159			} else {
160			return $files;
161			}
162			}
163
164			/**
165			* @param string $wsdl
166			* @param string $accessToken
167			*/
168			private function setProxy($wsdl, $accessToken)
169			{
170			$this->proxy = $this->clientProxy->ConstructWithCredentials($wsdl, null, null, $this->apiDetails->getDevToken(), $accessToken);
171			}
172
173			/**
174			* @return string
175			*/
176			private function getCacheDir()
177			{
178			$fs = new Filesystem();
179			if (!$fs->exists($this->config['cache_dir'])) {
180			$fs->mkdir($this->config['cache_dir'], 0700);
181			}
182
183			return $this->config['cache_dir'];
184			}
185
186			/**
187			* @param ReportRequest $reportRequest
188			* @param string $name
189			* @param string $downloadFile
190			* @param ReportInterface $report
191			*
192			* @throws Exception
193			*
194			* @return array
195			*/
196			private function getFilesFromReportRequest(ReportRequest $reportRequest, $name, $downloadFile, ReportInterface $report)
197			{
198			$reportRequestId = $this->submitGenerateReport($reportRequest, $name);
199			$reportRequestStatus = $this->waitForStatus($reportRequestId);
200			$reportDownloadUrl = $reportRequestStatus->ReportDownloadUrl;
201			$zipFile = $this->fileHelper->getFile($reportDownloadUrl, $downloadFile);
202			$this->files = $this->fileHelper->unZip($zipFile);
			1 ignored issue – show Bug introduced 2016-03-04 15:16 UTC by Report Bug Copy Issue Report It seems like `$zipFile` defined by `$this->fileHelper->getFi...loadUrl, $downloadFile)` on line `201` can also be of type `boolean`; however, `Werkspot\BingAdsApiBundle\Api\Helper\File::unZip()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
203			$this->fixFile($report);
204
205			return $this->files;
206			}
207
208			/**
209			* SubmitGenerateReport helper method calls the corresponding Bing Ads service operation
210			* to request the report identifier. The identifier is used to check report generation status
211			* before downloading the report.
212			*
213			* @param mixed $report
214			* @param string $name
215			*
216			* @return string ReportRequestId
217			*/
218			private function submitGenerateReport($report, $name)
219			{
220			$request = new SubmitGenerateReportRequest();
221			try {
222			$request->ReportRequest = $this->getReportRequest($report, $name);
223
224			return $this->proxy->GetService()->SubmitGenerateReport($request)->ReportRequestId;
225			} catch (SoapFault $e) {
226			$this->parseSoapFault($e);
227			}
228			}
229
230			/**
231			* @param mixed $report
232			* @param string $name
233			*
234			* @return SoapVar
235			*/
236			private function getReportRequest($report, $name)
237			{
238			$name = "{$name}Request";
239
240			return new SoapVar($report, SOAP_ENC_OBJECT, $name, $this->proxy->GetNamespace());
241			}
242
243			/**
244			* Check if the report is ready for download
245			* if not wait 10 sec and retry. (up to 6,5 hour)
246			* After 30 tries check every 1 minute
247			* After 34 tries check every 5 minutes
248			* After 39 tries check every 15 minutes
249			* After 43 tries check every 30 minutes
250			*
251			* @param string $reportRequestId
252			* @param int $count
253			* @param int $maxCount
254			* @param int $sleep
255			* @param bool $incrementTime
256			*
257			* @throws Exceptions\ReportRequestErrorException
258			* @throws Exceptions\RequestTimeoutException
259			*
260			* @return string
261			*/
262			private function waitForStatus($reportRequestId, $count = 1, $maxCount = 48, $sleep = 10, $incrementTime = true)
263			{
264			if ($count > $maxCount) {
265			throw new Exceptions\RequestTimeoutException("The request is taking longer than expected.\nSave the report ID ({$reportRequestId}) and try again later.");
266			}
267
268			$reportRequestStatus = $this->pollGenerateReport($reportRequestId);
269			if ($reportRequestStatus->Status == 'Pending') {
270			++$count;
271			$this->timeHelper->sleep($sleep);
272			if ($incrementTime) {
273			switch ($count) {
274			case 31: // after 5 minutes
275			$sleep = (1 * 60);
276			break;
277			case 35: // after 10 minutes
278			$sleep = (5 * 60);
279			break;
280			case 40: // after 30 minutes
281			$sleep = (15 * 60);
282			break;
283			case 44: // after 1,5 hours
			1 ignored issue – show Unused Code Comprehensibility introduced 2016-03-04 14:47 UTC by Report Bug Copy Issue Report `38%` 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...
284			$sleep = (30 * 60);
285			break;
286			}
287			}
288			$reportRequestStatus = $this->waitForStatus($reportRequestId, $count, $maxCount, $sleep, $incrementTime);
289			}
290
291			if ($reportRequestStatus->Status == 'Error') {
292			throw new Exceptions\ReportRequestErrorException("The request failed. Try requesting the report later.\nIf the request continues to fail, contact support.", $reportRequestStatus->Status, $reportRequestId);
293			}
294
295			return $reportRequestStatus;
296			}
297
298			/**
299			* Check the status of the report request. The guidance of how often to poll
300			* for status is from every five to 15 minutes depending on the amount
301			* of data being requested. For smaller reports, you can poll every couple
302			* of minutes. You should stop polling and try again later if the request
303			* is taking longer than an hour.
304			*
305			* @param string $reportRequestId
306			*
307			* @return string ReportRequestStatus
308			*/
309			private function pollGenerateReport($reportRequestId)
310			{
311			$request = new PollGenerateReportRequest();
312			$request->ReportRequestId = $reportRequestId;
313			try {
314			return $this->proxy->GetService()->PollGenerateReport($request)->ReportRequestStatus;
315			} catch (SoapFault $e) {
316			$this->parseSoapFault($e);
317			}
318			}
319
320			/**
321			* @param array\|null $files
322			*
323			* @return self
324			*/
325			private function fixFile(ReportInterface $report, array $files = null)
326			{
327			$files = (!$files) ? $this->files : $files;
328			foreach ($files as $file) {
			0 ignored issues – show Bug introduced 2016-03-04 14:47 UTC by Report Bug Copy Issue Report The expression `$files` of type `string\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
329			$lines = file($file);
330			$lines = $this->csvHelper->removeHeaders($lines, $this->config['csv']['fixHeader']['removeColumnHeader'], $report::FILE_HEADERS, $report::COLUMN_HEADERS);
331			$lines = $this->csvHelper->removeLastLines($lines);
332			$lines = $this->csvHelper->convertDateMDYtoYMD($lines);
333			$fp = fopen($file, 'w');
334			fwrite($fp, implode('', $lines));
335			fclose($fp);
336			}
337
338			return $this;
339			}
340
341			/**
342			* Move first file form array $this->files to the target location
343			*
344			* @param string $target
345			*
346			* @return self
347			*/
348			private function moveFirstFile($target)
349			{
350			$fs = new Filesystem();
351			$fs->rename($this->files[0], $target);
352
353			return $this;
354			}
355
356			/**
357			* Clear Bundle Cache directory
358			*
359			* @param bool $allFiles delete all files in bundles cache, if false deletes only extracted files ($this->files)
360			*
361			* @return self
362			*
363			* @codeCoverageIgnore
364			*/
365			public function clearCache($allFiles = false)
366			{
367			$fileSystem = new Filesystem();
368
369			if ($allFiles) {
370			$finder = new Finder();
371			$files = $finder->files()->in($this->config['cache_dir']);
372			} else {
373			$files = $this->files;
374			}
375
376			foreach ($files as $file) {
377			$fileSystem->remove($file);
378			}
379
380			return $this;
381			}
382
383			/**
384			* @param SoapFault $e
385			*
386			* @throws Exceptions\SoapInternalErrorException
387			* @throws Exceptions\SoapInvalidCredentialsException
388			* @throws Exceptions\SoapNoCompleteDataAvailableException
389			* @throws Exceptions\SoapReportingServiceInvalidReportIdException
390			* @throws Exceptions\SoapUnknownErrorException
391			* @throws Exceptions\SoapUserIsNotAuthorizedException
392			*/
393			private function parseSoapFault(SoapFault $e)
394			{
395			if (isset($e->detail->AdApiFaultDetail)) {
396			$error = $e->detail->AdApiFaultDetail->Errors->AdApiError;
			1 ignored issue – show Bug introduced 2016-03-04 15:16 UTC by Report Bug Copy Issue Report The property `detail` does not seem to exist in `SoapFault`. 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...
397			} elseif (isset($e->detail->ApiFaultDetail)) {
398			if (!empty($e->detail->ApiFaultDetail->BatchErrors)) {
399			$error = $error = $e->detail->ApiFaultDetail->Errors->AdApiError;
400			} elseif (!empty($e->detail->ApiFaultDetail->OperationErrors)) {
401			$error = $e->detail->ApiFaultDetail->OperationErrors->OperationError;
402			}
403			}
404			$errors = is_array($error) ? $error : ['error' => $error];
			0 ignored issues – show Bug introduced 2016-03-04 14:47 UTC by Report Bug Copy Issue Report The variable `$error` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
405			foreach ($errors as $error) {
406			switch ($error->Code) {
407			case 0:
408			throw new Exceptions\SoapInternalErrorException($error->Message, $error->Code);
409			case 105:
410			throw new Exceptions\SoapInvalidCredentialsException($error->Message, $error->Code);
411			case 106:
412			throw new Exceptions\SoapUserIsNotAuthorizedException($error->Message, $error->Code);
413			case 2004:
414			throw new Exceptions\SoapNoCompleteDataAvailableException($error->Message, $error->Code);
415			case 2100:
416			throw new Exceptions\SoapReportingServiceInvalidReportIdException($error->Message, $error->Code);
417			default:
418			$errorMessage = "[{$error->Code}]\n{$error->Message}";
419			throw new Exceptions\SoapUnknownErrorException($errorMessage, $error->Code);
420			}
421			}
422			}
423			}
424

Werkspot / BingAdsApiBundle

Pull Request — master (#4)

Client C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

How to fix Complexity

Complex Class

Available Fixes

Duplication Side-by-Side

Filter issues like