-
Notifications
You must be signed in to change notification settings - Fork 134
/
Analytics.php
865 lines (788 loc) · 32.9 KB
/
Analytics.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
<?php
namespace TheIconic\Tracking\GoogleAnalytics;
use TheIconic\Tracking\GoogleAnalytics\Parameters\SingleParameter;
use TheIconic\Tracking\GoogleAnalytics\Parameters\CompoundParameterCollection;
use TheIconic\Tracking\GoogleAnalytics\Network\HttpClient;
use TheIconic\Tracking\GoogleAnalytics\Network\PrepareUrl;
use TheIconic\Tracking\GoogleAnalytics\Exception\InvalidPayloadDataException;
/**
* Class Analytics
*
* The main interface for the clients, it relies heavily in magic methods exposing
* an interface with method tags.
*
* ==== GETTERS ====
* General
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProtocolVersion($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setTrackingId($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setAnonymizeIp($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setDataSource($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setQueueTime($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCacheBuster($value)
*
* User
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setClientId($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setUserId($value)
*
* Session
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setSessionControl($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setIpOverride($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setUserAgentOverride($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setGeographicalOverride($value)
*
* Traffic Sources
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setDocumentReferrer($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCampaignName($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCampaignSource($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCampaignMedium($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCampaignKeyword($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCampaignContent($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCampaignId($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setGoogleAdwordsId($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setGoogleDisplayAdsId($value)
*
* System Info
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setScreenResolution($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setViewportSize($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setDocumentEncoding($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setScreenColors($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setUserLanguage($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setJavaEnabled($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setFlashVersion($value)
*
* Hit
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setHitType($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setNonInteractionHit($value)
* @method \TheIconic\Tracking\GoogleAnalytics\AnalyticsResponse sendPageview()
* @method \TheIconic\Tracking\GoogleAnalytics\AnalyticsResponse sendEvent()
* @method \TheIconic\Tracking\GoogleAnalytics\AnalyticsResponse sendScreenview()
* @method \TheIconic\Tracking\GoogleAnalytics\AnalyticsResponse sendTransaction()
* @method \TheIconic\Tracking\GoogleAnalytics\AnalyticsResponse sendItem()
* @method \TheIconic\Tracking\GoogleAnalytics\AnalyticsResponse sendSocial()
* @method \TheIconic\Tracking\GoogleAnalytics\AnalyticsResponse sendException()
* @method \TheIconic\Tracking\GoogleAnalytics\AnalyticsResponse sendTiming()
*
* Content Information
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setDocumentLocationUrl($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setDocumentHostName($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setDocumentPath($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setDocumentTitle($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setScreenName($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setLinkId($value)
*
* App Tracking
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setApplicationName($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setApplicationId($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setApplicationVersion($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setApplicationInstallerId($value)
*
* Event Tracking
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setEventCategory($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setEventAction($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setEventLabel($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setEventValue($value)
*
* E-commerce
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setItemName($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setItemPrice($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setItemQuantity($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setItemCode($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setItemCategory($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCurrencyCode($value)
*
* Enhanced E-Commerce
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setTransactionId($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setAffiliation($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setRevenue($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setTax($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setShipping($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCouponCode($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProductActionList($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCheckoutStep($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCheckoutStepOption($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics addProduct(array $productData)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProductAction($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProductActionToDetail()
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProductActionToClick()
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProductActionToAdd()
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProductActionToRemove()
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProductActionToCheckout()
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProductActionToCheckoutOption()
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProductActionToPurchase()
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProductActionToRefund()
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setProductImpressionListName($value, $index)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics addProductImpression(array $productData, $index)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics addPromotion(array $promotionData)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setPromotionAction($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setPromotionActionToClick()
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setPromotionActionToView()
*
* Social Interactions
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setSocialNetwork($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setSocialAction($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setSocialActionTarget($value)
*
* Timing
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setUserTimingCategory($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setUserTimingVariableName($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setUserTimingTime($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setUserTimingLabel($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setPageLoadTime($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setDnsTime($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setPageDownloadTime($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setRedirectResponseTime($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setTcpConnectTime($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setServerResponseTime($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setDomInteractiveTime($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setContentLoadTime($value)
*
* Exceptions
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setExceptionDescription($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setIsExceptionFatal($value)
*
* Custom Dimension / Metrics
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCustomDimension($value, $index)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setCustomMetric($value, $index)
*
* Content Grouping
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setContentGroup($value, $index)
*
* Content Experiments
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setExperimentId($value)
* @method \TheIconic\Tracking\GoogleAnalytics\Analytics setExperimentVariant($value)
*
* ==== SETTERS ====
* General
* @method string|int|null getProtocolVersion()
* @method string|int|null getTrackingId()
* @method string|int|null getAnonymizeIp()
* @method string|int|null getDataSource()
* @method string|int|null getQueueTime()
* @method string|int|null getCacheBuster()
*
* User
* @method string|int|null getClientId()
* @method string|int|null getUserId()
*
* Session
* @method string|int|null getSessionControl()
* @method string|int|null getIpOverride()
* @method string|int|null getUserAgentOverride()
* @method string|int|null getGeographicalOverride()
*
* Traffic Sources
* @method string|int|null getDocumentReferrer()
* @method string|int|null getCampaignName()
* @method string|int|null getCampaignSource()
* @method string|int|null getCampaignMedium()
* @method string|int|null getCampaignKeyword()
* @method string|int|null getCampaignContent()
* @method string|int|null getCampaignId()
* @method string|int|null getGoogleAdwordsId()
* @method string|int|null getGoogleDisplayAdsId()
*
* System Info
* @method string|int|null getScreenResolution()
* @method string|int|null getViewportSize()
* @method string|int|null getDocumentEncoding()
* @method string|int|null getScreenColors()
* @method string|int|null getUserLanguage()
* @method string|int|null getJavaEnabled()
* @method string|int|null getFlashVersion()
*
* Hit
* @method string|int|null getHitType()
* @method string|int|null getNonInteractionHit()
*
* Content Information
* @method string|int|null getDocumentLocationUrl()
* @method string|int|null getDocumentHostName()
* @method string|int|null getDocumentPath()
* @method string|int|null getDocumentTitle()
* @method string|int|null getScreenName()
* @method string|int|null getLinkId()
*
* App Tracking
* @method string|int|null getApplicationName()
* @method string|int|null getApplicationId()
* @method string|int|null getApplicationVersion()
* @method string|int|null getApplicationInstallerId()
*
* Event Tracking
* @method string|int|null getEventCategory()
* @method string|int|null getEventAction()
* @method string|int|null getEventLabel()
* @method string|int|null getEventValue()
*
* E-commerce
* @method string|int|null getItemName()
* @method string|int|null getItemPrice()
* @method string|int|null getItemQuantity()
* @method string|int|null getItemCode()
* @method string|int|null getItemCategory()
* @method string|int|null getCurrencyCode()
*
* Enhanced E-Commerce
* @method string|int|null getTransactionId()
* @method string|int|null getAffiliation()
* @method string|int|null getRevenue()
* @method string|int|null getTax()
* @method string|int|null getShipping()
* @method string|int|null getCouponCode()
* @method string|int|null getProductActionList()
* @method string|int|null getCheckoutStep()
* @method string|int|null getCheckoutStepOption()
* @method string|int|null getProduct()
* @method string|int|null getProductAction()
* @method string|int|null getProductActionToDetail()
* @method string|int|null getProductActionToClick()
* @method string|int|null getProductActionToAdd()
* @method string|int|null getProductActionToRemove()
* @method string|int|null getProductActionToCheckout()
* @method string|int|null getProductActionToCheckoutOption()
* @method string|int|null getProductActionToPurchase()
* @method string|int|null getProductActionToRefund()
* @method string|int|null getProductImpressionListName($index)
* @method string|int|null getProductImpression($listIndex)
* @method string|int|null getPromotion()
* @method string|int|null getPromotionAction()
* @method string|int|null getPromotionActionToClick()
* @method string|int|null getPromotionActionToView()
*
* Social Interactions
* @method string|int|null getSocialNetwork()
* @method string|int|null getSocialAction()
* @method string|int|null getSocialActionTarget()
*
* Timing
* @method string|int|null getUserTimingCategory()
* @method string|int|null getUserTimingVariableName()
* @method string|int|null getUserTimingTime()
* @method string|int|null getUserTimingLabel()
* @method string|int|null getPageLoadTime()
* @method string|int|null getDnsTime()
* @method string|int|null getPageDownloadTime()
* @method string|int|null getRedirectResponseTime()
* @method string|int|null getTcpConnectTime()
* @method string|int|null getServerResponseTime()
* @method string|int|null getDomInteractiveTime()
* @method string|int|null getContentLoadTime()
*
* Exceptions
* @method string|int|null getExceptionDescription()
* @method string|int|null getIsExceptionFatal()
*
* Custom Dimension / Metrics
* @method string|int|null getCustomDimension($index)
* @method string|int|null getCustomMetric($index)
*
* Content Grouping
* @method string|int|null getContentGroup($index)
*
* Content Experiments
* @method string|int|null getExperimentId()
* @method string|int|null getExperimentVariant()
*
* @package TheIconic\Tracking\GoogleAnalytics
*/
class Analytics
{
/**
* URI scheme for the GA API.
*
* @var string
*/
private $uriScheme = 'http';
/**
* Indicates if the request to GA will be asynchronous (non-blocking).
*
* @var boolean
*/
private $isAsyncRequest = false;
/**
* Endpoint to connect to when sending data to GA.
*
* @var string
*/
private $endpoint = '://www.google-analytics.com/collect';
/**
* Endpoint to connect to when validating hits.
* @link https://developers.google.com/analytics/devguides/collection/protocol/v1/validating-hits
*
* @var string
*/
private $debugEndpoint = '://www.google-analytics.com/debug/collect';
/**
* Indicates if the request is in debug mode(validating hits).
*
* @var boolean
*/
private $isDebug = false;
/**
* Holds the single parameters added to the hit.
*
* @var SingleParameter[]
*/
private $singleParameters = [];
/**
* Holds the compound parameters collections added to the hit.
*
* @var CompoundParameterCollection[]
*/
private $compoundParametersCollections = [];
/**
* Holds the HTTP client used to connect to GA.
*
* @var HttpClient
*/
private $httpClient;
/**
* Initializes to a list of all the available parameters to be sent in a hit.
*
* @var array
*/
private $availableParameters = [
'ApplicationId' => 'AppTracking\\ApplicationId',
'ApplicationInstallerId' => 'AppTracking\\ApplicationInstallerId',
'ApplicationName' => 'AppTracking\\ApplicationName',
'ApplicationVersion' => 'AppTracking\\ApplicationVersion',
'ExperimentId' => 'ContentExperiments\\ExperimentId',
'ExperimentVariant' => 'ContentExperiments\\ExperimentVariant',
'ContentGroup' => 'ContentGrouping\\ContentGroup',
'DocumentHostName' => 'ContentInformation\\DocumentHostName',
'DocumentLocationUrl' => 'ContentInformation\\DocumentLocationUrl',
'DocumentPath' => 'ContentInformation\\DocumentPath',
'DocumentTitle' => 'ContentInformation\\DocumentTitle',
'LinkId' => 'ContentInformation\\LinkId',
'ScreenName' => 'ContentInformation\\ScreenName',
'CustomDimension' => 'CustomDimensionsMetrics\\CustomDimension',
'CustomMetric' => 'CustomDimensionsMetrics\\CustomMetric',
'CurrencyCode' => 'Ecommerce\\CurrencyCode',
'ItemCategory' => 'Ecommerce\\ItemCategory',
'ItemCode' => 'Ecommerce\\ItemCode',
'ItemName' => 'Ecommerce\\ItemName',
'ItemPrice' => 'Ecommerce\\ItemPrice',
'ItemQuantity' => 'Ecommerce\\ItemQuantity',
'Affiliation' => 'EnhancedEcommerce\\Affiliation',
'CheckoutStep' => 'EnhancedEcommerce\\CheckoutStep',
'CheckoutStepOption' => 'EnhancedEcommerce\\CheckoutStepOption',
'CouponCode' => 'EnhancedEcommerce\\CouponCode',
'Product' => 'EnhancedEcommerce\\Product',
'ProductAction' => 'EnhancedEcommerce\\ProductAction',
'ProductActionList' => 'EnhancedEcommerce\\ProductActionList',
'ProductCollection' => 'EnhancedEcommerce\\ProductCollection',
'ProductImpression' => 'EnhancedEcommerce\\ProductImpression',
'ProductImpressionCollection' => 'EnhancedEcommerce\\ProductImpressionCollection',
'ProductImpressionListName' => 'EnhancedEcommerce\\ProductImpressionListName',
'Promotion' => 'EnhancedEcommerce\\Promotion',
'PromotionAction' => 'EnhancedEcommerce\\PromotionAction',
'PromotionCollection' => 'EnhancedEcommerce\\PromotionCollection',
'Revenue' => 'EnhancedEcommerce\\Revenue',
'Shipping' => 'EnhancedEcommerce\\Shipping',
'Tax' => 'EnhancedEcommerce\\Tax',
'TransactionId' => 'EnhancedEcommerce\\TransactionId',
'EventAction' => 'Event\\EventAction',
'EventCategory' => 'Event\\EventCategory',
'EventLabel' => 'Event\\EventLabel',
'EventValue' => 'Event\\EventValue',
'ExceptionDescription' => 'Exceptions\\ExceptionDescription',
'IsExceptionFatal' => 'Exceptions\\IsExceptionFatal',
'AnonymizeIp' => 'General\\AnonymizeIp',
'CacheBuster' => 'General\\CacheBuster',
'DataSource' => 'General\\DataSource',
'ProtocolVersion' => 'General\\ProtocolVersion',
'QueueTime' => 'General\\QueueTime',
'TrackingId' => 'General\\TrackingId',
'HitType' => 'Hit\\HitType',
'NonInteractionHit' => 'Hit\\NonInteractionHit',
'GeographicalOverride' => 'Session\\GeographicalOverride',
'IpOverride' => 'Session\\IpOverride',
'SessionControl' => 'Session\\SessionControl',
'UserAgentOverride' => 'Session\\UserAgentOverride',
'SocialAction' => 'SocialInteractions\\SocialAction',
'SocialActionTarget' => 'SocialInteractions\\SocialActionTarget',
'SocialNetwork' => 'SocialInteractions\\SocialNetwork',
'DocumentEncoding' => 'SystemInfo\\DocumentEncoding',
'FlashVersion' => 'SystemInfo\\FlashVersion',
'JavaEnabled' => 'SystemInfo\\JavaEnabled',
'ScreenColors' => 'SystemInfo\\ScreenColors',
'ScreenResolution' => 'SystemInfo\\ScreenResolution',
'UserLanguage' => 'SystemInfo\\UserLanguage',
'ViewportSize' => 'SystemInfo\\ViewportSize',
'ContentLoadTime' => 'Timing\\ContentLoadTime',
'DnsTime' => 'Timing\\DnsTime',
'DomInteractiveTime' => 'Timing\\DomInteractiveTime',
'PageDownloadTime' => 'Timing\\PageDownloadTime',
'PageLoadTime' => 'Timing\\PageLoadTime',
'RedirectResponseTime' => 'Timing\\RedirectResponseTime',
'ServerResponseTime' => 'Timing\\ServerResponseTime',
'TcpConnectTime' => 'Timing\\TcpConnectTime',
'UserTimingCategory' => 'Timing\\UserTimingCategory',
'UserTimingLabel' => 'Timing\\UserTimingLabel',
'UserTimingTime' => 'Timing\\UserTimingTime',
'UserTimingVariableName' => 'Timing\\UserTimingVariableName',
'CampaignContent' => 'TrafficSources\\CampaignContent',
'CampaignId' => 'TrafficSources\\CampaignId',
'CampaignKeyword' => 'TrafficSources\\CampaignKeyword',
'CampaignMedium' => 'TrafficSources\\CampaignMedium',
'CampaignName' => 'TrafficSources\\CampaignName',
'CampaignSource' => 'TrafficSources\\CampaignSource',
'DocumentReferrer' => 'TrafficSources\\DocumentReferrer',
'GoogleAdwordsId' => 'TrafficSources\\GoogleAdwordsId',
'GoogleDisplayAdsId' => 'TrafficSources\\GoogleDisplayAdsId',
'ClientId' => 'User\\ClientId',
'UserId' => 'User\\UserId',
];
/**
* When passed with an argument of TRUE, it will send the hit using HTTPS instead of plain HTTP.
* It parses the available parameters.
*
* @param bool $isSsl
* @throws \InvalidArgumentException
*/
public function __construct($isSsl = false)
{
if (!is_bool($isSsl)) {
throw new \InvalidArgumentException('First constructor argument "isSSL" must be boolean');
}
if ($isSsl) {
$this->uriScheme .= 's';
$this->endpoint = str_replace('www', 'ssl', $this->endpoint);
}
}
/**
* Sets a request to be either synchronous or asynchronous (non-blocking).
*
* @api
* @param boolean $isAsyncRequest
* @return $this
*/
public function setAsyncRequest($isAsyncRequest)
{
$this->isAsyncRequest = $isAsyncRequest;
return $this;
}
/**
* Makes the request to GA asynchronous (non-blocking).
*
* @deprecated Use setAsyncRequest(boolean $isAsyncRequest) instead. To be removed in next major version.
*
* @return $this
*/
public function makeNonBlocking()
{
$this->isAsyncRequest = true;
return $this;
}
/**
* Sets the HttpClient.
*
* @internal
* @param HttpClient $httpClient
* @return $this
*/
public function setHttpClient(HttpClient $httpClient)
{
$this->httpClient = $httpClient;
return $this;
}
/**
* Gets the HttpClient.
*
* @return HttpClient
*/
private function getHttpClient()
{
if ($this->httpClient === null) {
// @codeCoverageIgnoreStart
$this->setHttpClient(new HttpClient());
}
// @codeCoverageIgnoreEnd
return $this->httpClient;
}
/**
* Gets the full endpoint to GA.
*
* @return string
*/
private function getEndpoint()
{
return ($this->isDebug) ? $this->uriScheme . $this->debugEndpoint : $this->uriScheme . $this->endpoint;
}
/**
* Sets debug mode to true or false.
*
* @api
* @param bool $value
* @return \TheIconic\Tracking\GoogleAnalytics\Analytics
*/
public function setDebug($value)
{
$this->isDebug = $value;
return $this;
}
/**
* Sends a hit to GA. The hit will contain in the payload all the parameters added before.
*
* @param $methodName
* @return AnalyticsResponse
* @throws Exception\InvalidPayloadDataException
*/
private function sendHit($methodName)
{
$hitType = strtoupper(substr($methodName, 4));
$hitConstant = $this->getParameterClassConstant(
'TheIconic\Tracking\GoogleAnalytics\Parameters\Hit\HitType::HIT_TYPE_' . $hitType,
'Hit type ' . $hitType . ' is not defined, check spelling'
);
$this->setHitType($hitConstant);
if (!$this->hasMinimumRequiredParameters()) {
throw new InvalidPayloadDataException();
}
return $this->getHttpClient()->post(
$this->getUrl(),
$this->isAsyncRequest
);
}
/**
* Build and returns URL used to send to Google Analytics.
*
* @api
* @return string
*/
public function getUrl()
{
$prepareUrl = new PrepareUrl;
return $prepareUrl->build(
$this->getEndpoint(),
$this->singleParameters,
$this->compoundParametersCollections
);
}
/**
* Validates the minimum required parameters for every GA hit are being sent.
*
* @SuppressWarnings(PHPMD.LongVariable)
*
* @return bool
*/
private function hasMinimumRequiredParameters()
{
$minimumRequiredParameters = [
'v' => false,
'tid' => false,
'cid' => false,
't' => false,
];
foreach ($minimumRequiredParameters as $parameterName => $isParamPresent) {
if (in_array($parameterName, array_keys($this->singleParameters))) {
$minimumRequiredParameters[$parameterName] = true;
}
}
return !in_array(false, $minimumRequiredParameters, true);
}
/**
* Sets a parameter action to the value specified by the method call.
*
* @param $parameter
* @param $action
* @return $this
*/
private function setParameterActionTo($parameter, $action)
{
$actionConstant = $this->getParameterClassConstant(
'TheIconic\Tracking\GoogleAnalytics\Parameters\EnhancedEcommerce\\'
. $parameter . 'Action::ACTION_' . strtoupper($action),
$parameter . ' action ' . $action . ' does not exist, check spelling'
);
$function = 'set' . $parameter . 'Action';
$this->$function($actionConstant);
return $this;
}
/**
* Gets a contant from a class dynamically.
*
* @param $constant
* @param $exceptionMsg
* @return mixed
* @throws \BadMethodCallException
*/
private function getParameterClassConstant($constant, $exceptionMsg)
{
if (defined($constant)) {
return constant($constant);
} else {
throw new \BadMethodCallException($exceptionMsg);
}
}
/**
* Sets the value for a parameter.
*
* @param $methodName
* @param array $methodArguments
* @return $this
* @throws \InvalidArgumentException
*/
private function setParameter($methodName, array $methodArguments)
{
$parameterClass = substr($methodName, 3);
$fullParameterClass = $this->getFullParameterClass($parameterClass, $methodName);
$parameterIndex = $this->getIndexFromArguments($methodArguments);
/** @var SingleParameter $parameterObject */
$parameterObject = new $fullParameterClass($parameterIndex);
if (!isset($methodArguments[0])) {
throw new \InvalidArgumentException(
'For Analytics object, you must specify a value to be set for ' . $methodName
);
} else {
$parameterObject->setValue($methodArguments[0]);
}
$this->singleParameters[$parameterObject->getName()] = $parameterObject;
return $this;
}
/**
* Adds an item to a compund parameter collection.
*
* @SuppressWarnings(PHPMD.LongVariable)
*
* @param $methodName
* @param array $methodArguments
* @return $this
* @throws \InvalidArgumentException
*/
private function addItem($methodName, array $methodArguments)
{
$parameterClass = substr($methodName, 3);
$fullParameterClass = $this->getFullParameterClass($parameterClass, $methodName);
if (!isset($methodArguments[0])) {
throw new \InvalidArgumentException(
'You must specify a ' . $parameterClass . ' to be add for ' . $methodName
);
} else {
$parameterObject = new $fullParameterClass($methodArguments[0]);
}
$collectionIndex = $this->getIndexFromArguments($methodArguments);
if (isset($this->compoundParametersCollections[$parameterClass . $collectionIndex])) {
$this->compoundParametersCollections[$parameterClass . $collectionIndex]->add($parameterObject);
} else {
$fullParameterCollectionClass = $fullParameterClass . 'Collection';
/** @var CompoundParameterCollection $parameterObjectCollection */
$parameterObjectCollection = new $fullParameterCollectionClass($collectionIndex);
$parameterObjectCollection->add($parameterObject);
$this->compoundParametersCollections[$parameterClass . $collectionIndex] = $parameterObjectCollection;
}
return $this;
}
/**
* Gets the value for a parameter.
*
* @SuppressWarnings(PHPMD.LongVariable)
*
* @param $methodName
* @param array $methodArguments
* @return string
* @throws \InvalidArgumentException
*/
private function getParameter($methodName, array $methodArguments)
{
$parameterClass = substr($methodName, 3);
$fullParameterClass = $this->getFullParameterClass($parameterClass, $methodName);
// Handle index arguments
$parameterIndex = '';
if (isset($methodArguments[0]) && is_numeric($methodArguments[0])) {
$parameterIndex = $methodArguments[0];
}
// Handle compoundParametersCollections
if (isset($this->compoundParametersCollections[$parameterClass . $parameterIndex])) {
// If compoundParametersCollections contains our Objects, return them well-formatted
return $this->compoundParametersCollections[$parameterClass . $parameterIndex]->getReadableItems();
} else {
$fullParameterCollectionClass = $fullParameterClass . 'Collection';
// Test if the class Collection exist
if (class_exists($fullParameterCollectionClass)) {
return null;
}
// If not, it's a SingleParameter Object, continue the magic
}
/** @var SingleParameter $parameterObject */
$parameterObject = new $fullParameterClass($parameterIndex);
if (!array_key_exists($parameterObject->getName(), $this->singleParameters)) {
return null;
}
$currentParameterObject = $this->singleParameters[$parameterObject->getName()];
return $currentParameterObject->getValue();
}
/**
* Gets the index value from the arguments.
*
* @param $methodArguments
* @return string
*/
private function getIndexFromArguments($methodArguments)
{
$index = '';
if (isset($methodArguments[1]) && is_numeric($methodArguments[1])) {
$index = $methodArguments[1];
}
return $index;
}
/**
* Gets the fully qualified name for a parameter.
*
* @param $parameterClass
* @param $methodName
* @return string
* @throws \BadMethodCallException
*/
private function getFullParameterClass($parameterClass, $methodName)
{
if (empty($this->availableParameters[$parameterClass])) {
throw new \BadMethodCallException('Method ' . $methodName . ' not defined for Analytics class');
} else {
return '\\TheIconic\\Tracking\\GoogleAnalytics\\Parameters\\' . $this->availableParameters[$parameterClass];
}
}
/**
* Routes the method call to the adequate private method.
*
* @param $methodName
* @param array $methodArguments
* @return mixed
* @throws \BadMethodCallException
*/
public function __call($methodName, array $methodArguments)
{
$methodName = $this->fixTypos($methodName);
if (preg_match('/^set(Product|Promotion)ActionTo(\w+)/', $methodName, $matches)) {
return $this->setParameterActionTo($matches[1], $matches[2]);
}
if (preg_match('/^(set)(\w+)/', $methodName, $matches)) {
return $this->setParameter($methodName, $methodArguments);
}
if (preg_match('/^(add)(\w+)/', $methodName, $matches)) {
return $this->addItem($methodName, $methodArguments);
}
if (preg_match('/^(send)(\w+)/', $methodName, $matches)) {
return $this->sendHit($methodName);
}
// Get Parameters
if (preg_match('/^(get)(\w+)/', $methodName, $matches)) {
return $this->getParameter($methodName, $methodArguments);
}
throw new \BadMethodCallException('Method ' . $methodName . ' not defined for Analytics class');
}
/**
* Fix typos that went into releases, this way we ensure we don't break scripts in production.
*
* @param string $methodName
* @return string
*/
private function fixTypos($methodName)
{
// @TODO deprecated in v2, to be removed in v3
if ($methodName === 'setUserTiminCategory') {
$methodName = 'setUserTimingCategory';
}
return $methodName;
}
}