Completed
Push — master ( 0fe829...fb702c )
by Dieter
08:08
created

Client::pnrCreatePnr()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 6
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 3
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_PricePnrWithLowerFares
528
     *
529
     * @param RequestOptions\FarePricePnrWithLowerFaresOptions $options
530
     * @param array $messageOptions (OPTIONAL)
531
     * @return Result
532
     */
533
    public function farePricePnrWithLowerFares(
534
        RequestOptions\FarePricePnrWithLowerFaresOptions $options,
535
        $messageOptions = []
536
    ) {
537
        $msgName = 'Fare_PricePNRWithLowerFares';
538
539
        return $this->callMessage($msgName, $options, $messageOptions);
540
    }
541
542
    /**
543
     * Fare_PricePnrWithLowestFare
544
     *
545
     * @param RequestOptions\FarePricePnrWithLowestFareOptions $options
546
     * @param array $messageOptions (OPTIONAL)
547
     * @return Result
548
     */
549
    public function farePricePnrWithLowestFare(
550
        RequestOptions\FarePricePnrWithLowestFareOptions $options,
551
        $messageOptions = []
552
    ) {
553
        $msgName = 'Fare_PricePNRWithLowestFare';
554
555
        return $this->callMessage($msgName, $options, $messageOptions);
556
    }
557
558
    /**
559
     * Fare_InformativePricingWithoutPNR
560
     *
561
     * @param RequestOptions\FareInformativePricingWithoutPnrOptions $options
562
     * @param array $messageOptions (OPTIONAL)
563
     * @return Result
564
     */
565
    public function fareInformativePricingWithoutPnr(
566
        RequestOptions\FareInformativePricingWithoutPnrOptions $options,
567
        $messageOptions = []
568
    ) {
569
        $msgName = 'Fare_InformativePricingWithoutPNR';
570
571
        return $this->callMessage($msgName, $options, $messageOptions);
572
    }
573
574
    /**
575
     * Fare_InformativeBestPricingWithoutPNR
576
     *
577
     * @param RequestOptions\FareInformativeBestPricingWithoutPnrOptions $options
578
     * @param array $messageOptions (OPTIONAL)
579
     * @return Result
580
     */
581
    public function fareInformativeBestPricingWithoutPnr(
582
        RequestOptions\FareInformativeBestPricingWithoutPnrOptions $options,
583
        $messageOptions = []
584
    ) {
585
        $msgName = 'Fare_InformativeBestPricingWithoutPNR';
586
587
        return $this->callMessage($msgName, $options, $messageOptions);
588
    }
589
590
    /**
591
     * Fare_CheckRules
592
     *
593
     * @param RequestOptions\FareCheckRulesOptions $options
594
     * @param array $messageOptions (OPTIONAL)
595
     * @return Result
596
     */
597
    public function fareCheckRules(RequestOptions\FareCheckRulesOptions $options, $messageOptions = [])
598
    {
599
        $msgName = 'Fare_CheckRules';
600
601
        return $this->callMessage($msgName, $options, $messageOptions);
602
    }
603
604
    /**
605
     * Fare_ConvertCurrency
606
     *
607
     * @param RequestOptions\FareConvertCurrencyOptions $options
608
     * @param array $messageOptions (OPTIONAL)
609
     * @return Result
610
     */
611
    public function fareConvertCurrency(RequestOptions\FareConvertCurrencyOptions $options, $messageOptions = [])
612
    {
613
        $msgName = 'Fare_ConvertCurrency';
614
615
        return $this->callMessage($msgName, $options, $messageOptions);
616
    }
617
618
    /**
619
     * Air_MultiAvailability
620
     *
621
     * @param RequestOptions\AirMultiAvailabilityOptions $options
622
     * @param array $messageOptions (OPTIONAL)
623
     * @return Result
624
     */
625
    public function airMultiAvailability(
626
        RequestOptions\AirMultiAvailabilityOptions $options,
627
        $messageOptions = []
628
    ) {
629
        $msgName = 'Air_MultiAvailability';
630
631
        return $this->callMessage($msgName, $options, $messageOptions);
632
    }
633
634
    /**
635
     * Air_SellFromRecommendation
636
     *
637
     * @param RequestOptions\AirSellFromRecommendationOptions $options
638
     * @param array $messageOptions (OPTIONAL)
639
     * @return Result
640
     */
641
    public function airSellFromRecommendation(
642
        RequestOptions\AirSellFromRecommendationOptions $options,
643
        $messageOptions = []
644
    ) {
645
        $msgName = 'Air_SellFromRecommendation';
646
647
        return $this->callMessage($msgName, $options, $messageOptions);
648
    }
649
650
    /**
651
     * Air_FlightInfo
652
     *
653
     * @param RequestOptions\AirFlightInfoOptions $options
654
     * @param array $messageOptions (OPTIONAL)
655
     * @return Result
656
     */
657
    public function airFlightInfo(RequestOptions\AirFlightInfoOptions $options, $messageOptions = [])
658
    {
659
        $msgName = 'Air_FlightInfo';
660
661
        return $this->callMessage($msgName, $options, $messageOptions);
662
    }
663
664
    /**
665
     * Air_RetrieveSeatMap
666
     *
667
     * @param RequestOptions\AirRetrieveSeatMapOptions $options
668
     * @param array $messageOptions (OPTIONAL)
669
     * @return Result
670
     */
671
    public function airRetrieveSeatMap(RequestOptions\AirRetrieveSeatMapOptions $options, $messageOptions = [])
672
    {
673
        $msgName = 'Air_RetrieveSeatMap';
674
675
        return $this->callMessage($msgName, $options, $messageOptions);
676
    }
677
678
    /**
679
     * Command_Cryptic
680
     *
681
     * @param RequestOptions\CommandCrypticOptions $options
682
     * @param array $messageOptions (OPTIONAL)
683
     * @return Result
684
     */
685
    public function commandCryptic(RequestOptions\CommandCrypticOptions $options, $messageOptions = [])
686
    {
687
        $msgName = 'Command_Cryptic';
688
689
        return $this->callMessage($msgName, $options, $messageOptions);
690
    }
691
692
    /**
693
     * MiniRule_GetFromPricingRec
694
     *
695
     * @param RequestOptions\MiniRuleGetFromPricingRecOptions $options
696
     * @param array $messageOptions (OPTIONAL)
697
     * @return Result
698
     */
699
    public function miniRuleGetFromPricingRec(
700
        RequestOptions\MiniRuleGetFromPricingRecOptions $options,
701
        $messageOptions = []
702
    ) {
703
        $msgName = 'MiniRule_GetFromPricingRec';
704
705
        return $this->callMessage($msgName, $options, $messageOptions);
706
    }
707
708
    /**
709
     * Info_EncodeDecodeCity
710
     *
711
     * @param RequestOptions\InfoEncodeDecodeCityOptions $options
712
     * @param array $messageOptions (OPTIONAL)
713
     * @return Result
714
     */
715
    public function infoEncodeDecodeCity(RequestOptions\InfoEncodeDecodeCityOptions $options, $messageOptions = [])
716
    {
717
        $msgName = 'Info_EncodeDecodeCity';
718
719
        return $this->callMessage($msgName, $options, $messageOptions);
720
    }
721
722
723
    /**
724
     * Ticket_CreateTSTFromPricing
725
     *
726
     * @param RequestOptions\TicketCreateTstFromPricingOptions $options
727
     * @param array $messageOptions (OPTIONAL)
728
     * @return Result
729
     */
730
    public function ticketCreateTSTFromPricing(
731
        RequestOptions\TicketCreateTstFromPricingOptions $options,
732
        $messageOptions = []
733
    ) {
734
        $msgName = 'Ticket_CreateTSTFromPricing';
735
736
        return $this->callMessage($msgName, $options, $messageOptions);
737
    }
738
739
    /**
740
     * Ticket_DeleteTST
741
     *
742
     * @param RequestOptions\TicketDeleteTstOptions $options
743
     * @param array $messageOptions (OPTIONAL)
744
     * @return Result
745
     */
746
    public function ticketDeleteTST(RequestOptions\TicketDeleteTstOptions $options, $messageOptions = [])
747
    {
748
        $msgName = 'Ticket_DeleteTST';
749
750
        return $this->callMessage($msgName, $options, $messageOptions);
751
    }
752
753
    /**
754
     * Ticket_DisplayTST
755
     *
756
     * @param RequestOptions\TicketDisplayTstOptions $options
757
     * @param array $messageOptions (OPTIONAL)
758
     * @return Result
759
     */
760
    public function ticketDisplayTST(RequestOptions\TicketDisplayTstOptions $options, $messageOptions = [])
761
    {
762
        $msgName = 'Ticket_DisplayTST';
763
764
        return $this->callMessage($msgName, $options, $messageOptions);
765
    }
766
767
    /**
768
     * DocIssuance_IssueTicket
769
     *
770
     * @param RequestOptions\DocIssuanceIssueTicketOptions $options
771
     * @param array $messageOptions (OPTIONAL)
772
     * @return Result
773
     */
774
    public function docIssuanceIssueTicket(
775
        RequestOptions\DocIssuanceIssueTicketOptions $options,
776
        $messageOptions = []
777
    ) {
778
        $msgName = 'DocIssuance_IssueTicket';
779
780
        return $this->callMessage($msgName, $options, $messageOptions);
781
    }
782
783
    /**
784
     * PriceXplorer_ExtremeSearch
785
     *
786
     * @param RequestOptions\PriceXplorerExtremeSearchOptions $options
787
     * @param array $messageOptions (OPTIONAL)
788
     * @return Result
789
     */
790
    public function priceXplorerExtremeSearch(
791
        RequestOptions\PriceXplorerExtremeSearchOptions $options,
792
        $messageOptions = []
793
    ) {
794
        $msgName = 'PriceXplorer_ExtremeSearch';
795
796
        return $this->callMessage($msgName, $options, $messageOptions);
797
    }
798
799
    /**
800
     * SalesReports_DisplayQueryReport
801
     *
802
     * @param RequestOptions\SalesReportsDisplayQueryReportOptions $options
803
     * @param array $messageOptions (OPTIONAL)
804
     * @return Result
805
     */
806
    public function salesReportsDisplayQueryReport(
807
        RequestOptions\SalesReportsDisplayQueryReportOptions $options,
808
        $messageOptions = []
809
    ) {
810
        $msgName = 'SalesReports_DisplayQueryReport';
811
812
        return $this->callMessage($msgName, $options, $messageOptions);
813
    }
814
815
    /**
816
     * Call a message with the given parameters
817
     *
818
     * @param string $messageName
819
     * @param RequestOptions\RequestOptionsInterface $options
820
     * @param array $messageOptions
821
     * @param bool $endSession
822
     * @return Result
823
     * @throws Client\Exception
824
     * @throws Client\Struct\InvalidArgumentException
825
     * @throws Client\InvalidMessageException
826
     * @throws Client\RequestCreator\MessageVersionUnsupportedException
827
     * @throws \RuntimeException
828
     * @throws \InvalidArgumentException
829
     * @throws \SoapFault
830
     */
831
    protected function callMessage($messageName, $options, $messageOptions, $endSession = false)
832
    {
833
        $messageOptions = $this->makeMessageOptions($messageOptions, $endSession);
834
835
        $this->lastMessage = $messageName;
836
837
        $sendResult = $this->sessionHandler->sendMessage(
838
            $messageName,
839
            $this->requestCreator->createRequest(
840
                $messageName,
841
                $options
842
            ),
843
            $messageOptions
844
        );
845
846
        return $this->responseHandler->analyzeResponse(
847
            $sendResult,
848
            $messageName
849
        );
850
    }
851
852
    /**
853
     * Make message options
854
     *
855
     * Message options are meta options when sending a message to the amadeus web services
856
     * - (if stateful) should we end the current session after sending this call?
857
     * - ... ?
858
     *
859
     * @param array $incoming The Message options chosen by the caller - if any.
860
     * @param bool $endSession Switch if you want to terminate the current session after making the call.
861
     * @return array
862
     */
863
    protected function makeMessageOptions(array $incoming, $endSession = false)
864
    {
865
        $options = [
866
            'endSession' => $endSession
867
        ];
868
869
        if (array_key_exists('endSession', $incoming)) {
870
            $options['endSession'] = $incoming['endSession'];
871
        }
872
873
        return $options;
874
    }
875
876
    /**
877
     * Load the session handler
878
     *
879
     * Either load the provided session handler or create one depending on incoming parameters.
880
     *
881
     * @param HandlerInterface|null $sessionHandler
882
     * @param Params\SessionHandlerParams $params
883
     * @return HandlerInterface
884
     */
885
    protected function loadSessionHandler($sessionHandler, $params)
886
    {
887
        $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...
888
889
        if ($sessionHandler instanceof HandlerInterface) {
890
            $newSessionHandler = $sessionHandler;
891
        } else {
892
            $newSessionHandler = HandlerFactory::createHandler($params);
893
        }
894
895
        return $newSessionHandler;
896
    }
897
898
    /**
899
     * Load a request creator
900
     *
901
     * A request creator is responsible for generating the correct request to send.
902
     *
903
     * @param RequestCreatorInterface|null $requestCreator
904
     * @param Params\RequestCreatorParams $params
905
     * @param string $libIdentifier Library identifier & version string (for Received From)
906
     * @param string $originatorOffice The Office we are signed in with.
907
     * @param array $mesVer Messages & Versions array of active messages in the WSDL
908
     * @return RequestCreatorInterface
909
     * @throws \RuntimeException
910
     */
911
    protected function loadRequestCreator($requestCreator, $params, $libIdentifier, $originatorOffice, $mesVer)
912
    {
913
        $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...
914
915
        if ($requestCreator instanceof RequestCreatorInterface) {
916
            $newRequestCreator = $requestCreator;
917
        } else {
918
            $params->originatorOfficeId = $originatorOffice;
919
            $params->messagesAndVersions = $mesVer;
920
921
            $newRequestCreator = RequestCreatorFactory::createRequestCreator(
922
                $params,
923
                $libIdentifier
924
            );
925
        }
926
927
        return $newRequestCreator;
928
    }
929
930
    /**
931
     * Load a response handler
932
     *
933
     * @param ResponseHandlerInterface|null $responseHandler
934
     *
935
     * @return ResponseHandlerInterface
936
     * @throws \RuntimeException
937
     */
938
    protected function loadResponseHandler($responseHandler)
939
    {
940
        $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...
941
942
        if ($responseHandler instanceof ResponseHandlerInterface) {
943
            $newResponseHandler = $responseHandler;
944
        } else {
945
            $newResponseHandler = new ResponseHandlerBase();
946
        }
947
948
        return $newResponseHandler;
949
    }
950
}
951