1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml">
5
<!-- template designed by Marco Von Ballmoos -->
6
<title>Docs For Class ID3_Frame_USER</title>
7
<link rel="stylesheet" href="../../media/stylesheet.css" />
8
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
11
<div class="page-body">
12
<h2 class="class-name">Class ID3_Frame_USER</h2>
14
<a name="sec-description"></a>
15
<div class="info-box">
16
<div class="info-box-title">Description</div>
18
<span class="disabled">Description</span> |
19
<a href="#sec-vars">Vars</a>
20
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22
<a href="#sec-consts">Constants</a>
25
<div class="info-box-body">
26
<p class="implements">
27
Implements interfaces:
29
<li><a href="../../php-reader/ID3/ID3_Encoding.html">ID3_Encoding</a></li><li><a href="../../php-reader/ID3/ID3_Language.html">ID3_Language</a></li> </ul>
31
<!-- ========== Info from phpDoc block ========= -->
32
<p class="short-description">The <em>Terms of use frame</em> contains a brief description of the terms of</p>
33
<p class="description"><p>use and ownership of the file. More detailed information concerning the legal terms might be available through the <a href="../../php-reader/ID3/ID3_Frame_WCOP.html">ID3_Frame_WCOP</a> frame. Newlines are allowed in the text. There may be more than one Terms of use frames in a tag, but only one with the same language.</p></p>
35
<li><span class="field">author:</span> Ryan Butterfield <<a href="mailto:buttza@gmail.com">buttza@gmail.com</a>></li>
36
<li><span class="field">author:</span> Sven Vollbehr <<a href="mailto:svollbehr@gmail.com">svollbehr@gmail.com</a>></li>
37
<li><span class="field">version:</span> $Rev: 105 $</li>
38
<li><span class="field">copyright:</span> Copyright (c) 2008 The PHP Reader Project Workgroup</li>
39
<li><span class="field">license:</span> <a href="http://code.google.com/p/php-reader/wiki/License">New BSD License</a></li>
42
Located in <a class="field" href="_ID3---Frame---USER.php.html">/ID3/Frame/USER.php</a> (line <span class="field">59</span>)
46
<pre><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a>
48
--<a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a>
50
--ID3_Frame_USER</pre>
58
<a name="sec-method-summary"></a>
59
<div class="info-box">
60
<div class="info-box-title">Method Summary</span></div>
62
<a href="#sec-description">Description</a> |
63
<a href="#sec-consts">Constants</a>
65
<a href="#sec-vars">Vars</a>
68
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
70
<div class="info-box-body">
71
<div class="method-summary">
73
<div class="method-definition">
74
<span class="method-result">ID3_Frame_USER</span>
75
<a href="#__construct" title="details" class="method-name">__construct</a>
76
([<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span> <span class="var-name">$reader</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span> <span class="var-name">$options</span>)
78
<div class="method-definition">
79
<span class="method-result">integer</span>
80
<a href="#getEncoding" title="details" class="method-name">getEncoding</a>
83
<div class="method-definition">
84
<span class="method-result">string</span>
85
<a href="#getLanguage" title="details" class="method-name">getLanguage</a>
88
<div class="method-definition">
89
<span class="method-result">string</span>
90
<a href="#getText" title="details" class="method-name">getText</a>
93
<div class="method-definition">
94
<span class="method-result">void</span>
95
<a href="#setEncoding" title="details" class="method-name">setEncoding</a>
96
(<span class="var-type">integer</span> <span class="var-name">$encoding</span>)
98
<div class="method-definition">
99
<span class="method-result">void</span>
100
<a href="#setLanguage" title="details" class="method-name">setLanguage</a>
101
(<span class="var-type">string</span> <span class="var-name">$language</span>)
103
<div class="method-definition">
104
<span class="method-result">void</span>
105
<a href="#setText" title="details" class="method-name">setText</a>
106
(<span class="var-type">string</span> <span class="var-name">$text</span>, [<span class="var-type">string</span> <span class="var-name">$language</span> = <span class="var-default">false</span>], [<span class="var-type">integer</span> <span class="var-name">$encoding</span> = <span class="var-default">false</span>])
108
<div class="method-definition">
109
<span class="method-result">string</span>
110
<a href="#__toString" title="details" class="method-name">__toString</a>
117
<a name="sec-vars"></a>
118
<div class="info-box">
119
<div class="info-box-title">Variables</div>
120
<div class="nav-bar">
121
<a href="#sec-description">Description</a> |
122
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
125
<a href="#sec-consts">Constants</a>
128
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
131
<div class="info-box-body">
b'\t\t\t\t\t\t\t<h4>Inherited Variables</h4>'
133
<A NAME='inherited_vars'><!-- --></A>
134
<p>Inherited from <span class="classname"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
136
<span class="var-title">
137
<span class="var-name"><a href="../../php-reader/ID3/ID3_Frame.html#var$_data">ID3_Frame::$_data</a></span><br>
140
<p>Inherited from <span class="classname"><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a></span></p>
142
<span class="var-title">
143
<span class="var-name"><a href="../../php-reader/ID3/ID3_Object.html#var$_reader">ID3_Object::$_reader</a></span><br>
150
<a name="sec-methods"></a>
151
<div class="info-box">
152
<div class="info-box-title">Methods</div>
153
<div class="nav-bar">
154
<a href="#sec-description">Description</a> |
155
<a href="#sec-vars">Vars</a>
156
<a href="#sec-consts">Constants</a>
158
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
161
<div class="info-box-body">
162
<A NAME='method_detail'></A>
164
<a name="method__construct" id="__construct"><!-- --></a>
165
<div class="evenrow">
167
<div class="method-header">
168
<span class="method-title">Constructor __construct</span> (line <span class="line-number">77</span>)
171
<!-- ========== Info from phpDoc block ========= -->
172
<p class="short-description">Constructs the class with given parameters and parses object related data.</p>
174
<li><span class="field">access:</span> public</li>
177
<div class="method-signature">
178
<span class="method-result">ID3_Frame_USER</span>
179
<span class="method-name">
182
([<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span> <span class="var-name">$reader</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span> <span class="var-name">$options</span>)
185
<ul class="parameters">
187
<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>
188
<span class="var-name">$reader</span><span class="var-description">: The reader object.</span> </li>
190
<span class="var-type">Array</span>
191
<span class="var-name">$options</span><span class="var-description">: The options array.</span> </li>
193
<span class="var-type"></span>
194
<span class="var-name">&$options</span> </li>
197
<hr class="separator" />
198
<div class="notes">Redefinition of:</div>
200
<dt><a href="../../php-reader/ID3/ID3_Frame.html#method__construct">ID3_Frame::__construct()</a></dt>
201
<dd>Constructs the class with given parameters and reads object related data from the ID3v2 tag.</dd>
205
<a name="methodgetEncoding" id="getEncoding"><!-- --></a>
208
<div class="method-header">
209
<span class="method-title">getEncoding</span> (line <span class="line-number">107</span>)
212
<!-- ========== Info from phpDoc block ========= -->
213
<p class="short-description">Returns the text encoding.</p>
215
<li><span class="field">access:</span> public</li>
218
<div class="method-signature">
219
<span class="method-result">integer</span>
220
<span class="method-name">
227
<hr class="separator" />
228
<div class="notes">Implementation of:</div>
230
<dt><a href="../../php-reader/ID3/ID3_Encoding.html#methodgetEncoding">ID3_Encoding::getEncoding()</a></dt>
231
<dd>Returns the text encoding.</dd>
235
<a name="methodgetLanguage" id="getLanguage"><!-- --></a>
236
<div class="evenrow">
238
<div class="method-header">
239
<span class="method-title">getLanguage</span> (line <span class="line-number">123</span>)
242
<!-- ========== Info from phpDoc block ========= -->
243
<p class="short-description">Returns the language code as specified in the <a href="http://www.loc.gov/standards/iso639-2/">ISO-639-2</a> standard.</p>
245
<li><span class="field">access:</span> public</li>
248
<div class="method-signature">
249
<span class="method-result">string</span>
250
<span class="method-name">
257
<hr class="separator" />
258
<div class="notes">Implementation of:</div>
260
<dt><a href="../../php-reader/ID3/ID3_Language.html#methodgetLanguage">ID3_Language::getLanguage()</a></dt>
261
<dd>Returns the text language code.</dd>
265
<a name="methodgetText" id="getText"><!-- --></a>
268
<div class="method-header">
269
<span class="method-title">getText</span> (line <span class="line-number">144</span>)
272
<!-- ========== Info from phpDoc block ========= -->
273
<p class="short-description">Returns the text.</p>
275
<li><span class="field">access:</span> public</li>
278
<div class="method-signature">
279
<span class="method-result">string</span>
280
<span class="method-name">
289
<a name="methodsetEncoding" id="setEncoding"><!-- --></a>
290
<div class="evenrow">
292
<div class="method-header">
293
<span class="method-title">setEncoding</span> (line <span class="line-number">115</span>)
296
<!-- ========== Info from phpDoc block ========= -->
297
<p class="short-description">Sets the text encoding.</p>
299
<li><span class="field">see:</span> <a href="../../php-reader/ID3/ID3_Encoding.html">ID3_Encoding</a></li>
300
<li><span class="field">access:</span> public</li>
303
<div class="method-signature">
304
<span class="method-result">void</span>
305
<span class="method-name">
308
(<span class="var-type">integer</span> <span class="var-name">$encoding</span>)
311
<ul class="parameters">
313
<span class="var-type">integer</span>
314
<span class="var-name">$encoding</span><span class="var-description">: The text encoding.</span> </li>
317
<hr class="separator" />
318
<div class="notes">Implementation of:</div>
320
<dt><a href="../../php-reader/ID3/ID3_Encoding.html#methodsetEncoding">ID3_Encoding::setEncoding()</a></dt>
321
<dd>Sets the text encoding.</dd>
325
<a name="methodsetLanguage" id="setLanguage"><!-- --></a>
328
<div class="method-header">
329
<span class="method-title">setLanguage</span> (line <span class="line-number">132</span>)
332
<!-- ========== Info from phpDoc block ========= -->
333
<p class="short-description">Sets the text language code as specified in the <a href="http://www.loc.gov/standards/iso639-2/">ISO-639-2</a> standard.</p>
335
<li><span class="field">see:</span> <a href="../../php-reader/ID3/ID3_Language.html">ID3_Language</a></li>
336
<li><span class="field">access:</span> public</li>
339
<div class="method-signature">
340
<span class="method-result">void</span>
341
<span class="method-name">
344
(<span class="var-type">string</span> <span class="var-name">$language</span>)
347
<ul class="parameters">
349
<span class="var-type">string</span>
350
<span class="var-name">$language</span><span class="var-description">: The language code.</span> </li>
353
<hr class="separator" />
354
<div class="notes">Implementation of:</div>
356
<dt><a href="../../php-reader/ID3/ID3_Language.html#methodsetLanguage">ID3_Language::setLanguage()</a></dt>
357
<dd>Sets the text language code.</dd>
361
<a name="methodsetText" id="setText"><!-- --></a>
362
<div class="evenrow">
364
<div class="method-header">
365
<span class="method-title">setText</span> (line <span class="line-number">153</span>)
368
<!-- ========== Info from phpDoc block ========= -->
369
<p class="short-description">Sets the text using given language and encoding.</p>
371
<li><span class="field">access:</span> public</li>
374
<div class="method-signature">
375
<span class="method-result">void</span>
376
<span class="method-name">
379
(<span class="var-type">string</span> <span class="var-name">$text</span>, [<span class="var-type">string</span> <span class="var-name">$language</span> = <span class="var-default">false</span>], [<span class="var-type">integer</span> <span class="var-name">$encoding</span> = <span class="var-default">false</span>])
382
<ul class="parameters">
384
<span class="var-type">string</span>
385
<span class="var-name">$text</span><span class="var-description">: The text.</span> </li>
387
<span class="var-type">string</span>
388
<span class="var-name">$language</span><span class="var-description">: The language code.</span> </li>
390
<span class="var-type">integer</span>
391
<span class="var-name">$encoding</span><span class="var-description">: The text encoding.</span> </li>
396
<a name="method__toString" id="__toString"><!-- --></a>
399
<div class="method-header">
400
<span class="method-title">__toString</span> (line <span class="line-number">167</span>)
403
<!-- ========== Info from phpDoc block ========= -->
404
<p class="short-description">Returns the frame raw data.</p>
406
<li><span class="field">access:</span> public</li>
409
<div class="method-signature">
410
<span class="method-result">string</span>
411
<span class="method-name">
418
<hr class="separator" />
419
<div class="notes">Redefinition of:</div>
421
<dt><a href="../../php-reader/ID3/ID3_Frame.html#method__toString">ID3_Frame::__toString()</a></dt>
422
<dd>Returns the frame raw data.</dd>
426
<h4>Inherited Methods</h4>
427
<a name='inherited_methods'><!-- --></a>
428
<!-- =========== Summary =========== -->
429
<p>Inherited From <span class="classname"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
431
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#method__construct">ID3_Frame::__construct()</a></span><br>
432
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetFlags">ID3_Frame::getFlags()</a></span><br>
433
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetIdentifier">ID3_Frame::getIdentifier()</a></span><br>
434
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetSize">ID3_Frame::getSize()</a></span><br>
435
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodhasFlag">ID3_Frame::hasFlag()</a></span><br>
436
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetData">ID3_Frame::setData()</a></span><br>
437
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetFlags">ID3_Frame::setFlags()</a></span><br>
438
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetIdentifier">ID3_Frame::setIdentifier()</a></span><br>
439
<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#method__toString">ID3_Frame::__toString()</a></span><br>
441
<!-- =========== Summary =========== -->
442
<p>Inherited From <span class="classname"><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a></span></p>
444
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__construct">ID3_Object::__construct()</a></span><br>
445
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methoddecodeSynchsafe32">ID3_Object::decodeSynchsafe32()</a></span><br>
446
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methoddecodeUnsynchronisation">ID3_Object::decodeUnsynchronisation()</a></span><br>
447
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodencodeSynchsafe32">ID3_Object::encodeSynchsafe32()</a></span><br>
448
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodencodeUnsynchronisation">ID3_Object::encodeUnsynchronisation()</a></span><br>
449
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodexplodeString8">ID3_Object::explodeString8()</a></span><br>
450
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodexplodeString16">ID3_Object::explodeString16()</a></span><br>
451
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodgetOption">ID3_Object::getOption()</a></span><br>
452
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodgetOptions">ID3_Object::getOptions()</a></span><br>
453
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodsetOption">ID3_Object::setOption()</a></span><br>
454
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodsetOptions">ID3_Object::setOptions()</a></span><br>
455
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__get">ID3_Object::__get()</a></span><br>
456
<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__set">ID3_Object::__set()</a></span><br>
462
<a name="sec-consts"></a>
463
<div class="info-box">
464
<div class="info-box-title">Class Constants</div>
465
<div class="nav-bar">
466
<a href="#sec-description">Description</a> |
467
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
470
<a href="#sec-vars">Vars</a>
472
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
475
<div class="info-box-body">
b'\t\t\t\t\t\t\t<h4>Inherited Constants</h4>'
477
<A NAME='inherited_vars'><!-- --></A>
478
<p>Inherited from <span class="classname"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
480
<img src="../../media/images/Variable.png" />
481
<span class="const-title">
482
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constCOMPRESSION">ID3_Frame::COMPRESSION</a></span><br>
484
<img src="../../media/images/Variable.png" />
485
<span class="const-title">
486
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDATA_LENGTH_INDICATOR">ID3_Frame::DATA_LENGTH_INDICATOR</a></span><br>
488
<img src="../../media/images/Variable.png" />
489
<span class="const-title">
490
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDISCARD_ON_FILECHANGE">ID3_Frame::DISCARD_ON_FILECHANGE</a></span><br>
492
<img src="../../media/images/Variable.png" />
493
<span class="const-title">
494
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDISCARD_ON_TAGCHANGE">ID3_Frame::DISCARD_ON_TAGCHANGE</a></span><br>
496
<img src="../../media/images/Variable.png" />
497
<span class="const-title">
498
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constENCRYPTION">ID3_Frame::ENCRYPTION</a></span><br>
500
<img src="../../media/images/Variable.png" />
501
<span class="const-title">
502
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constGROUPING_IDENTITY">ID3_Frame::GROUPING_IDENTITY</a></span><br>
504
<img src="../../media/images/Variable.png" />
505
<span class="const-title">
506
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constREAD_ONLY">ID3_Frame::READ_ONLY</a></span><br>
508
<img src="../../media/images/Variable.png" />
509
<span class="const-title">
510
<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constUNSYNCHRONISATION">ID3_Frame::UNSYNCHRONISATION</a></span><br>
517
<p class="notes" id="credit">
518
Documentation generated on Fri, 05 Sep 2008 20:20:09 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
b'\\ No newline at end of file'