Client::getAttachments() - Code Metrics - Inspection of "valid id split and tests" - inshore/bookwhen - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — scrutinizer ( f8c545...f052ee )

unknown

created 2020-08-31 09:26 UTC

Client::getAttachments() B

↳ Parent: Client

Complexity

Conditions	9
Paths	9

Size

Total Lines	29
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	11.0604

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	9
eloc	17
c	1
b	0
f	0
nc	9
nop	3
dl	0
loc	29
ccs	12
cts	17
cp	0.7059
crap	11.0604
rs	8.0555

<?php

declare(strict_types=1);

namespace InShore\Bookwhen;

use GuzzleHttp;
use GuzzleHttp\Client as GuzzleClient;
use GuzzleHttp\Psr7\Request;
use InShore\Bookwhen\Exceptions\ConfigurationException;
use InShore\Bookwhen\Exceptions\RestException;
use InShore\Bookwhen\Exceptions\ValidationException;
use InShore\Bookwhen\Interfaces\ClientInterface;
use InShore\Bookwhen\Validator;
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use Psr\Http\Message\ResponseInterface;

/**
 * Class Client
 *
 * The main class for API consumption
 *
 * @package inshore\bookwhen
 * @todo comments
 * @todo externalise config
 * @todo fix token
 */
class Client implements ClientInterface
{
    
    /** @var string The API access token */
    private static $token = null;
    
    /** @var string The instance token, settable once per new instance */
    private $instanceToken;
    
    private $apiBaseUri;
    
    private $apiQuery;
   
    private $apiResource;
    
    private $apiVersion;

    private $include;
    
    /** @var string The path to the log file */
    private $log;
    
    /** @var object loging object. */
    private $logger;
    
    /** @var string the logging level. */
    private $logging;
    
    private $validator;
    
    private $guzzleClient;
    
    /**
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::__construct()
     */
    public function __construct($token = null, $debug = 'DEBUG')
    {
        // Logging.
        // 'DEBUG',
        // 'INFO',
        // 'NOTICE',
        // 'WARNING',
        // 'ERROR',
        // 'CRITICAL',
        // 'ALERT',
        // 'EMERGENCY',
        if (empty($this->logging)) {
            $this->logging = 'DEBUG';
            $this->log = 'inShoreBookwhen.log';
        }
        $this->logger = new Logger('inShore Bookwhen API');
        $this->logger->pushHandler(new StreamHandler($this->log, Logger::getLevels()[$this->logging]));
        
        $this->validator = new Validator();
        
        $this->include = [];
        
        if ($token === null) {
            //             if (self::$token === null) {
            //                 $msg = 'No token provided, and none is globally set. ';
            //                 $msg .= 'Use Diffbot::setToken, or instantiate the Diffbot class with a $token parameter.';
            //                 throw new ConfigurationException($msg);
            //             }
        } else {
            if ($this->validator->validToken($token)) {
                self::$token = $token;
                $this->instanceToken = self::$token;
            }
        }
        
        $this->apiBaseUri = 'https://api.bookwhen.com/';    
        $this->apiQuery = [];
        $this->apiVersion = 'v2';
        
        $this->guzzleClient = new GuzzleClient([
            'base_uri' => $this->apiBaseUri
        ]);
        
        $this->logger->info('Client class successfully instantiated');
        $this->logger->debug(var_export($this, true));
    }
    
    /**
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::request()
     */
    protected function request(): ResponseInterface
    {
        $this->logger->debug(__METHOD__ . '()');
        try {
            // Authorization.
            $requestOptions = [
                'headers' => [
                    'Authorization' => 'Basic ' . base64_encode($this->instanceToken . ':')
                ]
            ];
            
            // Query.
            if (!empty($this->apiQuery) && is_array($this->apiQuery)) {
                $requestOptions['query'] = $this->apiQuery;
            }
   
            $this->logger->debug('request(GET, ' . $this->apiResource . ', ' . var_export($requestOptions, true) . ')');
            $requestOptions['debug'] = true;
            
            return $this->guzzleClient->request('GET', $this->apiResource, $requestOptions);
           
        } catch (Exception $e) {
            throw new RestException($e, $this->logger);
        }
    }
    
    /**
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::getAttachment()
     */
    public function getAttachment($attachmentId)
    {
        $this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), true) . ')');
        if (!$this->validator->validId($attachmentId, 'attachment')) {
            throw new ValidationException('attachmentId', $attachmentId);
        }
        $this->apiResource = $this->apiVersion . '/attachments' . '/' . $attachmentId;
     
        try {
            $Response = $this->request();
            $body = json_decode($Response->getBody()->getContents());
            $attachment = $body->data[0];
            $return = $attachment;
            return $return;
        } catch (Exception $e) {
            throw new RestException($e, $this->logger);
        }
    }
    
    /**
     *
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::getAttachments()
     */
    public function getAttachments($title = null, $fileName = null, $fileType = null): array
    {    
        $this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), true) . ')');
        if (!is_null($title) && !$this->validator->validTitle($title)) {
            throw new ValidationException('title', $title);
        }

        if (!is_null($fileName) && !$this->validator->validFileName($fileName)) {
            throw new ValidationException('file name', $fileName);
        }
        
        if (!is_null($fileType) && !$this->validator->validFileType($fileType)) {
            throw new ValidationException('file type', $fileType);
        }
        
        $this->apiResource = $this->apiVersion . '/attachments';
        
        try {
            $return = [];
            $Response = $this->request();
            $body = json_decode($Response->getBody()->getContents());
            
            foreach ($body->data as $attachment) {
                array_push($return, $attachment);
            }
            
            return $return;
        } catch (Exception $e) {
            throw new RestException($e, $this->logger);
        }
    }
    
    /**
     *
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::getClassPass()
     */
    public function getClassPass($classPassId)
    {
        $this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), true) . ')');
        $this->apiResource = $this->apiVersion . '/class_passes';
       
        if (!$this->validator->validId($classPassId, 'classPass')) {
            throw new ValidationException('classPassId', $classPassId);
        }
     
        try {
            $Response = $this->request();
            $body = json_decode($Response->getBody()->getContents());
            $classPass = $body->data[0];
            $return = $classPass;
            return $return;
        } catch (Exception $e) {
            throw new RestException($e->getMessage(), $this->logger);
        }
    }
    
    /**
     *
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::getClassPasses()
     * @todo break params on to multiplper lines..
     */
    public function getClassPasses(
        $title = null, 
        $detail = null, 
        $usageType, 
        $cost = null, 
        $usageAllowance = null, 
        $useRestrictedForDays = null): array
    {   
        $this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), true) . ')');
        
        if (!is_null($title) && !$this->validator->validTitle($title)) {
            throw new ValidationException('title', $title);
        }
       
        $this->apiResource = $this->apiVersion . '/???';
        
        // @todo prepocess response onto nice model objects.
        $Response = $this->request();
        return json_decode($Response->getBody()->getContents());
    }
    
    /**
     *
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::getEvent()
     */
    public function getEvent($eventId)
    {
        if (!$this->validator->validId($eventId, 'event')) {
            throw new ValidationException('eventId', $eventId);
        }
        $this->apiResource = $this->apiVersion . '/events' . '/' . $eventId;
     
        try {
            $Response = $this->request();
            $body = json_decode($Response->getBody()->getContents());
            $event = $body->data;
            $event->soldOut = (bool) ($event->attributes->attendee_count >= $event->attributes->attendee_limit);
            $return = $event;
            return $return;
        } catch (Exception $e) {
            throw new RestException($e, $this->logger);
        }
    }
    
    /**
     *
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::getEvents()
     */
    public function getEvents(
        $calendar = false,
        $entry = false,
        $location = [],
        $tags = [],
        $title = [],
        $detail = [],
        $from = null,
        $to = null,
        $includeLocation = false,
        $includeAttachments = false,
        $includeTickets = false,
        $includeTicketsEvents = false,
        $includeTicketsClassPasses = false): array
    {    
        $this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), 1) . ')');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        
        // Validate $tags.
        if (!empty($tags)) {
            if (!is_array($tags)) {
                throw new ValidationException('tags', implode(' ', $tags));
            } else {
                $tags = array_unique($tags);
                foreach ($tags as $tag) {
                    if (!empty($tag) && !$this->validator->validTag($tag)) {
                        throw new ValidationException('tag', $tag);
                    }
                }
            }
            $this->apiQuery['filter[tag]'] = implode(',', $tags);
        }
        
        // Validate $from;
        if (!empty($from)) {
            if (!$this->validator->validFrom($from, $to)) {
                throw new ValidationException('from', $from . '-' . $to);
            } else {
                $this->apiQuery['filter[from]'] = $from;
            }
        }
        
        // Validate $to;
        if (!empty($to)) {
            if (!$this->validator->validTo($to, $from)) {
                throw new ValidationException('to', $to . '-' . $from);
            } else {
                $this->apiQuery['filter[to]'] = $to;
            }
        }
        
        // API resource.
        $this->apiResource = $this->apiVersion . '/events';
        
        
        $include = [];
        // Validate $includeLocation;

        if (!empty($includeLocation)) {
            if (!$this->validator->validInclude($includeLocation)) {
                throw new ValidationException('include', $includeLocation);
            } else if ($includeLocation) {
                $include[] = 'location';
            }
        }

        // Validate $includeAttachments;
        if (!empty($includeAttachments)) {
            if (!$this->validator->validInclude($includeAttachments)) {
                throw new ValidationException('include', $includeAttachments);
            } else if ($includeAttachments) {
                $include[] = 'attachments';
            }
        }
        
        // Validate $includeTickets
        if (!empty($includeTickets)) {
            if (!$this->validator->validInclude($includeTickets)) {
                throw new ValidationException('include', $includeTickets);
            } else if ($includeTickets) {
                $include[] = 'tickets';
            }
        }
        
        // Validate $includeTicketsEvents;
        if (!empty($includeTicketsEvents)) {
           if (!$this->validator->validInclude($includeTicketsEvents)) {
               throw new ValidationException('include', $includeTicketsEvents);
           } else if ($includeTicketsEvents) {
               $include[] = 'tickets.events';
           }
        }

        // Validate $includeTicketsEvents;
        if (!empty($includeTicketsClassPasses)) {
            if (!$this->validator->validInclude($includeTicketsClassPasses)) {
                throw new ValidationException('include', $includeTicketsClassPasses);
            } else if ($includeTicketsClassPasses) {
                $include[] = 'tickets.class_passes';
            }
        }

        if (count($include) > 0) {
            $this->apiQuery['include'] = implode(',', $include);

        }
  
        try {
            $Response = $this->request();
            
            $body = json_decode($Response->getBody()->getContents());
            
            // Prepocess response onto nice model objects.
            // @todo abstract.
            $return = [];
            
            foreach ($body->data as $event) {
                // Add additional properties here.
                $event->soldOut = (bool) ($event->attributes->attendee_count >= $event->attributes->attendee_limit);
                array_push($return, $event);
            }
            
            return $return;
        } catch (Exception $e) {
            throw new RestException($e, $this->logger);
        }
    }
    
    /**
     *
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::getLocation()
     */
    public function getLocation($locationId)
    {
        $this->apiResource = $this->apiVersion . '/locations';
        if (!$this->validator->validId($locationId, 'location')) {
            throw new ValidationException('locationId', $locationId);
        }
        
        try {
            $Response = $this->request();
            $body = json_decode($Response->getBody()->getContents());
            $location = $body->data[0];
            $return = $location;
            return $return;
        } catch (Exception $e) {
            throw new RestException($e->getMessage(), $this->logger);
        }

    }
    
    /**
     *
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::getLocations()
     * @todo validate params.
     */
    public function getLocations($addressText = null, $additionalInfo = null): array
    {
        $this->apiResource = $this->apiVersion . '/locations';

        $return = [];
        
        try {
            $Response = $this->request();
            $body = json_decode($Response->getBody()->getContents());
            
            foreach ($body->data as $location) {
                array_push($return, $location);
            }
            
            return $return;
        } catch (Exception $e) {
            throw new RestException($e, $this->logger);
        }
    } 
    
    /**
     *
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::getTicket()
     */
    public function getTicket($ticketId)
    {
        if (!$this->validator->validId($ticketId, 'ticket')) {
            throw new ValidationException('ticketId', $ticketId);
        }

        $this->apiResource = $this->apiVersion . '/tickets';

        
        try {
            $Response = $this->request();
            $body = json_decode($Response->getBody()->getContents());
            $ticket = $body->data[0];
            $return = $ticket;
            return $return;
        } catch (Exception $e) {
            throw new RestException($e, $this->logger);
        }
    }
    
    /**
     * 
     * {@inheritDoc}
     * @see \InShore\Bookwhen\Interfaces\ClientInterface::getTickets()
     */
    public function getTickets($eventId): array
    {
        $this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), true) . ')');
        if (!$this->validator->validId($eventId, 'event')) {
            throw new ValidationException('eventId', $eventId);
        }

        $this->apiQuery = ['event' => $eventId];
        
        $this->apiResource = $this->apiVersion . '/tickets';
                
        try {
            $return = [];
            
            $Response = $this->request();
            $body = json_decode($Response->getBody()->getContents());
            
            foreach ($body->data as $ticket) {
                array_push($return, $ticket);
            }
            $this->logger->debug(var_export($return, true));
            return $return;
        } catch (GuzzleHttp\Exception\ClientException $e) {
            throw new RestException($e, $this->logger);
        }
    }
    
    /**
     * Set Debug.
     */
    public function setLogging($level)
    {
        $this->logging = $level;
    } 
    
    /**
     * Set Guzzle Client
     */
    public function setGuzzleClient($guzzleClient)
    {
        $this->guzzleClient = $guzzleClient;
    } 
    
    /**
     * Sets the token for all future new instances
     * @param $token string The API access token, as obtained on diffbot.com/dev.
     */
    public static function setToken($token)
    {
        $validator = new Validator();
        if (!$validator->validToken($token)) {
            throw new \InvalidArgumentException('Invalid Token.');
        }
        self::$token = $token;
    } 
}

// EOF!


1		<?php
2
3		declare(strict_types=1);
4
5		namespace InShore\Bookwhen;
6
7		use GuzzleHttp;
8		use GuzzleHttp\Client as GuzzleClient;
9		use GuzzleHttp\Psr7\Request;
10		use InShore\Bookwhen\Exceptions\ConfigurationException;
11		use InShore\Bookwhen\Exceptions\RestException;
12		use InShore\Bookwhen\Exceptions\ValidationException;
13		use InShore\Bookwhen\Interfaces\ClientInterface;
14		use InShore\Bookwhen\Validator;
15		use Monolog\Logger;
16		use Monolog\Handler\StreamHandler;
17		use Psr\Http\Message\ResponseInterface;
18
19		/**
20		* Class Client
21		*
22		* The main class for API consumption
23		*
24		* @package inshore\bookwhen
25		* @todo comments
26		* @todo externalise config
27		* @todo fix token
28		*/
29		class Client implements ClientInterface
30		{
31
32		/** @var string The API access token */
33		private static $token = null;
34
35		/** @var string The instance token, settable once per new instance */
36		private $instanceToken;
37
38		private $apiBaseUri;
39
40		private $apiQuery;
41
42		private $apiResource;
43
44		private $apiVersion;
45
46		private $include;
47
48		/** @var string The path to the log file */
49		private $log;
50
51		/** @var object loging object. */
52		private $logger;
53
54		/** @var string the logging level. */
55		private $logging;
56
57		private $validator;
58
59		private $guzzleClient;
60
61		/**
62		* {@inheritDoc}
63		* @see \InShore\Bookwhen\Interfaces\ClientInterface::__construct()
64		*/
65		public function __construct($token = null, $debug = 'DEBUG')
66		{
67		// Logging.
68		// 'DEBUG',
69		// 'INFO',
70		// 'NOTICE',
71		// 'WARNING',
72		// 'ERROR',
73		// 'CRITICAL',
74		// 'ALERT',
75		// 'EMERGENCY',
76		if (empty($this->logging)) {
77		$this->logging = 'DEBUG';
78		$this->log = 'inShoreBookwhen.log';
79		}
80		$this->logger = new Logger('inShore Bookwhen API');
81		$this->logger->pushHandler(new StreamHandler($this->log, Logger::getLevels()[$this->logging]));
82
83		$this->validator = new Validator();
84
85		$this->include = [];
86
87		if ($token === null) {
88		// if (self::$token === null) {
89		// $msg = 'No token provided, and none is globally set. ';
90		// $msg .= 'Use Diffbot::setToken, or instantiate the Diffbot class with a $token parameter.';
91		// throw new ConfigurationException($msg);
92		// }
93		} else {
94		if ($this->validator->validToken($token)) {
95		self::$token = $token;
96		$this->instanceToken = self::$token;
97		}
98		}
99
100		$this->apiBaseUri = 'https://api.bookwhen.com/';
101		$this->apiQuery = [];
102		$this->apiVersion = 'v2';
103
104		$this->guzzleClient = new GuzzleClient([
105		'base_uri' => $this->apiBaseUri
106		]);
107
108		$this->logger->info('Client class successfully instantiated');
109		$this->logger->debug(var_export($this, true));
110		}
111
112		/**
113		* {@inheritDoc}
114		* @see \InShore\Bookwhen\Interfaces\ClientInterface::request()
115		*/
116		protected function request(): ResponseInterface
117		{
118		$this->logger->debug(__METHOD__ . '()');
119		try {
120		// Authorization.
121		$requestOptions = [
122		'headers' => [
123		'Authorization' => 'Basic ' . base64_encode($this->instanceToken . ':')
124		]
125		];
126
127		// Query.
128		if (!empty($this->apiQuery) && is_array($this->apiQuery)) {
129		$requestOptions['query'] = $this->apiQuery;
130		}
131
132		$this->logger->debug('request(GET, ' . $this->apiResource . ', ' . var_export($requestOptions, true) . ')');
133		$requestOptions['debug'] = true;
134
135		return $this->guzzleClient->request('GET', $this->apiResource, $requestOptions);
136
137		} catch (Exception $e) {
138		throw new RestException($e, $this->logger);
139		}
140		}
141
142		/**
143		* {@inheritDoc}
144		* @see \InShore\Bookwhen\Interfaces\ClientInterface::getAttachment()
145		*/
146	2	public function getAttachment($attachmentId)
147		{
148	2	$this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), true) . ')');
149	2	if (!$this->validator->validId($attachmentId, 'attachment')) {
150	1	throw new ValidationException('attachmentId', $attachmentId);
151		}
152	1	$this->apiResource = $this->apiVersion . '/attachments' . '/' . $attachmentId;
153
154		try {
155	1	$Response = $this->request();
156	1	$body = json_decode($Response->getBody()->getContents());
157	1	$attachment = $body->data[0];
158	1	$return = $attachment;
159	1	return $return;
160		} catch (Exception $e) {
161		throw new RestException($e, $this->logger);
162		}
163		}
164
165		/**
166		*
167		* {@inheritDoc}
168		* @see \InShore\Bookwhen\Interfaces\ClientInterface::getAttachments()
169		*/
170	1	public function getAttachments($title = null, $fileName = null, $fileType = null): array
171		{
172	1	$this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), true) . ')');
173	1	if (!is_null($title) && !$this->validator->validTitle($title)) {
174		throw new ValidationException('title', $title);
175		}
176
177	1	if (!is_null($fileName) && !$this->validator->validFileName($fileName)) {
178		throw new ValidationException('file name', $fileName);
179		}
180
181	1	if (!is_null($fileType) && !$this->validator->validFileType($fileType)) {
182		throw new ValidationException('file type', $fileType);
183		}
184
185	1	$this->apiResource = $this->apiVersion . '/attachments';
186
187		try {
188	1	$return = [];
189	1	$Response = $this->request();
190	1	$body = json_decode($Response->getBody()->getContents());
191
192	1	foreach ($body->data as $attachment) {
193	1	array_push($return, $attachment);
194		}
195
196	1	return $return;
197		} catch (Exception $e) {
198		throw new RestException($e, $this->logger);
199		}
200		}
201
202		/**
203		*
204		* {@inheritDoc}
205		* @see \InShore\Bookwhen\Interfaces\ClientInterface::getClassPass()
206		*/
207		public function getClassPass($classPassId)
208		{
209		$this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), true) . ')');
210		$this->apiResource = $this->apiVersion . '/class_passes';
211
212		if (!$this->validator->validId($classPassId, 'classPass')) {
213		throw new ValidationException('classPassId', $classPassId);
214		}
215
216		try {
217		$Response = $this->request();
218		$body = json_decode($Response->getBody()->getContents());
219		$classPass = $body->data[0];
220		$return = $classPass;
221		return $return;
222		} catch (Exception $e) {
223		throw new RestException($e->getMessage(), $this->logger);
224		}
225		}
226
227		/**
228		*
229		* {@inheritDoc}
230		* @see \InShore\Bookwhen\Interfaces\ClientInterface::getClassPasses()
231		* @todo break params on to multiplper lines..
232		*/
233		public function getClassPasses(
234		$title = null,
235		$detail = null,
236		$usageType,
237		$cost = null,
238		$usageAllowance = null,
239		$useRestrictedForDays = null): array
240		{
241		$this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), true) . ')');
242
243		if (!is_null($title) && !$this->validator->validTitle($title)) {
244		throw new ValidationException('title', $title);
245		}
246
247		$this->apiResource = $this->apiVersion . '/???';
248
249		// @todo prepocess response onto nice model objects.
250		$Response = $this->request();
251		return json_decode($Response->getBody()->getContents());
252		}
253
254		/**
255		*
256		* {@inheritDoc}
257		* @see \InShore\Bookwhen\Interfaces\ClientInterface::getEvent()
258		*/
259	1	public function getEvent($eventId)
260		{
261	1	if (!$this->validator->validId($eventId, 'event')) {
262		throw new ValidationException('eventId', $eventId);
263		}
264	1	$this->apiResource = $this->apiVersion . '/events' . '/' . $eventId;
265
266		try {
267	1	$Response = $this->request();
268	1	$body = json_decode($Response->getBody()->getContents());
269	1	$event = $body->data;
270	1	$event->soldOut = (bool) ($event->attributes->attendee_count >= $event->attributes->attendee_limit);
271	1	$return = $event;
272	1	return $return;
273		} catch (Exception $e) {
274		throw new RestException($e, $this->logger);
275		}
276		}
277
278		/**
279		*
280		* {@inheritDoc}
281		* @see \InShore\Bookwhen\Interfaces\ClientInterface::getEvents()
282		*/
283		public function getEvents(
284		$calendar = false,
285		$entry = false,
286		$location = [],
287		$tags = [],
288		$title = [],
289		$detail = [],
290		$from = null,
291		$to = null,
292		$includeLocation = false,
293		$includeAttachments = false,
294		$includeTickets = false,
295		$includeTicketsEvents = false,
296		$includeTicketsClassPasses = false): array
297		{
298		$this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), 1) . ')');
		0 ignored issues – show Bug introduced 2020-08-31 09:00 UTC by Report Bug Copy Issue Report Are you sure the usage of `var_export(func_get_args(), 1)` is correct as it seems to always return `null`. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
299
300		// Validate $tags.
301		if (!empty($tags)) {
302		if (!is_array($tags)) {
303		throw new ValidationException('tags', implode(' ', $tags));
304		} else {
305		$tags = array_unique($tags);
306		foreach ($tags as $tag) {
307		if (!empty($tag) && !$this->validator->validTag($tag)) {
308		throw new ValidationException('tag', $tag);
309		}
310		}
311		}
312		$this->apiQuery['filter[tag]'] = implode(',', $tags);
313		}
314
315		// Validate $from;
316		if (!empty($from)) {
317		if (!$this->validator->validFrom($from, $to)) {
318		throw new ValidationException('from', $from . '-' . $to);
319		} else {
320		$this->apiQuery['filter[from]'] = $from;
321		}
322		}
323
324		// Validate $to;
325		if (!empty($to)) {
326		if (!$this->validator->validTo($to, $from)) {
327		throw new ValidationException('to', $to . '-' . $from);
328		} else {
329		$this->apiQuery['filter[to]'] = $to;
330		}
331		}
332
333		// API resource.
334		$this->apiResource = $this->apiVersion . '/events';
335
336
337		$include = [];
338		// Validate $includeLocation;
339
340		if (!empty($includeLocation)) {
341		if (!$this->validator->validInclude($includeLocation)) {
342		throw new ValidationException('include', $includeLocation);
343		} else if ($includeLocation) {
344		$include[] = 'location';
345		}
346		}
347
348		// Validate $includeAttachments;
349		if (!empty($includeAttachments)) {
350		if (!$this->validator->validInclude($includeAttachments)) {
351		throw new ValidationException('include', $includeAttachments);
352		} else if ($includeAttachments) {
353		$include[] = 'attachments';
354		}
355		}
356
357		// Validate $includeTickets
358		if (!empty($includeTickets)) {
359		if (!$this->validator->validInclude($includeTickets)) {
360		throw new ValidationException('include', $includeTickets);
361		} else if ($includeTickets) {
362		$include[] = 'tickets';
363		}
364		}
365
366		// Validate $includeTicketsEvents;
367		if (!empty($includeTicketsEvents)) {
368		if (!$this->validator->validInclude($includeTicketsEvents)) {
369		throw new ValidationException('include', $includeTicketsEvents);
370		} else if ($includeTicketsEvents) {
371		$include[] = 'tickets.events';
372		}
373		}
374
375		// Validate $includeTicketsEvents;
376		if (!empty($includeTicketsClassPasses)) {
377		if (!$this->validator->validInclude($includeTicketsClassPasses)) {
378		throw new ValidationException('include', $includeTicketsClassPasses);
379		} else if ($includeTicketsClassPasses) {
380		$include[] = 'tickets.class_passes';
381		}
382		}
383
384		if (count($include) > 0) {
385		$this->apiQuery['include'] = implode(',', $include);
386
387		}
388
389		try {
390		$Response = $this->request();
391
392		$body = json_decode($Response->getBody()->getContents());
393
394		// Prepocess response onto nice model objects.
395		// @todo abstract.
396		$return = [];
397
398		foreach ($body->data as $event) {
399		// Add additional properties here.
400		$event->soldOut = (bool) ($event->attributes->attendee_count >= $event->attributes->attendee_limit);
401		array_push($return, $event);
402		}
403
404		return $return;
405		} catch (Exception $e) {
406		throw new RestException($e, $this->logger);
407		}
408		}
409
410		/**
411		*
412		* {@inheritDoc}
413		* @see \InShore\Bookwhen\Interfaces\ClientInterface::getLocation()
414		*/
415		public function getLocation($locationId)
416		{
417		$this->apiResource = $this->apiVersion . '/locations';
418		if (!$this->validator->validId($locationId, 'location')) {
419		throw new ValidationException('locationId', $locationId);
420		}
421
422		try {
423		$Response = $this->request();
424		$body = json_decode($Response->getBody()->getContents());
425		$location = $body->data[0];
426		$return = $location;
427		return $return;
428		} catch (Exception $e) {
429		throw new RestException($e->getMessage(), $this->logger);
430		}
431
432		}
433
434		/**
435		*
436		* {@inheritDoc}
437		* @see \InShore\Bookwhen\Interfaces\ClientInterface::getLocations()
438		* @todo validate params.
439		*/
440		public function getLocations($addressText = null, $additionalInfo = null): array
441		{
442		$this->apiResource = $this->apiVersion . '/locations';
443
444		$return = [];
445
446		try {
447		$Response = $this->request();
448		$body = json_decode($Response->getBody()->getContents());
449
450		foreach ($body->data as $location) {
451		array_push($return, $location);
452		}
453
454		return $return;
455		} catch (Exception $e) {
456		throw new RestException($e, $this->logger);
457		}
458		}
459
460		/**
461		*
462		* {@inheritDoc}
463		* @see \InShore\Bookwhen\Interfaces\ClientInterface::getTicket()
464		*/
465	1	public function getTicket($ticketId)
466		{
467	1	if (!$this->validator->validId($ticketId, 'ticket')) {
468		throw new ValidationException('ticketId', $ticketId);
469		}
470
471	1	$this->apiResource = $this->apiVersion . '/tickets';
472
473
474		try {
475	1	$Response = $this->request();
476	1	$body = json_decode($Response->getBody()->getContents());
477	1	$ticket = $body->data[0];
478	1	$return = $ticket;
479	1	return $return;
480		} catch (Exception $e) {
481		throw new RestException($e, $this->logger);
482		}
483		}
484
485		/**
486		*
487		* {@inheritDoc}
488		* @see \InShore\Bookwhen\Interfaces\ClientInterface::getTickets()
489		*/
490	2	public function getTickets($eventId): array
491		{
492	2	$this->logger->debug(__METHOD__ . '(' . var_export(func_get_args(), true) . ')');
493	2	if (!$this->validator->validId($eventId, 'event')) {
494	1	throw new ValidationException('eventId', $eventId);
495		}
496
497	1	$this->apiQuery = ['event' => $eventId];
498
499	1	$this->apiResource = $this->apiVersion . '/tickets';
500
501		try {
502	1	$return = [];
503
504	1	$Response = $this->request();
505	1	$body = json_decode($Response->getBody()->getContents());
506
507	1	foreach ($body->data as $ticket) {
508	1	array_push($return, $ticket);
509		}
510	1	$this->logger->debug(var_export($return, true));
511	1	return $return;
512		} catch (GuzzleHttp\Exception\ClientException $e) {
513		throw new RestException($e, $this->logger);
514		}
515		}
516
517		/**
518		* Set Debug.
519		*/
520		public function setLogging($level)
521		{
522		$this->logging = $level;
523		}
524
525		/**
526		* Set Guzzle Client
527		*/
528		public function setGuzzleClient($guzzleClient)
529		{
530		$this->guzzleClient = $guzzleClient;
531		}
532
533		/**
534		* Sets the token for all future new instances
535		* @param $token string The API access token, as obtained on diffbot.com/dev.
536		*/
537		public static function setToken($token)
538		{
539		$validator = new Validator();
540		if (!$validator->validToken($token)) {
541		throw new \InvalidArgumentException('Invalid Token.');
542		}
543		self::$token = $token;
544		}
545		}
546
547		// EOF!
548

inshore / bookwhen

Push — scrutinizer ( f8c545...f052ee )

Client::getAttachments() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like