Completed
Push — master ( fc1ace...8ff8f8 )
by Dieter
07:27
created

Client::fareMasterPricerCalendar()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 8
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 8
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 5
nc 1
nop 2
1
<?php
2
/**
3
 * amadeus-ws-client
4
 *
5
 * Copyright 2015 Amadeus Benelux NV
6
 *
7
 * Licensed under the Apache License, Version 2.0 (the "License");
8
 * you may not use this file except in compliance with the License.
9
 * You may obtain a copy of the License at
10
 *
11
 * http://www.apache.org/licenses/LICENSE-2.0
12
 *
13
 * Unless required by applicable law or agreed to in writing, software
14
 * distributed under the License is distributed on an "AS IS" BASIS,
15
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
 * See the License for the specific language governing permissions and
17
 * limitations under the License.
18
 *
19
 * @package Amadeus
20
 * @license https://opensource.org/licenses/Apache-2.0 Apache 2.0
21
 */
22
23
namespace Amadeus;
24
25
use Amadeus\Client\Exception;
26
use Amadeus\Client\Params;
27
use Amadeus\Client\RequestCreator\RequestCreatorInterface;
28
use Amadeus\Client\RequestOptions;
29
use Amadeus\Client\ResponseHandler\ResponseHandlerInterface;
30
use Amadeus\Client\Result;
31
use Amadeus\Client\Session\Handler\HandlerFactory;
32
use Amadeus\Client\RequestCreator\Factory as RequestCreatorFactory;
33
use Amadeus\Client\Session\Handler\HandlerInterface;
34
use Amadeus\Client\ResponseHandler\Base as ResponseHandlerBase;
35
36
/**
37
 * Amadeus Web Service Client.
38
 *
39
 * TODO:
40
 * - support older versions of SoapHeader (1)
41
 *
42
 * @package Amadeus
43
 * @author Dieter Devlieghere <[email protected]>
44
 */
45
class Client
46
{
47
    /**
48
     * Amadeus SOAP header version 1
49
     */
50
    const HEADER_V1 = "1";
51
    /**
52
     * Amadeus SOAP header version 2
53
     */
54
    const HEADER_V2 = "2";
55
    /**
56
     * Amadeus SOAP header version 4
57
     */
58
    const HEADER_V4 = "4";
59
60
    /**
61
     * Version string
62
     *
63
     * @var string
64
     */
65
    const VERSION = "1.1.0-dev";
66
67
    /**
68
     * An identifier string for the library (to be used in Received From entries)
69
     *
70
     * @var string
71
     */
72
    const RECEIVED_FROM_IDENTIFIER = "amabnl-amadeus-ws-client";
73
74
    /**
75
     * Session Handler will be sending all the messages and handling all session-related things.
76
     *
77
     * @var HandlerInterface
78
     */
79
    protected $sessionHandler;
80
81
    /**
82
     * Request Creator is will create the correct message structure to send to the SOAP server.
83
     *
84
     * @var RequestCreatorInterface
85
     */
86
    protected $requestCreator;
87
88
    /**
89
     * Response Handler will check the received response for errors.
90
     *
91
     * @var ResponseHandlerInterface
92
     */
93
    protected $responseHandler;
94
95
    /**
96
     * Authentication parameters
97
     *
98
     * @var Params\AuthParams
99
     */
100
    protected $authParams;
101
102
    /**
103
     * @var string
104
     */
105
    protected $lastMessage;
106
107
    /**
108
     * Set the session as stateful (true) or stateless (false)
109
     *
110
     * @param bool $newStateful
111
     */
112
    public function setStateful($newStateful)
113
    {
114
        $this->sessionHandler->setStateful($newStateful);
115
    }
116
117
    /**
118
     * @return bool
119
     */
120
    public function isStateful()
121
    {
122
        return $this->sessionHandler->isStateful();
123
    }
124
125
    /**
126
     * Get the last raw XML message that was sent out
127
     *
128
     * @return string|null
129
     */
130
    public function getLastRequest()
131
    {
132
        return $this->sessionHandler->getLastRequest($this->lastMessage);
133
    }
134
135
    /**
136
     * Get the last raw XML message that was received
137
     *
138
     * @return string|null
139
     */
140
    public function getLastResponse()
141
    {
142
        return $this->sessionHandler->getLastResponse($this->lastMessage);
143
    }
144
145
    /**
146
     * Get session information for authenticated session
147
     *
148
     * - sessionId
149
     * - sequenceNr
150
     * - securityToken
151
     *
152
     * @return array|null
153
     */
154
    public function getSessionData()
155
    {
156
        return $this->sessionHandler->getSessionData();
157
    }
158
159
    /**
160
     * Restore a previously used session
161
     *
162
     * To be used when implementing your own session pooling system on legacy Soap Header 2 applications.
163
     *
164
     * @param array $sessionData
165
     * @return bool
166
     */
167
    public function setSessionData(array $sessionData)
168
    {
169
        return $this->sessionHandler->setSessionData($sessionData);
170
    }
171
172
    /**
173
     * Construct Amadeus Web Services client
174
     *
175
     * @param Params $params
176
     */
177
    public function __construct($params)
178
    {
179
        if ($params->authParams instanceof Params\AuthParams) {
180
            $this->authParams = $params->authParams;
181
            if (isset($params->sessionHandlerParams) &&
182
                $params->sessionHandlerParams instanceof Params\SessionHandlerParams
183
            ) {
184
                $params->sessionHandlerParams->authParams = $this->authParams;
185
            }
186
        }
187
188
        $this->sessionHandler = $this->loadSessionHandler(
189
            $params->sessionHandler,
190
            $params->sessionHandlerParams
0 ignored issues
show
Bug introduced by
It seems like $params->sessionHandlerParams can be null; however, loadSessionHandler() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
191
        );
192
193
        $this->requestCreator = $this->loadRequestCreator(
194
            $params->requestCreator,
195
            $params->requestCreatorParams,
196
            self::RECEIVED_FROM_IDENTIFIER . "-" .self::VERSION,
197
            $this->sessionHandler->getOriginatorOffice(),
198
            $this->sessionHandler->getMessagesAndVersions()
199
        );
200
201
        $this->responseHandler = $this->loadResponseHandler(
202
            $params->responseHandler
203
        );
204
    }
205
206
    /**
207
     * Authenticate.
208
     *
209
     * Parameters were provided at construction time (sessionhandlerparams)
210
     *
211
     * @return Result
212
     * @throws Exception
213
     */
214
    public function securityAuthenticate()
215
    {
216
        $msgName = 'Security_Authenticate';
217
218
        return $this->callMessage(
219
            $msgName,
220
            new RequestOptions\SecurityAuthenticateOptions(
221
                $this->authParams
222
            ),
223
            [],
224
            false
225
        );
226
    }
227
228
    /**
229
     * Terminate a session - only applicable to non-stateless mode.
230
     *
231
     * @return Result
232
     * @throws Exception
233
     */
234
    public function securitySignOut()
235
    {
236
        $msgName = 'Security_SignOut';
237
238
        return $this->callMessage(
239
            $msgName,
240
            new RequestOptions\SecuritySignOutOptions(),
241
            [],
242
            true
243
        );
244
    }
245
246
    /**
247
     * PNR_Retrieve - Retrieve an Amadeus PNR by record locator
248
     *
249
     * By default, the result will be the PNR_Reply XML as string.
250
     * That way you can easily parse the PNR's contents with XPath.
251
     *
252
     * https://webservices.amadeus.com/extranet/viewService.do?id=27&flavourId=1&menuId=functional
253
     *
254
     * @param RequestOptions\PnrRetrieveOptions $options
255
     * @param array $messageOptions (OPTIONAL)
256
     * @return Result
257
     * @throws Exception
258
     */
259
    public function pnrRetrieve(RequestOptions\PnrRetrieveOptions $options, $messageOptions = [])
260
    {
261
        $msgName = 'PNR_Retrieve';
262
263
        return $this->callMessage($msgName, $options, $messageOptions);
264
    }
265
266
    /**
267
     * Create a PNR using PNR_AddMultiElements
268
     *
269
     * @param RequestOptions\PnrCreatePnrOptions $options
270
     * @param array $messageOptions (OPTIONAL)
271
     * @return Result
272
     */
273
    public function pnrCreatePnr(RequestOptions\PnrCreatePnrOptions $options, $messageOptions = [])
274
    {
275
        $msgName = 'PNR_AddMultiElements';
276
277
        return $this->callMessage($msgName, $options, $messageOptions);
278
    }
279
280
    /**
281
     * PNR_AddMultiElements - Create a new PNR or update an existing PNR.
282
     *
283
     * https://webservices.amadeus.com/extranet/viewService.do?id=25&flavourId=1&menuId=functional
284
     *
285
     * @param RequestOptions\PnrAddMultiElementsOptions $options
286
     * @param array $messageOptions (OPTIONAL)
287
     * @return Result
288
     */
289
    public function pnrAddMultiElements(RequestOptions\PnrAddMultiElementsOptions $options, $messageOptions = [])
290
    {
291
        $msgName = 'PNR_AddMultiElements';
292
293
        return $this->callMessage($msgName, $options, $messageOptions);
294
    }
295
296
    /**
297
     * PNR_RetrieveAndDisplay - Retrieve an Amadeus PNR by record locator including extra info
298
     *
299
     * This extra info is info you cannot see in the regular PNR, like Offers.
300
     *
301
     * By default, the result will be the PNR_RetrieveAndDisplayReply XML as string.
302
     * That way you can easily parse the PNR's contents with XPath.
303
     *
304
     * Set $messageOptions['asString'] = FALSE to get the response as a PHP object.
305
     *
306
     * https://webservices.amadeus.com/extranet/viewService.do?id=1922&flavourId=1&menuId=functional
307
     *
308
     * @param RequestOptions\PnrRetrieveAndDisplayOptions $options Amadeus Record Locator for PNR
309
     * @param array $messageOptions (OPTIONAL)
310
     * @return Result
311
     * @throws Exception
312
     **/
313
    public function pnrRetrieveAndDisplay(RequestOptions\PnrRetrieveAndDisplayOptions $options, $messageOptions = [])
314
    {
315
        $msgName = 'PNR_RetrieveAndDisplay';
316
317
        return $this->callMessage($msgName, $options, $messageOptions);
318
    }
319
320
    /**
321
     * PNR_Cancel
322
     *
323
     * @param RequestOptions\PnrCancelOptions $options
324
     * @param array $messageOptions (OPTIONAL)
325
     * @return Result
326
     */
327
    public function pnrCancel(RequestOptions\PnrCancelOptions $options, $messageOptions = [])
328
    {
329
        $msgName = 'PNR_Cancel';
330
331
        return $this->callMessage($msgName, $options, $messageOptions);
332
    }
333
334
    /**
335
     * PNR_DisplayHistory
336
     *
337
     * @param RequestOptions\PnrDisplayHistoryOptions $options
338
     * @param array $messageOptions (OPTIONAL)
339
     * @return Result
340
     */
341
    public function pnrDisplayHistory(RequestOptions\PnrDisplayHistoryOptions $options, $messageOptions = [])
342
    {
343
        $msgName = 'PNR_DisplayHistory';
344
345
        return $this->callMessage($msgName, $options, $messageOptions);
346
    }
347
348
    /**
349
     * PNR_TransferOwnership
350
     *
351
     * @param RequestOptions\PnrTransferOwnershipOptions $options
352
     * @param array $messageOptions (OPTIONAL)
353
     * @return Result
354
     */
355
    public function pnrTransferOwnership(RequestOptions\PnrTransferOwnershipOptions $options, $messageOptions = [])
356
    {
357
        $msgName = 'PNR_TransferOwnership';
358
359
        return $this->callMessage($msgName, $options, $messageOptions);
360
    }
361
362
    /**
363
     * Queue_List - get a list of all PNR's on a given queue
364
     *
365
     * https://webservices.amadeus.com/extranet/viewService.do?id=52&flavourId=1&menuId=functional
366
     *
367
     * @param RequestOptions\QueueListOptions $options
368
     * @param array $messageOptions (OPTIONAL)
369
     * @return Result
370
     */
371
    public function queueList(RequestOptions\QueueListOptions $options, $messageOptions = [])
372
    {
373
        $msgName = 'Queue_List';
374
375
        return $this->callMessage($msgName, $options, $messageOptions);
376
    }
377
378
    /**
379
     * Queue_PlacePNR - Place a PNR on a given queue
380
     *
381
     * @param RequestOptions\QueuePlacePnrOptions $options
382
     * @param array $messageOptions (OPTIONAL)
383
     * @return Result
384
     */
385
    public function queuePlacePnr(RequestOptions\QueuePlacePnrOptions $options, $messageOptions = [])
386
    {
387
        $msgName = 'Queue_PlacePNR';
388
389
        return $this->callMessage($msgName, $options, $messageOptions);
390
    }
391
392
    /**
393
     * Queue_RemoveItem - remove an item (a PNR) from a given queue
394
     *
395
     * @param RequestOptions\QueueRemoveItemOptions $options
396
     * @param array $messageOptions (OPTIONAL)
397
     * @return Result
398
     */
399
    public function queueRemoveItem(RequestOptions\QueueRemoveItemOptions $options, $messageOptions = [])
400
    {
401
        $msgName = 'Queue_RemoveItem';
402
403
        return $this->callMessage($msgName, $options, $messageOptions);
404
    }
405
406
    /**
407
     * Queue_MoveItem - move an item (a PNR) from one queue to another.
408
     *
409
     * @param RequestOptions\QueueMoveItemOptions $options
410
     * @param array $messageOptions (OPTIONAL)
411
     * @return Result
412
     */
413
    public function queueMoveItem(RequestOptions\QueueMoveItemOptions $options, $messageOptions = [])
414
    {
415
        $msgName = 'Queue_MoveItem';
416
417
        return $this->callMessage($msgName, $options, $messageOptions);
418
    }
419
420
    /**
421
     * Offer_VerifyOffer
422
     *
423
     * To be called in the context of an open PNR
424
     *
425
     * @param RequestOptions\OfferVerifyOptions $options
426
     * @param array $messageOptions (OPTIONAL)
427
     * @return Result
428
     */
429
    public function offerVerify(RequestOptions\OfferVerifyOptions $options, $messageOptions = [])
430
    {
431
        $msgName = 'Offer_VerifyOffer';
432
433
        return $this->callMessage($msgName, $options, $messageOptions);
434
    }
435
436
    /**
437
     * Offer_ConfirmAirOffer
438
     *
439
     * @param RequestOptions\OfferConfirmAirOptions $options
440
     * @param array $messageOptions (OPTIONAL)
441
     * @return Result
442
     */
443
    public function offerConfirmAir(RequestOptions\OfferConfirmAirOptions $options, $messageOptions = [])
444
    {
445
        $msgName = 'Offer_ConfirmAirOffer';
446
447
        return $this->callMessage($msgName, $options, $messageOptions);
448
    }
449
450
    /**
451
     * Offer_ConfirmHotelOffer
452
     *
453
     * @param RequestOptions\OfferConfirmHotelOptions $options
454
     * @param array $messageOptions (OPTIONAL)
455
     * @return Result
456
     */
457
    public function offerConfirmHotel(RequestOptions\OfferConfirmHotelOptions $options, $messageOptions = [])
458
    {
459
        $msgName = 'Offer_ConfirmHotelOffer';
460
461
        return $this->callMessage($msgName, $options, $messageOptions);
462
    }
463
464
    /**
465
     * Offer_ConfirmCarOffer
466
     *
467
     * @param RequestOptions\OfferConfirmCarOptions $options
468
     * @param array $messageOptions (OPTIONAL)
469
     * @return Result
470
     */
471
    public function offerConfirmCar(RequestOptions\OfferConfirmCarOptions $options, $messageOptions = [])
472
    {
473
        $msgName = 'Offer_ConfirmCarOffer';
474
475
        return $this->callMessage($msgName, $options, $messageOptions);
476
    }
477
478
    /**
479
     * Fare_MasterPricerTravelBoardSearch
480
     *
481
     * @param RequestOptions\FareMasterPricerTbSearch $options
482
     * @param array $messageOptions (OPTIONAL)
483
     * @return Result
484
     */
485
    public function fareMasterPricerTravelBoardSearch(
486
        RequestOptions\FareMasterPricerTbSearch $options,
487
        $messageOptions = []
488
    ) {
489
        $msgName = 'Fare_MasterPricerTravelBoardSearch';
490
491
        return $this->callMessage($msgName, $options, $messageOptions);
492
    }
493
494
    /**
495
     * Fare_MasterPricerCalendar
496
     *
497
     * @param RequestOptions\FareMasterPricerCalendarOptions $options
498
     * @param array $messageOptions (OPTIONAL)
499
     * @return Result
500
     */
501
    public function fareMasterPricerCalendar(
502
        RequestOptions\FareMasterPricerCalendarOptions $options,
503
        $messageOptions = []
504
    ) {
505
        $msgName = 'Fare_MasterPricerCalendar';
506
507
        return $this->callMessage($msgName, $options, $messageOptions);
508
    }
509
510
    /**
511
     * Fare_PricePnrWithBookingClass
512
     *
513
     * @param RequestOptions\FarePricePnrWithBookingClassOptions $options
514
     * @param array $messageOptions (OPTIONAL)
515
     * @return Result
516
     */
517
    public function farePricePnrWithBookingClass(
518
        RequestOptions\FarePricePnrWithBookingClassOptions $options,
519
        $messageOptions = []
520
    ) {
521
        $msgName = 'Fare_PricePNRWithBookingClass';
522
523
        return $this->callMessage($msgName, $options, $messageOptions);
524
    }
525
526
    /**
527
     * Fare_InformativePricingWithoutPNR
528
     *
529
     * @param RequestOptions\FareInformativePricingWithoutPnrOptions $options
530
     * @param array $messageOptions (OPTIONAL)
531
     * @return Result
532
     */
533
    public function fareInformativePricingWithoutPnr(
534
        RequestOptions\FareInformativePricingWithoutPnrOptions $options,
535
        $messageOptions = []
536
    ) {
537
        $msgName = 'Fare_InformativePricingWithoutPNR';
538
539
        return $this->callMessage($msgName, $options, $messageOptions);
540
    }
541
542
    /**
543
     * Fare_CheckRules
544
     *
545
     * @param RequestOptions\FareCheckRulesOptions $options
546
     * @param array $messageOptions (OPTIONAL)
547
     * @return Result
548
     */
549
    public function fareCheckRules(RequestOptions\FareCheckRulesOptions $options, $messageOptions = [])
550
    {
551
        $msgName = 'Fare_CheckRules';
552
553
        return $this->callMessage($msgName, $options, $messageOptions);
554
    }
555
556
    /**
557
     * Fare_ConvertCurrency
558
     *
559
     * @param RequestOptions\FareConvertCurrencyOptions $options
560
     * @param array $messageOptions (OPTIONAL)
561
     * @return Result
562
     */
563
    public function fareConvertCurrency(RequestOptions\FareConvertCurrencyOptions $options, $messageOptions = [])
564
    {
565
        $msgName = 'Fare_ConvertCurrency';
566
567
        return $this->callMessage($msgName, $options, $messageOptions);
568
    }
569
570
    /**
571
     * Air_MultiAvailability
572
     *
573
     * @param RequestOptions\AirMultiAvailabilityOptions $options
574
     * @param array $messageOptions (OPTIONAL)
575
     * @return Result
576
     */
577
    public function airMultiAvailability(
578
        RequestOptions\AirMultiAvailabilityOptions $options,
579
        $messageOptions = []
580
    ) {
581
        $msgName = 'Air_MultiAvailability';
582
583
        return $this->callMessage($msgName, $options, $messageOptions);
584
    }
585
586
    /**
587
     * Air_SellFromRecommendation
588
     *
589
     * @param RequestOptions\AirSellFromRecommendationOptions $options
590
     * @param array $messageOptions (OPTIONAL)
591
     * @return Result
592
     */
593
    public function airSellFromRecommendation(
594
        RequestOptions\AirSellFromRecommendationOptions $options,
595
        $messageOptions = []
596
    ) {
597
        $msgName = 'Air_SellFromRecommendation';
598
599
        return $this->callMessage($msgName, $options, $messageOptions);
600
    }
601
602
    /**
603
     * Air_FlightInfo
604
     *
605
     * @param RequestOptions\AirFlightInfoOptions $options
606
     * @param array $messageOptions (OPTIONAL)
607
     * @return Result
608
     */
609
    public function airFlightInfo(RequestOptions\AirFlightInfoOptions $options, $messageOptions = [])
610
    {
611
        $msgName = 'Air_FlightInfo';
612
613
        return $this->callMessage($msgName, $options, $messageOptions);
614
    }
615
616
    /**
617
     * Air_RetrieveSeatMap
618
     *
619
     * @param RequestOptions\AirRetrieveSeatMapOptions $options
620
     * @param array $messageOptions (OPTIONAL)
621
     * @return Result
622
     */
623
    public function airRetrieveSeatMap(RequestOptions\AirRetrieveSeatMapOptions $options, $messageOptions = [])
624
    {
625
        $msgName = 'Air_RetrieveSeatMap';
626
627
        return $this->callMessage($msgName, $options, $messageOptions);
628
    }
629
630
    /**
631
     * Command_Cryptic
632
     *
633
     * @param RequestOptions\CommandCrypticOptions $options
634
     * @param array $messageOptions (OPTIONAL)
635
     * @return Result
636
     */
637
    public function commandCryptic(RequestOptions\CommandCrypticOptions $options, $messageOptions = [])
638
    {
639
        $msgName = 'Command_Cryptic';
640
641
        return $this->callMessage($msgName, $options, $messageOptions);
642
    }
643
644
    /**
645
     * MiniRule_GetFromPricingRec
646
     *
647
     * @param RequestOptions\MiniRuleGetFromPricingRecOptions $options
648
     * @param array $messageOptions (OPTIONAL)
649
     * @return Result
650
     */
651
    public function miniRuleGetFromPricingRec(
652
        RequestOptions\MiniRuleGetFromPricingRecOptions $options,
653
        $messageOptions = []
654
    ) {
655
        $msgName = 'MiniRule_GetFromPricingRec';
656
657
        return $this->callMessage($msgName, $options, $messageOptions);
658
    }
659
660
    /**
661
     * Info_EncodeDecodeCity
662
     *
663
     * @param RequestOptions\InfoEncodeDecodeCityOptions $options
664
     * @param array $messageOptions (OPTIONAL)
665
     * @return Result
666
     */
667
    public function infoEncodeDecodeCity(RequestOptions\InfoEncodeDecodeCityOptions $options, $messageOptions = [])
668
    {
669
        $msgName = 'Info_EncodeDecodeCity';
670
671
        return $this->callMessage($msgName, $options, $messageOptions);
672
    }
673
674
675
    /**
676
     * Ticket_CreateTSTFromPricing
677
     *
678
     * @param RequestOptions\TicketCreateTstFromPricingOptions $options
679
     * @param array $messageOptions (OPTIONAL)
680
     * @return Result
681
     */
682
    public function ticketCreateTSTFromPricing(
683
        RequestOptions\TicketCreateTstFromPricingOptions $options,
684
        $messageOptions = []
685
    ) {
686
        $msgName = 'Ticket_CreateTSTFromPricing';
687
688
        return $this->callMessage($msgName, $options, $messageOptions);
689
    }
690
691
    /**
692
     * Ticket_DeleteTST
693
     *
694
     * @param RequestOptions\TicketDeleteTstOptions $options
695
     * @param array $messageOptions (OPTIONAL)
696
     * @return Result
697
     */
698
    public function ticketDeleteTST(RequestOptions\TicketDeleteTstOptions $options, $messageOptions = [])
699
    {
700
        $msgName = 'Ticket_DeleteTST';
701
702
        return $this->callMessage($msgName, $options, $messageOptions);
703
    }
704
705
    /**
706
     * Ticket_DisplayTST
707
     *
708
     * @param RequestOptions\TicketDisplayTstOptions $options
709
     * @param array $messageOptions (OPTIONAL)
710
     * @return Result
711
     */
712
    public function ticketDisplayTST(RequestOptions\TicketDisplayTstOptions $options, $messageOptions = [])
713
    {
714
        $msgName = 'Ticket_DisplayTST';
715
716
        return $this->callMessage($msgName, $options, $messageOptions);
717
    }
718
719
    /**
720
     * DocIssuance_IssueTicket
721
     *
722
     * @param RequestOptions\DocIssuanceIssueTicketOptions $options
723
     * @param array $messageOptions (OPTIONAL)
724
     * @return Result
725
     */
726
    public function docIssuanceIssueTicket(
727
        RequestOptions\DocIssuanceIssueTicketOptions $options,
728
        $messageOptions = []
729
    ) {
730
        $msgName = 'DocIssuance_IssueTicket';
731
732
        return $this->callMessage($msgName, $options, $messageOptions);
733
    }
734
735
    /**
736
     * PriceXplorer_ExtremeSearch
737
     *
738
     * @param RequestOptions\PriceXplorerExtremeSearchOptions $options
739
     * @param array $messageOptions (OPTIONAL)
740
     * @return Result
741
     */
742
    public function priceXplorerExtremeSearch(
743
        RequestOptions\PriceXplorerExtremeSearchOptions $options,
744
        $messageOptions = []
745
    ) {
746
        $msgName = 'PriceXplorer_ExtremeSearch';
747
748
        return $this->callMessage($msgName, $options, $messageOptions);
749
    }
750
751
    /**
752
     * SalesReports_DisplayQueryReport
753
     *
754
     * @param RequestOptions\SalesReportsDisplayQueryReportOptions $options
755
     * @param array $messageOptions (OPTIONAL)
756
     * @return Result
757
     */
758
    public function salesReportsDisplayQueryReport(
759
        RequestOptions\SalesReportsDisplayQueryReportOptions $options,
760
        $messageOptions = []
761
    ) {
762
        $msgName = 'SalesReports_DisplayQueryReport';
763
764
        return $this->callMessage($msgName, $options, $messageOptions);
765
    }
766
767
    /**
768
     * Call a message with the given parameters
769
     *
770
     * @param string $messageName
771
     * @param RequestOptions\RequestOptionsInterface $options
772
     * @param array $messageOptions
773
     * @param bool $endSession
774
     * @return Result
775
     * @throws Client\Exception
776
     * @throws Client\Struct\InvalidArgumentException
777
     * @throws Client\InvalidMessageException
778
     * @throws Client\RequestCreator\MessageVersionUnsupportedException
779
     * @throws \RuntimeException
780
     * @throws \InvalidArgumentException
781
     * @throws \SoapFault
782
     */
783
    protected function callMessage($messageName, $options, $messageOptions, $endSession = false)
784
    {
785
        $messageOptions = $this->makeMessageOptions($messageOptions, $endSession);
786
787
        $this->lastMessage = $messageName;
788
789
        $sendResult = $this->sessionHandler->sendMessage(
790
            $messageName,
791
            $this->requestCreator->createRequest(
792
                $messageName,
793
                $options
794
            ),
795
            $messageOptions
796
        );
797
798
        return $this->responseHandler->analyzeResponse(
799
            $sendResult,
800
            $messageName
801
        );
802
    }
803
804
    /**
805
     * Make message options
806
     *
807
     * Message options are meta options when sending a message to the amadeus web services
808
     * - (if stateful) should we end the current session after sending this call?
809
     * - ... ?
810
     *
811
     * @param array $incoming The Message options chosen by the caller - if any.
812
     * @param bool $endSession Switch if you want to terminate the current session after making the call.
813
     * @return array
814
     */
815
    protected function makeMessageOptions(array $incoming, $endSession = false)
816
    {
817
        $options = [
818
            'endSession' => $endSession
819
        ];
820
821
        if (array_key_exists('endSession', $incoming)) {
822
            $options['endSession'] = $incoming['endSession'];
823
        }
824
825
        return $options;
826
    }
827
828
    /**
829
     * Load the session handler
830
     *
831
     * Either load the provided session handler or create one depending on incoming parameters.
832
     *
833
     * @param HandlerInterface|null $sessionHandler
834
     * @param Params\SessionHandlerParams $params
835
     * @return HandlerInterface
836
     */
837
    protected function loadSessionHandler($sessionHandler, $params)
838
    {
839
        $newSessionHandler = null;
0 ignored issues
show
Unused Code introduced by
$newSessionHandler is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
840
841
        if ($sessionHandler instanceof HandlerInterface) {
842
            $newSessionHandler = $sessionHandler;
843
        } else {
844
            $newSessionHandler = HandlerFactory::createHandler($params);
845
        }
846
847
        return $newSessionHandler;
848
    }
849
850
    /**
851
     * Load a request creator
852
     *
853
     * A request creator is responsible for generating the correct request to send.
854
     *
855
     * @param RequestCreatorInterface|null $requestCreator
856
     * @param Params\RequestCreatorParams $params
857
     * @param string $libIdentifier Library identifier & version string (for Received From)
858
     * @param string $originatorOffice The Office we are signed in with.
859
     * @param array $mesVer Messages & Versions array of active messages in the WSDL
860
     * @return RequestCreatorInterface
861
     * @throws \RuntimeException
862
     */
863
    protected function loadRequestCreator($requestCreator, $params, $libIdentifier, $originatorOffice, $mesVer)
864
    {
865
        $newRequestCreator = null;
0 ignored issues
show
Unused Code introduced by
$newRequestCreator is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
866
867
        if ($requestCreator instanceof RequestCreatorInterface) {
868
            $newRequestCreator = $requestCreator;
869
        } else {
870
            $params->originatorOfficeId = $originatorOffice;
871
            $params->messagesAndVersions = $mesVer;
872
873
            $newRequestCreator = RequestCreatorFactory::createRequestCreator(
874
                $params,
875
                $libIdentifier
876
            );
877
        }
878
879
        return $newRequestCreator;
880
    }
881
882
    /**
883
     * Load a response handler
884
     *
885
     * @param ResponseHandlerInterface|null $responseHandler
886
     *
887
     * @return ResponseHandlerInterface
888
     * @throws \RuntimeException
889
     */
890
    protected function loadResponseHandler($responseHandler)
891
    {
892
        $newResponseHandler = null;
0 ignored issues
show
Unused Code introduced by
$newResponseHandler is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
893
894
        if ($responseHandler instanceof ResponseHandlerInterface) {
895
            $newResponseHandler = $responseHandler;
896
        } else {
897
            $newResponseHandler = new ResponseHandlerBase();
898
        }
899
900
        return $newResponseHandler;
901
    }
902
}
903