forked from notmyname/php-cloudfiles
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCF_Object.html
More file actions
1094 lines (997 loc) · 51 KB
/
CF_Object.html
File metadata and controls
1094 lines (997 loc) · 51 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
<html>
<head>
<title>Docs For Class CF_Object</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">php-cloudfiles</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_php-cloudfiles.html" class="menu">class tree: php-cloudfiles</a> ]
[ <a href="../elementindex_php-cloudfiles.html" class="menu">index: php-cloudfiles</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="ric">
<p><a href="../ric_README.html">README</a></p>
<p><a href="../ric_Changelog.html">Changelog</a></p>
<p><a href="../ric_AUTHORS.html">AUTHORS</a></p>
<p><a href="../ric_COPYING.html">COPYING</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_php-cloudfiles.html">php-cloudfiles</a><br />
<a href="../li_php-cloudfiles-exceptions.html">php-cloudfiles-exceptions</a><br />
<a href="../li_php-cloudfiles-http.html">php-cloudfiles-http</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="../php-cloudfiles/_cloudfiles.php.html"> cloudfiles.php
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../php-cloudfiles/CF_Authentication.html">CF_Authentication</a><br />
<a href="../php-cloudfiles/CF_Connection.html">CF_Connection</a><br />
<a href="../php-cloudfiles/CF_Container.html">CF_Container</a><br />
<a href="../php-cloudfiles/CF_Object.html">CF_Object</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<h1>Class: CF_Object</h1>
Source Location: /cloudfiles.php<br /><br />
<table width="100%" border="0">
<tr><td valign="top">
<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">Object operations</div><br /><br />
</td>
<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
<li><a href="../php-cloudfiles/CF_Object.html#var$container">$container</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#var$content_length">$content_length</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#var$content_type">$content_type</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#var$headers">$headers</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#var$last_modified">$last_modified</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#var$manifest">$manifest</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#var$metadata">$metadata</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#var$name">$name</a></li>
</ul>
</td>
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../php-cloudfiles/CF_Object.html#method__construct">__construct</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodcompute_md5sum">compute_md5sum</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodgetETag">getETag</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodload_from_filename">load_from_filename</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodpublic_ssl_uri">public_ssl_uri</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodpublic_streaming_uri">public_streaming_uri</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodpublic_uri">public_uri</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodpurge_from_cdn">purge_from_cdn</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodread">read</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodsave_to_filename">save_to_filename</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodset_etag">set_etag</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodstream">stream</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodsync_manifest">sync_manifest</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodsync_metadata">sync_metadata</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#methodwrite">write</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#method_guess_content_type">_guess_content_type</a></li>
<li><a href="../php-cloudfiles/CF_Object.html#method__toString">__toString</a></li>
</ul>
</td>
</tr></table>
<hr />
<table width="100%" border="0"><tr>
</tr></table>
<hr />
<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 1883]<br />
Object operations<br /><br /><p>An Object is analogous to a file on a conventional filesystem. You can read data from, or write data to your Objects. You can also associate arbitrary metadata with them.</p><br /></div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
<a name="var$container"></a>
<p></p>
<h4>$container = <span class="value"></span></h4>
<p>[line 1885]</p>
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$content_length"></a>
<p></p>
<h4>$content_length = <span class="value"></span></h4>
<p>[line 1889]</p>
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$content_type"></a>
<p></p>
<h4>$content_type = <span class="value"></span></h4>
<p>[line 1888]</p>
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$headers"></a>
<p></p>
<h4>$headers = <span class="value"></span></h4>
<p>[line 1891]</p>
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$last_modified"></a>
<p></p>
<h4>$last_modified = <span class="value"></span></h4>
<p>[line 1887]</p>
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$manifest"></a>
<p></p>
<h4>$manifest = <span class="value"></span></h4>
<p>[line 1892]</p>
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$metadata"></a>
<p></p>
<h4>$metadata = <span class="value"></span></h4>
<p>[line 1890]</p>
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$name"></a>
<p></p>
<h4>$name = <span class="value"></span></h4>
<p>[line 1886]</p>
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />
<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
<hr />
<a name="method__construct"></a>
<h3>constructor __construct <span class="smalllinenumber">[line 1902]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>CF_Object __construct(
&$container, string
$name, [boolean
$force_exists = False], [
$dohead = True], obj
$container)</code>
</td></tr></table>
</td></tr></table><br />
Class constructor<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">obj </td>
<td><b>$container</b> </td>
<td>CF_Container instance</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$name</b> </td>
<td>name of Object</td>
</tr>
<tr>
<td class="type">boolean </td>
<td><b>$force_exists</b> </td>
<td>if set, throw an error if Object doesn't exist</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>&$container</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$dohead</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodcompute_md5sum"></a>
<h3>method compute_md5sum <span class="smalllinenumber">[line 2522]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string compute_md5sum(
&$data, filename|obj|string
$data)</code>
</td></tr></table>
</td></tr></table><br />
Compute the MD5 checksum<br /><br /><p>Calculate the MD5 checksum on either a PHP resource or data. The argument may either be a local filename, open resource for reading, or a string.</p><p><strong>WARNING:</strong> if you are uploading a big file over a stream it could get very slow to compute the md5 you probably want to set the $verify parameter to False in the write() method and compute yourself the md5 before if you have it.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>MD5 checksum hexidecimal string</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">filename|obj|string </td>
<td><b>$data</b> </td>
<td>filename, open resource, or string</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>&$data</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetETag"></a>
<h3>method getETag <span class="smalllinenumber">[line 2503]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getETag(
)</code>
</td></tr></table>
</td></tr></table><br />
Object's MD5 checksum<br /><br /><p>Accessor method for reading Object's private ETag attribute.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>MD5 checksum hexidecimal string</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodload_from_filename"></a>
<h3>method load_from_filename <span class="smalllinenumber">[line 2393]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean load_from_filename(
string
$filename, [boolean
$verify = True])</code>
</td></tr></table>
</td></tr></table><br />
Upload Object data from local filename<br /><br /><p>This is a convenience function to upload the data from a local file. A True value for $verify will cause the method to compute the Object's MD5 checksum prior to uploading.</p><p>Example: <ol><li><div class="src-line"> <span class="src-comm"># ... authentication/connection/container code excluded</span></div></li>
<li><div class="src-line"> <span class="src-comm"># ... see previous examples</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-var">$my_docs </span>= <span class="src-var">$conn</span><span class="src-sym">-></span><span class="src-id">get_container</span><span class="src-sym">(</span><span class="src-str">"documents"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc </span>= <span class="src-var">$my_docs</span><span class="src-sym">-></span><span class="src-id">get_object</span><span class="src-sym">(</span><span class="src-str">"README"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Upload my local README's content</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc</span><span class="src-sym">-></span><a href="../php-cloudfiles/CF_Object.html#methodload_from_filename">load_from_filename</a><span class="src-sym">(</span><span class="src-str">"/home/ej/cloudfiles/readme"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td><kbd>True</kbd> if data uploaded successfully</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>SyntaxException missing required parameters</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>BadContentTypeException if no Content-Type was/could be set</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>MisMatchedChecksumException $verify is set and checksums unequal</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>InvalidResponseException unexpected response</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>IOException error opening file</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$filename</b> </td>
<td>full path to local file</td>
</tr>
<tr>
<td class="type">boolean </td>
<td><b>$verify</b> </td>
<td>enable local/remote MD5 checksum validation</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodpublic_ssl_uri"></a>
<h3>method public_ssl_uri <span class="smalllinenumber">[line 2052]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string public_ssl_uri(
)</code>
</td></tr></table>
</td></tr></table><br />
String representation of the Object's public SSL URI<br /><br /><p>A string representing the Object's public SSL URI assuming that it's parent Container is CDN-enabled.</p><p>Example: <ol><li><div class="src-line"> <span class="src-comm"># ... authentication/connection/container code excluded</span></div></li>
<li><div class="src-line"> <span class="src-comm"># ... see previous examples</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Print out the Object's CDN SSL URI (if it has one) in an HTML img-tag</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
<li><div class="src-line"> print <span class="src-str">"</span><span class="src-str"><img src='<span class="src-var">$pic</span><span class="src-sym">-></span><span class="src-id">public_ssl_uri</span>()' />\n</span><span class="src-str">"</span><span class="src-sym">;</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Object's public SSL URI or NULL</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodpublic_streaming_uri"></a>
<h3>method public_streaming_uri <span class="smalllinenumber">[line 2077]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string public_streaming_uri(
)</code>
</td></tr></table>
</td></tr></table><br />
String representation of the Object's public Streaming URI<br /><br /><p>A string representing the Object's public Streaming URI assuming that it's parent Container is CDN-enabled.</p><p>Example: <ol><li><div class="src-line"> <span class="src-comm"># ... authentication/connection/container code excluded</span></div></li>
<li><div class="src-line"> <span class="src-comm"># ... see previous examples</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Print out the Object's CDN Streaming URI (if it has one) in an HTML img-tag</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
<li><div class="src-line"> print <span class="src-str">"</span><span class="src-str"><img src='<span class="src-var">$pic</span><span class="src-sym">-></span><span class="src-id">public_streaming_uri</span>()' />\n</span><span class="src-str">"</span><span class="src-sym">;</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Object's public Streaming URI or NULL</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodpublic_uri"></a>
<h3>method public_uri <span class="smalllinenumber">[line 2026]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string public_uri(
)</code>
</td></tr></table>
</td></tr></table><br />
String representation of the Object's public URI<br /><br /><p>A string representing the Object's public URI assuming that it's parent Container is CDN-enabled.</p><p>Example: <ol><li><div class="src-line"> <span class="src-comm"># ... authentication/connection/container code excluded</span></div></li>
<li><div class="src-line"> <span class="src-comm"># ... see previous examples</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Print out the Object's CDN URI (if it has one) in an HTML img-tag</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
<li><div class="src-line"> print <span class="src-str">"</span><span class="src-str"><img src='<span class="src-var">$pic</span><span class="src-sym">-></span><span class="src-id">public_uri</span>()' />\n</span><span class="src-str">"</span><span class="src-sym">;</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Object's public URI or NULL</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodpurge_from_cdn"></a>
<h3>method purge_from_cdn <span class="smalllinenumber">[line 2466]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean purge_from_cdn(
[
$email = null])</code>
</td></tr></table>
</td></tr></table><br />
Purge this Object from CDN Cache.<br /><br /><p>Example:</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>True if successful</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>CDNNotEnabledException if CDN Is not enabled on this connection</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>InvalidResponseException if the response expected is not returned</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$email</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodread"></a>
<h3>method read <span class="smalllinenumber">[line 2113]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string read(
[array
$hdrs = array()])</code>
</td></tr></table>
</td></tr></table><br />
Read the remote Object's data<br /><br /><p>Returns the Object's data. This is useful for smaller Objects such as images or office documents. Object's with larger content should use the stream() method below.</p><p>Pass in $hdrs array to set specific custom HTTP headers such as If-Match, If-None-Match, If-Modified-Since, Range, etc.</p><p>Example: <ol><li><div class="src-line"> <span class="src-comm"># ... authentication/connection/container code excluded</span></div></li>
<li><div class="src-line"> <span class="src-comm"># ... see previous examples</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-var">$my_docs </span>= <span class="src-var">$conn</span><span class="src-sym">-></span><span class="src-id">get_container</span><span class="src-sym">(</span><span class="src-str">"documents"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc </span>= <span class="src-var">$my_docs</span><span class="src-sym">-></span><span class="src-id">get_object</span><span class="src-sym">(</span><span class="src-str">"README"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-var">$data </span>= <span class="src-var">$doc</span><span class="src-sym">-></span><a href="../php-cloudfiles/CF_Object.html#methodread">read</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm"># read image content into a string variable</span></div></li>
<li><div class="src-line"> print <span class="src-var">$data</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Or see stream() below for a different example.</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Object's data</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>InvalidResponseException unexpected response</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array </td>
<td><b>$hdrs</b> </td>
<td>user-defined headers (Range, If-Match, etc.)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsave_to_filename"></a>
<h3>method save_to_filename <span class="smalllinenumber">[line 2438]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean save_to_filename(
string
$filename)</code>
</td></tr></table>
</td></tr></table><br />
Save Object's data to local filename<br /><br /><p>Given a local filename, the Object's data will be written to the newly created file.</p><p>Example: <ol><li><div class="src-line"> <span class="src-comm"># ... authentication/connection/container code excluded</span></div></li>
<li><div class="src-line"> <span class="src-comm"># ... see previous examples</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Whoops! I deleted my local README, let me download/save it</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
<li><div class="src-line"> <span class="src-var">$my_docs </span>= <span class="src-var">$conn</span><span class="src-sym">-></span><span class="src-id">get_container</span><span class="src-sym">(</span><span class="src-str">"documents"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc </span>= <span class="src-var">$my_docs</span><span class="src-sym">-></span><span class="src-id">get_object</span><span class="src-sym">(</span><span class="src-str">"README"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-var">$doc</span><span class="src-sym">-></span><a href="../php-cloudfiles/CF_Object.html#methodsave_to_filename">save_to_filename</a><span class="src-sym">(</span><span class="src-str">"/home/ej/cloudfiles/readme.restored"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td><kbd>True</kbd> if successful</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>IOException error opening file</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>InvalidResponseException unexpected response</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$filename</b> </td>
<td>name of local file to write data to</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodset_etag"></a>
<h3>method set_etag <span class="smalllinenumber">[line 2490]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void set_etag(
string
$etag)</code>
</td></tr></table>
</td></tr></table><br />
Set Object's MD5 checksum<br /><br /><p>Manually set the Object's ETag. Including the ETag is mandatory for Cloud Files to perform end-to-end verification. Omitting the ETag forces the user to handle any data integrity checks.</p><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$etag</b> </td>
<td>MD5 checksum hexidecimal string</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodstream"></a>
<h3>method stream <span class="smalllinenumber">[line 2170]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string stream(
&$fp, [array
$hdrs = array()], resource
$fp)</code>
</td></tr></table>
</td></tr></table><br />
Streaming read of Object's data<br /><br /><p>Given an open PHP resource (see PHP's fopen() method), fetch the Object's data and write it to the open resource handle. This is useful for streaming an Object's content to the browser (videos, images) or for fetching content to a local file.</p><p>Pass in $hdrs array to set specific custom HTTP headers such as If-Match, If-None-Match, If-Modified-Since, Range, etc.</p><p>Example: <ol><li><div class="src-line"> # ... authentication/connection/container code excluded</div></li>
<li><div class="src-line"> # ... see previous examples</div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> # Assuming this is a web script to display the README to the</div></li>
<li><div class="src-line"> # user's browser:</div></li>
<li><div class="src-line"> #</div></li>
<li><div class="src-line"> <span class="src-php"><?php</span></div></li>
<li><div class="src-line"> <span class="src-comm">// grab README from storage system</span></div></li>
<li><div class="src-line"> <span class="src-comm">//</span></div></li>
<li><div class="src-line"> <span class="src-var">$my_docs </span>= <span class="src-var">$conn</span><span class="src-sym">-></span><span class="src-id">get_container</span><span class="src-sym">(</span><span class="src-str">"documents"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc </span>= <span class="src-var">$my_docs</span><span class="src-sym">-></span><span class="src-id">get_object</span><span class="src-sym">(</span><span class="src-str">"README"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm">// Hand it back to user's browser with appropriate content-type</span></div></li>
<li><div class="src-line"> <span class="src-comm">//</span></div></li>
<li><div class="src-line"> <a href="http://www.php.net/header">header</a><span class="src-sym">(</span><span class="src-str">"Content-Type: " </span>. <span class="src-var">$doc</span><span class="src-sym">-></span><span class="src-id"><a href="../php-cloudfiles/CF_Object.html#var$content_type">content_type</a></span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-var">$output </span>= <a href="http://www.php.net/fopen">fopen</a><span class="src-sym">(</span><span class="src-str">"php://output"</span><span class="src-sym">, </span><span class="src-str">"w"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc</span><span class="src-sym">-></span><a href="../php-cloudfiles/CF_Object.html#methodstream">stream</a><span class="src-sym">(</span><span class="src-var">$output</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm"># stream object content to PHP's output buffer</span></div></li>
<li><div class="src-line"> <a href="http://www.php.net/fclose">fclose</a><span class="src-sym">(</span><span class="src-var">$output</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-php">?></span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> # See read() above for a more simple example.</div></li>
<li><div class="src-line"> #</div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Object's data</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>InvalidResponseException unexpected response</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">resource </td>
<td><b>$fp</b> </td>
<td>open resource for writing data to</td>
</tr>
<tr>
<td class="type">array </td>
<td><b>$hdrs</b> </td>
<td>user-defined headers (Range, If-Match, etc.)</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>&$fp</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsync_manifest"></a>
<h3>method sync_manifest <span class="smalllinenumber">[line 2263]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean sync_manifest(
)</code>
</td></tr></table>
</td></tr></table><br />
Store new Object manifest<br /><br /><p>Write's an Object's manifest to the remote Object. This will overwrite an prior Object manifest.</p><p>Example: <ol><li><div class="src-line"> <span class="src-comm"># ... authentication/connection/container code excluded</span></div></li>
<li><div class="src-line"> <span class="src-comm"># ... see previous examples</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-var">$my_docs </span>= <span class="src-var">$conn</span><span class="src-sym">-></span><span class="src-id">get_container</span><span class="src-sym">(</span><span class="src-str">"documents"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc </span>= <span class="src-var">$my_docs</span><span class="src-sym">-></span><span class="src-id">get_object</span><span class="src-sym">(</span><span class="src-str">"README"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Define new manifest for the object</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc</span><span class="src-sym">-></span><span class="src-id"><a href="../php-cloudfiles/CF_Object.html#var$manifest">manifest</a> </span>= <span class="src-str">"container/prefix"</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Push the new manifest up to the storage system</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc</span><span class="src-sym">-></span><a href="../php-cloudfiles/CF_Object.html#methodsync_manifest">sync_manifest</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td><kbd>True</kbd> if successful, <kbd>False</kbd> otherwise</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>InvalidResponseException unexpected response</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsync_metadata"></a>
<h3>method sync_metadata <span class="smalllinenumber">[line 2221]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean sync_metadata(
)</code>
</td></tr></table>
</td></tr></table><br />
Store new Object metadata<br /><br /><p>Write's an Object's metadata to the remote Object. This will overwrite an prior Object metadata.</p><p>Example: <ol><li><div class="src-line"> <span class="src-comm"># ... authentication/connection/container code excluded</span></div></li>
<li><div class="src-line"> <span class="src-comm"># ... see previous examples</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-var">$my_docs </span>= <span class="src-var">$conn</span><span class="src-sym">-></span><span class="src-id">get_container</span><span class="src-sym">(</span><span class="src-str">"documents"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc </span>= <span class="src-var">$my_docs</span><span class="src-sym">-></span><span class="src-id">get_object</span><span class="src-sym">(</span><span class="src-str">"README"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Define new metadata for the object</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc</span><span class="src-sym">-></span><span class="src-id"><a href="../php-cloudfiles/CF_Object.html#var$metadata">metadata</a> </span>= <span class="src-key">array</span><span class="src-sym">(</span></div></li>
<li><div class="src-line"> <span class="src-str">"Author" </span>=> <span class="src-str">"EJ"</span><span class="src-sym">,</span></div></li>
<li><div class="src-line"> <span class="src-str">"Subject" </span>=> <span class="src-str">"How to use the PHP tests"</span><span class="src-sym">,</span></div></li>
<li><div class="src-line"> <span class="src-str">"Version" </span>=> <span class="src-str">"1.2.2"</span></div></li>
<li><div class="src-line"> <span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Define additional headers for the object</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc</span><span class="src-sym">-></span><span class="src-id"><a href="../php-cloudfiles/CF_Object.html#var$headers">headers</a> </span>= <span class="src-key">array</span><span class="src-sym">(</span></div></li>
<li><div class="src-line"> <span class="src-str">"Content-Disposition" </span>=> <span class="src-str">"attachment"</span><span class="src-sym">,</span></div></li>
<li><div class="src-line"> <span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Push the new metadata up to the storage system</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc</span><span class="src-sym">-></span><a href="../php-cloudfiles/CF_Object.html#methodsync_metadata">sync_metadata</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td><kbd>True</kbd> if successful, <kbd>False</kbd> otherwise</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>InvalidResponseException unexpected response</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodwrite"></a>
<h3>method write <span class="smalllinenumber">[line 2297]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean write(
[string|resource
$data = NULL], [float
$bytes = 0], [boolean
$verify = True])</code>
</td></tr></table>
</td></tr></table><br />
Upload Object's data to Cloud Files<br /><br /><p>Write data to the remote Object. The $data argument can either be a PHP resource open for reading (see PHP's fopen() method) or an in-memory variable. If passing in a PHP resource, you must also include the $bytes parameter.</p><p>Example: <ol><li><div class="src-line"> <span class="src-comm"># ... authentication/connection/container code excluded</span></div></li>
<li><div class="src-line"> <span class="src-comm"># ... see previous examples</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-var">$my_docs </span>= <span class="src-var">$conn</span><span class="src-sym">-></span><span class="src-id">get_container</span><span class="src-sym">(</span><span class="src-str">"documents"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc </span>= <span class="src-var">$my_docs</span><span class="src-sym">-></span><span class="src-id">get_object</span><span class="src-sym">(</span><span class="src-str">"README"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> </div></li>
<li><div class="src-line"> <span class="src-comm"># Upload placeholder text in my README</span></div></li>
<li><div class="src-line"> <span class="src-comm">#</span></div></li>
<li><div class="src-line"> <span class="src-var">$doc</span><span class="src-sym">-></span><a href="../php-cloudfiles/CF_Object.html#methodwrite">write</a><span class="src-sym">(</span><span class="src-str">"This is just placeholder text for now..."</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td><kbd>True</kbd> when data uploaded successfully</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>SyntaxException missing required parameters</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>BadContentTypeException if no Content-Type was/could be set</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>MisMatchedChecksumException $verify is set and checksums unequal</td>
</tr>
<tr>
<td><b>throws:</b> </td><td>InvalidResponseException unexpected response</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string|resource </td>
<td><b>$data</b> </td>