blob: bf2b82d0c9172c31de6c25f56c0e91277093b494 (
plain)
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
|
<?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 ASF_Object_Container</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 ASF_Object_Container</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-descendents">Descendents</a>
| <a href="#sec-vars">Vars</a>
| <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">An abstract base container class that contains other ASF objects.</p>
<ul class="tags">
<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: 108 $</li>
<li><span class="field">copyright:</span> Copyright (c) 2008 The PHP Reader Project Workgroup</li>
<li><span class="field">abstract:</span> </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="_ASF---Object---Container.php.html">/ASF/Object/Container.php</a> (line <span class="field">52</span>)
</p>
<pre><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a>
|
--ASF_Object_Container</pre>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</span>
| <a href="#sec-vars">Vars</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ASF/ASF.html">ASF</a></td>
<td>
This class represents a file in Advanced Systems Format (ASF) as described in
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ASF/ASF_Object_Header.html">ASF_Object_Header</a></td>
<td>
The role of the header object is to provide a well-known byte sequence at the beginning of ASF files and to contain all the information that is needed to properly interpret the information within the data object. The header object can optionally contain metadata such as bibliographic information.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../../php-reader/ASF/ASF_Object_HeaderExtension.html">ASF_Object_HeaderExtension</a></td>
<td>
The <em>Header Extension Object</em> allows additional functionality to be added to an ASF file while maintaining backward compatibility. The Header Extension Object is a container containing zero or more additional extended header objects.
</td>
</tr>
</table>
</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> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-vars">Vars</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"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span>
<a href="#addObject" title="details" class="method-name">addObject</a>
(<span class="var-type"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span> <span class="var-name">$object</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#constructObjects" title="details" class="method-name">constructObjects</a>
([<span class="var-type"></span> <span class="var-name">$defaultclassnames</span> = <span class="var-default">array()</span>])
</div>
<div class="method-definition">
<span class="method-result">Array</span>
<a href="#getObjects" title="details" class="method-name">getObjects</a>
()
</div>
<div class="method-definition">
<span class="method-result">Array</span>
<a href="#getObjectsByIdentifier" title="details" class="method-name">getObjectsByIdentifier</a>
(<span class="var-type"></span> <span class="var-name">$identifier</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#hasObject" title="details" class="method-name">hasObject</a>
(<span class="var-type"></span> <span class="var-name">$identifier</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>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../../php-reader/ASF/ASF_Object.html#var$_options">ASF_Object::$_options</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../../php-reader/ASF/ASF_Object.html#var$_reader">ASF_Object::$_reader</a></span><br>
</span>
</blockquote>
</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-descendents">Descendents</a> |
<a href="#sec-vars">Vars</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="methodaddObject" id="addObject"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">addObject</span> (line <span class="line-number">145</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a new object into the current object 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/ASF/ASF_Object.html">ASF_Object</a></span>
<span class="method-name">
addObject
</span>
(<span class="var-type"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span> <span class="var-name">$object</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span>
<span class="var-name">$object</span><span class="var-description">: The object to add</span> </li>
</ul>
</div>
<a name="methodconstructObjects" id="constructObjects"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">constructObjects</span> (line <span class="line-number">60</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reads and constructs the objects found within this object.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
constructObjects
</span>
([<span class="var-type"></span> <span class="var-name">$defaultclassnames</span> = <span class="var-default">array()</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$defaultclassnames</span> </li>
</ul>
</div>
<a name="methodgetObjects" id="getObjects"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getObjects</span> (line <span class="line-number">108</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns all the objects the file contains as an associate array. The object identifiers work as keys having an array of ASF objects 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">
getObjects
</span>
()
</div>
</div>
<a name="methodgetObjectsByIdentifier" id="getObjectsByIdentifier"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getObjectsByIdentifier</span> (line <span class="line-number">127</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an array of objects matching the given object GUID or an empty array if no object 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 box with the identifier given. Wildcards cannot be used with the shorthand and they will not work with user defined uuid types.</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">
getObjectsByIdentifier
</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="methodhasObject" id="hasObject"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">hasObject</span> (line <span class="line-number">96</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether the object with given GUID is present in the file. Returns <var>true</var> if one or more objects are 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">
hasObject
</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="method__get" id="__get"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">__get</span> (line <span class="line-number">165</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Override magic function so that $obj->value will work as expected.</p>
<p class="description"><p>The method first attempts to call the appropriate getter method. If no field with given name is found, the method attempts to return the right object instead. In other words, calling $obj->value will attempt to return the first object returned by $this->getObjectsByIdentifier(self::value).</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 field or object name.</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../../php-reader/ASF/ASF_Object.html#method__get">ASF_Object::__get()</a></dt>
<dd>Magic function so that $obj->value will work.</dd>
</dl>
</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">185</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Magic function so that isset($obj->value) will work. This method checks whether the object by given identifier is contained by this container.</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 object name.</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__construct">ASF_Object::__construct()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetIdentifier">ASF_Object::getIdentifier()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOffset">ASF_Object::getOffset()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOption">ASF_Object::getOption()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOptions">ASF_Object::getOptions()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetParent">ASF_Object::getParent()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetSize">ASF_Object::getSize()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetIdentifier">ASF_Object::setIdentifier()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOffset">ASF_Object::setOffset()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOption">ASF_Object::setOption()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOptions">ASF_Object::setOptions()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetParent">ASF_Object::setParent()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetSize">ASF_Object::setSize()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__get">ASF_Object::__get()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__set">ASF_Object::__set()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Fri, 05 Sep 2008 20:18:26 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
</p>
</div></body>
</html>
|
