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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class ID3v2</title>
<link rel="stylesheet" href="../../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class ID3v2</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This class represents a file containing ID3v2 headers as described in <a href="http://www.id3.org/id3v2.4.0-structure">ID3v2 structure document</a>.</p>
<p class="description"><p>ID3v2 is a general tagging format for audio, which makes it possible to store meta data about the audio inside the audio file itself. The ID3 tag is mainly targeted at files encoded with MPEG-1/2 layer I, MPEG-1/2 layer II, MPEG-1/2 layer III and MPEG-2.5, but may work with other types of encoded audio or as a stand alone format for audio meta data.</p><p>ID3v2 is designed to be as flexible and expandable as possible to meet new meta information needs that might arise. To achieve that ID3v2 is constructed as a container for several information blocks, called frames, whose format need not be known to the software that encounters them. Each frame has an unique and predefined identifier which allows software to skip unknown frames.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Ryan Butterfield <<a href="mailto:buttza@gmail.com">buttza@gmail.com</a>></li>
<li><span class="field">author:</span> Sven Vollbehr <<a href="mailto:svollbehr@gmail.com">svollbehr@gmail.com</a>></li>
<li><span class="field">version:</span> $Rev: 107 $</li>
<li><span class="field">copyright:</span> Copyright (c) 2008 The PHP Reader Project Workgroup</li>
<li><span class="field">license:</span> <a href="http://code.google.com/p/php-reader/wiki/License">New BSD License</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_ID3v2.php.html">/ID3v2.php</a> (line <span class="field">71</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">ID3v2</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">string|<a href="../../php-reader/Reader.html">Reader</a></span> <span class="var-name">$filename</span> = <span class="var-default">false</span>], [<span class="var-type">Array</span> <span class="var-name">$options</span> = <span class="var-default">array()</span>])
</div>
<div class="method-definition">
<span class="method-result"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span>
<a href="#addFrame" title="details" class="method-name">addFrame</a>
(<span class="var-type"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span> <span class="var-name">$frame</span>)
</div>
<div class="method-definition">
<span class="method-result"><a href="../../php-reader/ID3/ID3_ExtendedHeader.html">ID3_ExtendedHeader</a>|false</span>
<a href="#getExtendedHeader" title="details" class="method-name">getExtendedHeader</a>
()
</div>
<div class="method-definition">
<span class="method-result"><a href="../../php-reader/ID3/ID3_Header.html">ID3_Header</a>|false</span>
<a href="#getFooter" title="details" class="method-name">getFooter</a>
()
</div>
<div class="method-definition">
<span class="method-result">Array</span>
<a href="#getFrames" title="details" class="method-name">getFrames</a>
()
</div>
<div class="method-definition">
<span class="method-result">Array</span>
<a href="#getFramesByIdentifier" title="details" class="method-name">getFramesByIdentifier</a>
(<span class="var-type"></span> <span class="var-name">$identifier</span>)
</div>
<div class="method-definition">
<span class="method-result"><a href="../../php-reader/ID3/ID3_Header.html">ID3_Header</a></span>
<a href="#getHeader" title="details" class="method-name">getHeader</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#hasExtendedHeader" title="details" class="method-name">hasExtendedHeader</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#hasFooter" title="details" class="method-name">hasFooter</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#hasFrame" title="details" class="method-name">hasFrame</a>
(<span class="var-type"></span> <span class="var-name">$identifier</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setExtendedHeader" title="details" class="method-name">setExtendedHeader</a>
(<span class="var-type"><a href="../../php-reader/ID3/ID3_ExtendedHeader.html">ID3_ExtendedHeader</a></span> <span class="var-name">$extendedHeader</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setFooter" title="details" class="method-name">setFooter</a>
(<span class="var-type">boolean</span> <span class="var-name">$useFooter</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#write" title="details" class="method-name">write</a>
([<span class="var-type">string</span> <span class="var-name">$filename</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#__get" title="details" class="method-name">__get</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#__isset" title="details" class="method-name">__isset</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#__toString" title="details" class="method-name">__toString</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#__unset" title="details" class="method-name">__unset</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">113</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructs the ID3v2 class with given file and options. The options array may also be given as the only parameter.</p>
<p class="description"><p>The following options are currently recognized: <ul><li>version -- The ID3v2 tag version to use in write operation. This option
is automatically set when a tag is read from a file and defaults to
version 4.0 for tag write.</li><li>readonly -- Indicates that the tag is read from a temporary file or
another source it cannot be written back to. The tag can, however,
still be written to another file.</li></ul></p></p>
<ul class="tags">
<li><span class="field">todo:</span> Only limited subset of flags are processed.</li>
<li><span class="field">todo:</span> Utilize the SEEK frame and search for a footer to find the tag</li>
<li><span class="field">todo:</span> Utilize the LINK frame to fetch frames from other sources</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">ID3v2</span>
<span class="method-name">
__construct
</span>
([<span class="var-type">string|<a href="../../php-reader/Reader.html">Reader</a></span> <span class="var-name">$filename</span> = <span class="var-default">false</span>], [<span class="var-type">Array</span> <span class="var-name">$options</span> = <span class="var-default">array()</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string|<a href="../../php-reader/Reader.html">Reader</a></span>
<span class="var-name">$filename</span><span class="var-description">: The path to the file, file descriptor of an opened file, or <a href="../../php-reader/Reader.html">Reader</a> instance.</span> </li>
<li>
<span class="var-type">Array</span>
<span class="var-name">$options</span><span class="var-description">: The options array.</span> </li>
</ul>
</div>
<a name="methodaddFrame" id="addFrame"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">addFrame</span> (line <span class="line-number">283</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a new frame to the tag and returns it.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span>
<span class="method-name">
addFrame
</span>
(<span class="var-type"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span> <span class="var-name">$frame</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span>
<span class="var-name">$frame</span><span class="var-description">: The frame to add.</span> </li>
</ul>
</div>
<a name="methodgetExtendedHeader" id="getExtendedHeader"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getExtendedHeader</span> (line <span class="line-number">209</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the extended header object if present, or <var>false</var> otherwise.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../../php-reader/ID3/ID3_ExtendedHeader.html">ID3_ExtendedHeader</a>|false</span>
<span class="method-name">
getExtendedHeader
</span>
()
</div>
</div>
<a name="methodgetFooter" id="getFooter"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getFooter</span> (line <span class="line-number">307</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the footer object if present, or <var>false</var> otherwise.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../../php-reader/ID3/ID3_Header.html">ID3_Header</a>|false</span>
<span class="method-name">
getFooter
</span>
()
</div>
</div>
<a name="methodgetFrames" id="getFrames"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getFrames</span> (line <span class="line-number">249</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns all the frames the tag contains as an associate array. The frame identifiers work as keys having an array of frames as associated value.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Array</span>
<span class="method-name">
getFrames
</span>
()
</div>
</div>
<a name="methodgetFramesByIdentifier" id="getFramesByIdentifier"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getFramesByIdentifier</span> (line <span class="line-number">265</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an array of frames matching the given identifier or an empty array if no frames matched the identifier.</p>
<p class="description"><p>The identifier may contain wildcard characters "*" and "?". The asterisk matches against zero or more characters, and the question mark matches any single character.</p><p>Please note that one may also use the shorthand $obj->identifier to access the first frame with the identifier given. Wildcards cannot be used with the shorthand.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Array</span>
<span class="method-name">
getFramesByIdentifier
</span>
(<span class="var-type"></span> <span class="var-name">$identifier</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$identifier</span> </li>
</ul>
</div>
<a name="methodgetHeader" id="getHeader"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getHeader</span> (line <span class="line-number">189</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the header object.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../../php-reader/ID3/ID3_Header.html">ID3_Header</a></span>
<span class="method-name">
getHeader
</span>
()
</div>
</div>
<a name="methodhasExtendedHeader" id="hasExtendedHeader"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">hasExtendedHeader</span> (line <span class="line-number">197</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether there is an extended header present in the tag. Returns <var>true</var> if the header is present, <var>false</var> otherwise.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
hasExtendedHeader
</span>
()
</div>
</div>
<a name="methodhasFooter" id="hasFooter"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">hasFooter</span> (line <span class="line-number">297</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether there is a footer present in the tag. Returns <var>true</var> if the footer is present, <var>false</var> otherwise.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
hasFooter
</span>
()
</div>
</div>
<a name="methodhasFrame" id="hasFrame"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">hasFrame</span> (line <span class="line-number">238</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether there is a frame given as an argument defined in the tag.</p>
<p class="description"><p>Returns <var>true</var> if one ore more frames are present, <var>false</var> otherwise.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
hasFrame
</span>
(<span class="var-type"></span> <span class="var-name">$identifier</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$identifier</span> </li>
</ul>
</div>
<a name="methodsetExtendedHeader" id="setExtendedHeader"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setExtendedHeader</span> (line <span class="line-number">221</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the extended header object.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setExtendedHeader
</span>
(<span class="var-type"><a href="../../php-reader/ID3/ID3_ExtendedHeader.html">ID3_ExtendedHeader</a></span> <span class="var-name">$extendedHeader</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../../php-reader/ID3/ID3_ExtendedHeader.html">ID3_ExtendedHeader</a></span>
<span class="var-name">$extendedHeader</span><span class="var-description">: The header object</span> </li>
</ul>
</div>
<a name="methodsetFooter" id="setFooter"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setFooter</span> (line <span class="line-number">319</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets whether the tag should have a footer defined.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setFooter
</span>
(<span class="var-type">boolean</span> <span class="var-name">$useFooter</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">boolean</span>
<span class="var-name">$useFooter</span><span class="var-description">: Whether the tag should have a footer</span> </li>
</ul>
</div>
<a name="methodwrite" id="write"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">write</span> (line <span class="line-number">348</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Writes the possibly altered ID3v2 tag back to the file where it was read.</p>
<p class="description"><p>If the class was constructed without a file name, one can be provided here as an argument. Regardless, the write operation will override previous tag information, if found.</p><p>If write is called without setting any frames to the tag, the tag is removed from the file.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
write
</span>
([<span class="var-type">string</span> <span class="var-name">$filename</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$filename</span><span class="var-description">: The optional path to the file.</span> </li>
</ul>
</div>
<a name="method__get" id="__get"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">397</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Magic function so that $obj->value will work. The method will attempt to return the first frame that matches the identifier.</p>
<p class="description"><p>If there is no frame or field with given name, the method will attempt to create a frame with given identifier.</p><p>If none of these work, an exception is thrown.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
__get
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: The frame or field name.</span> </li>
</ul>
</div>
<a name="method__isset" id="__isset"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">__isset</span> (line <span class="line-number">417</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Magic function so that isset($obj->value) will work. This method checks whether the frame matching the identifier exists.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
__isset
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: The frame identifier.</span> </li>
</ul>
</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">__toString</span> (line <span class="line-number">435</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the tag raw data.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
__toString
</span>
()
</div>
</div>
<a name="method__unset" id="__unset"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">__unset</span> (line <span class="line-number">428</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Magic function so that unset($obj->value) will work. This method removes all the frames matching the identifier.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
__unset
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: The frame identifier.</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Fri, 05 Sep 2008 20:18:50 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
</p>
</div></body>
</html>
|
