Mixpanel.html
61.1 KB
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
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title>API Documentation</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/prism.css" rel="stylesheet" media="all"/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="../js/html5.js"></script>
<![endif]-->
<script src="../js/jquery-1.11.0.min.js"></script>
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/jquery.smooth-scroll.js"></script>
<script src="../js/prism.min.js"></script>
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<link rel="shortcut icon" href="../images/favicon.ico"/>
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<i class="icon-ellipsis-vertical"></i>
</a>
<a class="brand" href="../index.html">API Documentation</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown" id="charts-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graphs/class.html">
<i class="icon-list-alt"></i> Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">16</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">0</span>
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i> Deprecated <span class="label label-info pull-right">0</span>
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<!--<div class="go_to_top">-->
<!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>-->
<!--</div>-->
</div>
<div id="___" class="container-fluid">
<section class="row-fluid">
<div class="span2 sidebar">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-873170912"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-873170912" class="accordion-body collapse in">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Base_MixpanelBase.html">Base_MixpanelBase</a></li>
<li class="class"><a href="../classes/ConsumerStrategies_AbstractConsumer.html">ConsumerStrategies_AbstractConsumer</a></li>
<li class="class"><a href="../classes/ConsumerStrategies_CurlConsumer.html">ConsumerStrategies_CurlConsumer</a></li>
<li class="class"><a href="../classes/ConsumerStrategies_FileConsumer.html">ConsumerStrategies_FileConsumer</a></li>
<li class="class"><a href="../classes/ConsumerStrategies_SocketConsumer.html">ConsumerStrategies_SocketConsumer</a></li>
<li class="class"><a href="../classes/Mixpanel.html">Mixpanel</a></li>
<li class="class"><a href="../classes/Producers_MixpanelBaseProducer.html">Producers_MixpanelBaseProducer</a></li>
<li class="class"><a href="../classes/Producers_MixpanelEvents.html">Producers_MixpanelEvents</a></li>
<li class="class"><a href="../classes/Producers_MixpanelPeople.html">Producers_MixpanelPeople</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\</small>Mixpanel</h1>
<p><em>This is the main class for the Mixpanel PHP Library which provides all of the methods you need to track events and
create/update profiles.</em></p>
<h2>Architecture</h2>
<p>This library is built such that all messages are buffered in an in-memory "queue"
The queue will be automatically flushed at the end of every request. Alternatively, you can call "flush()" manually
at any time. Flushed messages will be passed to a Consumer's "persist" method. The library comes with a handful of
Consumers. The "CurlConsumer" is used by default which will send the messages to Mixpanel using forked cURL processes.
You can implement your own custom Consumer to customize how a message is sent to Mixpanel. This can be useful when
you want to put messages onto a distributed queue (such as ActiveMQ or Kestrel) instead of writing to Mixpanel in
the user thread.</p>
<h2>Options</h2>
<table width="100%" cellpadding="5">
<tr>
<th>Option</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>max_queue_size</td>
<td>The maximum number of items to buffer in memory before flushing</td>
<td>1000</td>
</tr>
<tr>
<td>debug</td>
<td>Enable/disable debug mode</td>
<td>false</td>
</tr>
<tr>
<td>consumer</td>
<td>The consumer to use for writing messages</td>
<td>curl</td>
</tr>
<tr>
<td>consumers</td>
<td>An array of custom consumers in the format array(consumer_key => class_name)</td>
<td>null</td>
</tr>
<tr>
<td>host</td>
<td>The host name for api calls (used by some consumers)</td>
<td>api.mixpanel.com</td>
</tr>
<tr>
<td>events_endpoint</td>
<td>The endpoint for tracking events (relative to the host)</td>
<td>/events</td>
</tr>
<tr>
<td>people_endpoint</td>
<td>The endpoint for making people updates (relative to the host)</td>
<td>/engage</td>
</tr>
<tr>
<td>use_ssl</td>
<td>Tell the consumer whether or not to use ssl (when available)</td>
<td>true</td>
</tr>
<tr>
<td>error_callback</td>
<td>The name of a function to be called on consumption failures</td>
<td>null</td>
</tr>
<tr>
<td>connect_timeout</td>
<td>In both the SocketConsumer and CurlConsumer, this is used for the connection timeout (i.e. How long it has take to actually make a connection).
<td>5</td>
</tr>
<tr>
<td>timeout</td>
<td>In the CurlConsumer (non-forked), it is used to determine how long the cURL call has to execute.
<td>30</td>
</tr>
</table>
<h2>Example: Tracking an Event</h2>
<p>$mp = Mixpanel::getInstance("MY_TOKEN");</p>
<p>$mp->track("My Event");</p>
<h2>Example: Setting Profile Properties</h2>
<p>$mp = Mixpanel::getInstance("MY_TOKEN", array("use_ssl" => false));</p>
<p>$mp->people->set(12345, array(
'$first_name' => "John",
'$last_name' => "Doe",
'$email' => "john.doe@example.com",
'$phone' => "5555555555",
'Favorite Color' => "red"
));</p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span4">
<a href="#methods">Methods</a>
</section>
<section class="span4">
<a href="#properties">Properties</a>
</section>
<section class="span4">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span4">
<a href="../classes/Mixpanel.html#method___construct" class="">__construct()</a><br />
<a href="../classes/Mixpanel.html#method_getInstance" class="">getInstance()</a><br />
<a href="../classes/Mixpanel.html#method_enqueue" class="">enqueue()</a><br />
<a href="../classes/Mixpanel.html#method_enqueueAll" class="">enqueueAll()</a><br />
<a href="../classes/Mixpanel.html#method_flush" class="">flush()</a><br />
<a href="../classes/Mixpanel.html#method_reset" class="">reset()</a><br />
<a href="../classes/Mixpanel.html#method_identify" class="">identify()</a><br />
<a href="../classes/Mixpanel.html#method_track" class="">track()</a><br />
<a href="../classes/Mixpanel.html#method_register" class="">register()</a><br />
<a href="../classes/Mixpanel.html#method_registerAll" class="">registerAll()</a><br />
<a href="../classes/Mixpanel.html#method_registerOnce" class="">registerOnce()</a><br />
<a href="../classes/Mixpanel.html#method_registerAllOnce" class="">registerAllOnce()</a><br />
<a href="../classes/Mixpanel.html#method_unregister" class="">unregister()</a><br />
<a href="../classes/Mixpanel.html#method_unregisterAll" class="">unregisterAll()</a><br />
<a href="../classes/Mixpanel.html#method_getProperty" class="">getProperty()</a><br />
<a href="../classes/Mixpanel.html#method_createAlias" class="">createAlias()</a><br />
</section>
<section class="span4">
<a href="../classes/Mixpanel.html#property_people" class="">$people</a><br />
</section>
<section class="span4">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<a href="../classes/Base_MixpanelBase.html#method__log" class="">_log()</a><br />
<a href="../classes/Base_MixpanelBase.html#method__debug" class="">_debug()</a><br />
</section>
<section class="span4">
<a href="../classes/Base_MixpanelBase.html#property__options" class="">$_options</a><br />
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<em>No private methods found</em>
</section>
<section class="span4">
<a href="../classes/Base_MixpanelBase.html#property__defaults" class="">$_defaults</a><br />
<a href="../classes/Mixpanel.html#property__events" class="">$_events</a><br />
<a href="../classes/Mixpanel.html#property__instances" class="">$_instances</a><br />
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd><a href="../files/Mixpanel.html"><div class="path-wrapper">Mixpanel.php</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">Default</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper"><a href="../classes/Base_MixpanelBase.html">\Base_MixpanelBase</a></div>
<div class="namespace-wrapper">\Mixpanel</div>
</dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<a id="properties" name="properties"></a>
<div class="row-fluid">
<div class="span8 content class">
<h2>Properties</h2>
</div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_people" name="property_people" class="anchor"></a>
<article class="property">
<h3 class="public ">$people</h3>
<pre class="signature">$people : \Producers_MixpanelPeople</pre>
<p><em>An instance of the MixpanelPeople class (used to create/update profiles)</em></p>
<h4>Type</h4>
<a href="../classes/Producers_MixpanelPeople.html">\Producers_MixpanelPeople</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__options" name="property__options" class="anchor"></a>
<article class="property">
<h3 class="protected ">$_options</h3>
<pre class="signature">$_options : array</pre>
<p><em>An array of options to be used by the Mixpanel library.</em></p>
<h4>Type</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Base_MixpanelBase.html"><div class="path-wrapper">\Base_MixpanelBase</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__defaults" name="property__defaults" class="anchor"></a>
<article class="property">
<h3 class="private ">$_defaults</h3>
<pre class="signature">$_defaults : array</pre>
<p><em>Default options that can be overridden via the $options constructor arg</em></p>
<h4>Type</h4>
array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Base_MixpanelBase.html"><div class="path-wrapper">\Base_MixpanelBase</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__events" name="property__events" class="anchor"></a>
<article class="property">
<h3 class="private ">$_events</h3>
<pre class="signature">$_events : \Producers_MixpanelEvents</pre>
<p><em>An instance of the MixpanelEvents class</em></p>
<h4>Type</h4>
<a href="../classes/Producers_MixpanelEvents.html">\Producers_MixpanelEvents</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property__instances" name="property__instances" class="anchor"></a>
<article class="property">
<h3 class="private ">$_instances</h3>
<pre class="signature">$_instances : array<mixed,\Mixpanel></pre>
<p><em>Instances' list of the Mixpanel class (for singleton use, splitted by token)</em></p>
<h4>Type</h4>
array<mixed,<a href="../classes/Mixpanel.html">\Mixpanel</a>>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<a id="methods" name="methods"></a>
<div class="row-fluid">
<div class="span8 content class"><h2>Methods</h2></div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method___construct" name="method___construct" class="anchor"></a>
<article class="method">
<h3 class="public ">__construct()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">__construct( <span class="argument">$token</span>, array <span class="argument">$options = array()</span>) </pre>
<p><em>Instantiates a new Mixpanel instance.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$token </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$options </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getInstance" name="method_getInstance" class="anchor"></a>
<article class="method">
<h3 class="public ">getInstance()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getInstance( <span class="argument">$token</span>, array <span class="argument">$options = array()</span>) : \Mixpanel</pre>
<p><em>Returns a singleton instance of Mixpanel</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$token </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$options </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Mixpanel.html">\Mixpanel</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_enqueue" name="method_enqueue" class="anchor"></a>
<article class="method">
<h3 class="public ">enqueue()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">enqueue(array <span class="argument">$message = array()</span>) </pre>
<p><em>Add an array representing a message to be sent to Mixpanel to the in-memory queue.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$message </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_enqueueAll" name="method_enqueueAll" class="anchor"></a>
<article class="method">
<h3 class="public ">enqueueAll()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">enqueueAll(array <span class="argument">$messages = array()</span>) </pre>
<p><em>Add an array representing a list of messages to be sent to Mixpanel to a queue.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$messages </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_flush" name="method_flush" class="anchor"></a>
<article class="method">
<h3 class="public ">flush()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">flush(integer <span class="argument">$desired_batch_size = 50</span>) </pre>
<p><em>Flush the events queue</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>integer</td>
<td>$desired_batch_size </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_reset" name="method_reset" class="anchor"></a>
<article class="method">
<h3 class="public ">reset()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">reset() </pre>
<p><em>Empty the events queue</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_identify" name="method_identify" class="anchor"></a>
<article class="method">
<h3 class="public ">identify()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">identify(string|integer <span class="argument">$user_id</span>, [optional] string|integer <span class="argument">$anon_id</span>) </pre>
<p><em>Identify the user you want to associate to tracked events. The $anon_id must be UUID v4 format and not already merged to an $identified_id. All identify calls with a new and valid $anon_id will trigger a track $identify event, and merge to the $identified_id.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string|integer</td>
<td>$user_id </td>
<td></td>
</tr>
<tr>
<td>string|integer</td>
<td>$anon_id </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_track" name="method_track" class="anchor"></a>
<article class="method">
<h3 class="public ">track()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">track(string <span class="argument">$event</span>, array <span class="argument">$properties = array()</span>) </pre>
<p><em>Track an event defined by $event associated with metadata defined by $properties</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$event </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$properties </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_register" name="method_register" class="anchor"></a>
<article class="method">
<h3 class="public ">register()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">register(string <span class="argument">$property</span>, mixed <span class="argument">$value</span>) </pre>
<p><em>Register a property to be sent with every event.</em></p>
<p>If the property has already been registered, it will be
overwritten. NOTE: Registered properties are only persisted for the life of the Mixpanel class instance.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$property </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$value </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_registerAll" name="method_registerAll" class="anchor"></a>
<article class="method">
<h3 class="public ">registerAll()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">registerAll(array <span class="argument">$props_and_vals = array()</span>) </pre>
<p><em>Register multiple properties to be sent with every event.</em></p>
<p>If any of the properties have already been registered,
they will be overwritten. NOTE: Registered properties are only persisted for the life of the Mixpanel class
instance.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$props_and_vals </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_registerOnce" name="method_registerOnce" class="anchor"></a>
<article class="method">
<h3 class="public ">registerOnce()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">registerOnce( <span class="argument">$property</span>, <span class="argument">$value</span>) </pre>
<p><em>Register a property to be sent with every event.</em></p>
<p>If the property has already been registered, it will NOT be
overwritten. NOTE: Registered properties are only persisted for the life of the Mixpanel class instance.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$property </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$value </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_registerAllOnce" name="method_registerAllOnce" class="anchor"></a>
<article class="method">
<h3 class="public ">registerAllOnce()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">registerAllOnce(array <span class="argument">$props_and_vals = array()</span>) </pre>
<p><em>Register multiple properties to be sent with every event.</em></p>
<p>If any of the properties have already been registered,
they will NOT be overwritten. NOTE: Registered properties are only persisted for the life of the Mixpanel class
instance.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$props_and_vals </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_unregister" name="method_unregister" class="anchor"></a>
<article class="method">
<h3 class="public ">unregister()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">unregister(string <span class="argument">$property</span>) </pre>
<p><em>Un-register an property to be sent with every event.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$property </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_unregisterAll" name="method_unregisterAll" class="anchor"></a>
<article class="method">
<h3 class="public ">unregisterAll()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">unregisterAll(array <span class="argument">$properties</span>) </pre>
<p><em>Un-register a list of properties to be sent with every event.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$properties </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getProperty" name="method_getProperty" class="anchor"></a>
<article class="method">
<h3 class="public ">getProperty()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getProperty(string <span class="argument">$property</span>) : mixed</pre>
<p><em>Get a property that is set to be sent with every event</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$property </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
mixed
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_createAlias" name="method_createAlias" class="anchor"></a>
<article class="method">
<h3 class="public ">createAlias()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">createAlias(string|integer <span class="argument">$distinct_id</span>, string|integer <span class="argument">$alias</span>) </pre>
<p><em>An alias to be merged with the distinct_id. Each alias can only map to one distinct_id. This is helpful when you want to associate a generated id (such as a session id) to a user id or username.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string|integer</td>
<td>$distinct_id </td>
<td></td>
</tr>
<tr>
<td>string|integer</td>
<td>$alias </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method__log" name="method__log" class="anchor"></a>
<article class="method">
<h3 class="protected ">_log()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">_log( <span class="argument">$msg</span>) </pre>
<p><em>Log a message to PHP's error log</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$msg </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Base_MixpanelBase.html"><div class="path-wrapper">\Base_MixpanelBase</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method__debug" name="method__debug" class="anchor"></a>
<article class="method">
<h3 class="protected ">_debug()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">_debug() : boolean</pre>
<p><em>Returns true if in debug mode, false if in production mode</em></p>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/Base_MixpanelBase.html"><div class="path-wrapper">\Base_MixpanelBase</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
</div>
</section>
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h3 id="source-view-label">Mixpanel.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/Mixpanel.php.txt" class="language-php line-numbers"></pre>
</div>
</div>
<footer class="row-fluid">
<section class="span10 offset2">
<section class="row-fluid">
<section class="span10 offset1">
<section class="row-fluid footer-sections">
<section class="span4">
<h1><i class="icon-code"></i></h1>
<div>
<ul>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-bar-chart"></i></h1>
<div>
<ul>
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-pushpin"></i></h1>
<div>
<ul>
<li><a href="../reports/errors.html">Errors</a></li>
<li><a href="../reports/markers.html">Markers</a></li>
</ul>
</div>
</section>
</section>
</section>
</section>
<section class="row-fluid">
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on July 8th, 2019 at 22:37.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>