AppnexusFacade::getReport() - Code Metrics - Inspection of "Phpdoc fix" - Audiens/appnexus-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8c5cc3...01b1f4 )

by Francesco

created 2016-04-13 07:44 UTC

AppnexusFacade::getReport() A

↳ Parent: AppnexusFacade

Complexity

Conditions	3
Paths	2

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	15
rs	9.4285
cc	3
eloc	7
nc	2
nop	1

<?php

namespace Audiens\AppnexusClient\facade;

use Audiens\AppnexusClient\Auth;
use Audiens\AppnexusClient\authentication\AdnxStrategy;
use Audiens\AppnexusClient\CacheableInterface;
use Audiens\AppnexusClient\entity\Segment;
use Audiens\AppnexusClient\entity\UploadJobStatus;
use Audiens\AppnexusClient\entity\UploadTicket;
use Audiens\AppnexusClient\repository\RepositoryResponse;
use Audiens\AppnexusClient\repository\SegmentRepository;
use Audiens\AppnexusClient\service\Report;
use Audiens\AppnexusClient\service\UserUpload;
use Doctrine\Common\Cache\FilesystemCache;
use GuzzleHttp\Client;

/**
 * Class AppnexusFacade
 */
class AppnexusFacade implements CacheableInterface
{

    protected $username;
    protected $password;
    protected $memberId;

    /** @var  SegmentRepository */
    private $segmentRepository;

    /** @var UserUpload */
    private $userUpload;

    /** @var Report */
    private $report;

    /**
     * AppnexusFacade constructor.
     *
     * @param $username
     * @param $password
     * @param $memberId
     */
    public function __construct($username, $password, $memberId)
    {
        $this->username = $username;
        $this->password = $password;
        $this->memberId = $memberId;

        $client = new Client();
        $cache = new FilesystemCache('build');

        $authStrategy = new AdnxStrategy($client, $cache);

        $auth = new Auth($username, $password, $client, $authStrategy);

        $this->segmentRepository = new SegmentRepository($auth, $cache);
        $this->userUpload = new UserUpload($auth, $cache);
        $this->report = new Report($auth, $cache);

    }

    /**
     * @param Segment $segment
     *
     * @return RepositoryResponse
     * @throws \Exception
     */
    public function add(Segment $segment)
    {

        return $this->segmentRepository->add($segment);

    }

    /**
     * @param $id
     *
     * @return RepositoryResponse
     */
    public function remove($id)
    {

        return $this->segmentRepository->remove($this->memberId, $id);

    }

    /**
     * @param Segment $segment
     *
     * @return RepositoryResponse
     * @throws \Exception
     */
    public function update(Segment $segment)
    {
        return $this->segmentRepository->update($segment);
    }

    /**
     * @param $id
     *
     * @return Segment|null
     */
    public function findOneById($id)
    {
        return $this->segmentRepository->findOneById($this->memberId, $id);
    }

    /**
     * @param int $start
     * @param int $maxResults
     *
     * @return array|mixed|null
     * @throws \Exception
     */
    public function findAll($start = 0, $maxResults = 100)
    {

        return $this->segmentRepository->findAll($this->memberId, $start, $maxResults);
    }

    /**
     * @param $fileAsString
     *
     * @return \Audiens\AppnexusClient\entity\UploadJobStatus
     * @throws \Exception
     */
    public function upload($fileAsString)
    {
        return $this->userUpload->upload($this->memberId, $fileAsString);
    }

    /**
     * @param int $start
     * @param int $maxResults
     *
     * @return \Audiens\AppnexusClient\entity\UploadJobStatus[]
     * @throws \Audiens\AppnexusClient\exceptions\RepositoryException
     */
    public function getUploadHistory($start = 0, $maxResults = 100)
    {
        return $this->userUpload->getUploadHistory($this->memberId, $start, $maxResults);
    }

    /**
     * @return \Audiens\AppnexusClient\entity\UploadTicket
     * @throws \Exception
     */
    public function getUploadTicket()
    {
        return $this->userUpload->getUploadTicket($this->memberId);
    }

    /**
     * @param UploadTicket $uploadTicket
     *
     * @return UploadJobStatus $uploadJobStatus
     * @throws \Exception
     */
    public function getJobStatus(UploadTicket $uploadTicket)
    {
        return $this->userUpload->getJobStatus($uploadTicket);
    }

    /**
     * @param array $reportFormat
     *
     * @return array
     * @throws \Audiens\AppnexusClient\exceptions\RepositoryException
     */
    public function getReport($reportFormat = Report::REVENUE_REPORT)
    {

        $reportStatus = $this->report->getReportStatus($this->report->getReportTicket($reportFormat));

        $maxSteps = 0;

        while (!$reportStatus->isReady() && $maxSteps < 10) {
            $reportStatus = $this->report->getReportStatus($reportStatus);
            $maxSteps++;
        }

        return $this->report->getReport($reportStatus);

    }

    /**
     * @return bool
     */
    public function isCacheEnabled()
    {
        return $this->segmentRepository->isCacheEnabled() || $this->userUpload->isCacheEnabled();
    }

    public function disableCache()
    {
        $this->segmentRepository->disableCache();
        $this->userUpload->disableCache();
    }

    public function enableCache()
    {
        $this->segmentRepository->enableCache();
        $this->userUpload->enableCache();
    }
}


1			<?php
2
3			namespace Audiens\AppnexusClient\facade;
4
5			use Audiens\AppnexusClient\Auth;
6			use Audiens\AppnexusClient\authentication\AdnxStrategy;
7			use Audiens\AppnexusClient\CacheableInterface;
8			use Audiens\AppnexusClient\entity\Segment;
9			use Audiens\AppnexusClient\entity\UploadJobStatus;
10			use Audiens\AppnexusClient\entity\UploadTicket;
11			use Audiens\AppnexusClient\repository\RepositoryResponse;
12			use Audiens\AppnexusClient\repository\SegmentRepository;
13			use Audiens\AppnexusClient\service\Report;
14			use Audiens\AppnexusClient\service\UserUpload;
15			use Doctrine\Common\Cache\FilesystemCache;
16			use GuzzleHttp\Client;
17
18			/**
19			* Class AppnexusFacade
20			*/
21			class AppnexusFacade implements CacheableInterface
22			{
23
24			protected $username;
25			protected $password;
26			protected $memberId;
27
28			/** @var SegmentRepository */
29			private $segmentRepository;
30
31			/** @var UserUpload */
32			private $userUpload;
33
34			/** @var Report */
35			private $report;
36
37			/**
38			* AppnexusFacade constructor.
39			*
40			* @param $username
41			* @param $password
42			* @param $memberId
43			*/
44			public function __construct($username, $password, $memberId)
45			{
46			$this->username = $username;
47			$this->password = $password;
48			$this->memberId = $memberId;
49
50			$client = new Client();
51			$cache = new FilesystemCache('build');
52
53			$authStrategy = new AdnxStrategy($client, $cache);
54
55			$auth = new Auth($username, $password, $client, $authStrategy);
56
57			$this->segmentRepository = new SegmentRepository($auth, $cache);
58			$this->userUpload = new UserUpload($auth, $cache);
59			$this->report = new Report($auth, $cache);
60
61			}
62
63			/**
64			* @param Segment $segment
65			*
66			* @return RepositoryResponse
67			* @throws \Exception
68			*/
69			public function add(Segment $segment)
70			{
71
72			return $this->segmentRepository->add($segment);
73
74			}
75
76			/**
77			* @param $id
78			*
79			* @return RepositoryResponse
80			*/
81			public function remove($id)
82			{
83
84			return $this->segmentRepository->remove($this->memberId, $id);
85
86			}
87
88			/**
89			* @param Segment $segment
90			*
91			* @return RepositoryResponse
92			* @throws \Exception
93			*/
94			public function update(Segment $segment)
95			{
96			return $this->segmentRepository->update($segment);
97			}
98
99			/**
100			* @param $id
101			*
102			* @return Segment\|null
103			*/
104			public function findOneById($id)
105			{
106			return $this->segmentRepository->findOneById($this->memberId, $id);
107			}
108
109			/**
110			* @param int $start
111			* @param int $maxResults
112			*
113			* @return array\|mixed\|null
114			* @throws \Exception
115			*/
116			public function findAll($start = 0, $maxResults = 100)
117			{
118
119			return $this->segmentRepository->findAll($this->memberId, $start, $maxResults);
120			}
121
122			/**
123			* @param $fileAsString
124			*
125			* @return \Audiens\AppnexusClient\entity\UploadJobStatus
126			* @throws \Exception
127			*/
128			public function upload($fileAsString)
129			{
130			return $this->userUpload->upload($this->memberId, $fileAsString);
131			}
132
133			/**
134			* @param int $start
135			* @param int $maxResults
136			*
137			* @return \Audiens\AppnexusClient\entity\UploadJobStatus[]
138			* @throws \Audiens\AppnexusClient\exceptions\RepositoryException
139			*/
140			public function getUploadHistory($start = 0, $maxResults = 100)
141			{
142			return $this->userUpload->getUploadHistory($this->memberId, $start, $maxResults);
143			}
144
145			/**
146			* @return \Audiens\AppnexusClient\entity\UploadTicket
147			* @throws \Exception
148			*/
149			public function getUploadTicket()
150			{
151			return $this->userUpload->getUploadTicket($this->memberId);
152			}
153
154			/**
155			* @param UploadTicket $uploadTicket
156			*
157			* @return UploadJobStatus $uploadJobStatus
158			* @throws \Exception
159			*/
160			public function getJobStatus(UploadTicket $uploadTicket)
161			{
162			return $this->userUpload->getJobStatus($uploadTicket);
163			}
164
165			/**
166			* @param array $reportFormat
167			*
168			* @return array
169			* @throws \Audiens\AppnexusClient\exceptions\RepositoryException
170			*/
171			public function getReport($reportFormat = Report::REVENUE_REPORT)
172			{
173
174			$reportStatus = $this->report->getReportStatus($this->report->getReportTicket($reportFormat));
175
176			$maxSteps = 0;
177
178			while (!$reportStatus->isReady() && $maxSteps < 10) {
179			$reportStatus = $this->report->getReportStatus($reportStatus);
180			$maxSteps++;
181			}
182
183			return $this->report->getReport($reportStatus);
184
185			}
186
187			/**
188			* @return bool
189			*/
190			public function isCacheEnabled()
191			{
192			return $this->segmentRepository->isCacheEnabled() \|\| $this->userUpload->isCacheEnabled();
193			}
194
195			public function disableCache()
196			{
197			$this->segmentRepository->disableCache();
198			$this->userUpload->disableCache();
199			}
200
201			public function enableCache()
202			{
203			$this->segmentRepository->enableCache();
204			$this->userUpload->enableCache();
205			}
206			}
207

Audiens / appnexus-client

Push — master ( 8c5cc3...01b1f4 )

AppnexusFacade::getReport() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like