Menu

[r19]: / branches / spikephpcoverage-0.8 / doc / SpikePHPCoverage / PEAR.html  Maximize  Restore  History

Download this file

696 lines (568 with data), 33.0 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
<?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 PEAR</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 PEAR</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Base class for other PEAR classes. Provides rudimentary emulation of destructors.</p>
<p class="description"><p>If you want a destructor in your class, inherit PEAR and make a destructor method called _yourclassname (same name as the constructor, but with a &quot;_&quot; prefix). Also, in your constructor you have to call the PEAR constructor: $this-&gt;PEAR();. The destructor method will be called without parameters. Note that at in some SAPI implementations (such as Apache), any output during the request shutdown (in which destructors are called) seems to be discarded. If you need to get any debug information from your destructor, use error_log(), syslog() or something similar.</p><p>IMPORTANT! To use the emulated destructors you need to create the objects by reference: $obj =&amp; new PEAR_child;</p></p>
<ul class="tags">
<li><span class="field">see:</span> <a href="http://pear.php.net/manual/">http://pear.php.net/manual/</a></li>
<li><span class="field">author:</span> Stig Bakken &lt;<a href="mailto:ssb@php.net">ssb@php.net</a>&gt;</li>
<li><span class="field">since:</span> PHP 4.0.2</li>
</ul>
<p class="notes">
Located in <a class="field" href="_PEAR_php.html">/PEAR.php</a> (line <span class="field">85</span>)
</p>
<pre></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-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="../XML_Parser/XML_Parser.html">XML_Parser</a></td>
<td>
XML Parser class.
</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> |
<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">void</span>
<a href="#PEAR" title="details" class="method-name">PEAR</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$error_class</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#delExpect" title="details" class="method-name">delExpect</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$error_code</span>)
</div>
<div class="method-definition">
<span class="method-result">int</span>
<a href="#expectError" title="details" class="method-name">expectError</a>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">'*'</span>])
</div>
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#getStaticProperty" title="details" class="method-name">&amp;getStaticProperty</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$var</span>)
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#isError" title="details" class="method-name">isError</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#loadExtension" title="details" class="method-name">loadExtension</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$ext</span>)
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#popErrorHandling" title="details" class="method-name">popErrorHandling</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#popExpect" title="details" class="method-name">popExpect</a>
()
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#pushErrorHandling" title="details" class="method-name">pushErrorHandling</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$mode</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">object a</span>
<a href="#raiseError" title="details" class="method-name">raiseError</a>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$userinfo</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$error_class</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$skipmsg</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#registerShutdownFunc" title="details" class="method-name">registerShutdownFunc</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$func</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$args</span> = <span class="var-default">array()</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setErrorHandling" title="details" class="method-name">setErrorHandling</a>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$mode
</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$options
</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#staticPopErrorHandling" title="details" class="method-name">staticPopErrorHandling</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#staticPushErrorHandling" title="details" class="method-name">staticPushErrorHandling</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$mode</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#throwError" title="details" class="method-name">throwError</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$userinfo</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#_PEAR" title="details" class="method-name">_PEAR</a>
()
</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-descendents">Descendents</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="methodPEAR" id="PEAR"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor PEAR</span> (line <span class="line-number">153</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor. Registers this object in $_PEAR_destructor_object_list for destructor emulation if a destructor object exists.</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">
PEAR
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$error_class</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$error_class</span><span class="var-description">: (optional) which class to use for error objects, defaults to PEAR_Error.</span> </li>
</ul>
</div>
<a name="methoddelExpect" id="delExpect"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">delExpect</span> (line <span class="line-number">426</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method deletes all occurences of the specified element from the expected error codes stack.</p>
<ul class="tags">
<li><span class="field">return:</span> list of error codes that were deleted or error</li>
<li><span class="field">since:</span> PHP 4.3.0</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
delExpect
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$error_code</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$error_code</span><span class="var-description">: error code that should be deleted</span> </li>
</ul>
</div>
<a name="methodexpectError" id="expectError"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">expectError</span> (line <span class="line-number">361</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method is used to tell which errors you expect to get.</p>
<p class="description"><p>Expected errors are always returned with error mode PEAR_ERROR_RETURN. Expected error codes are stored in a stack, and this method pushes a new element onto it. The list of expected errors are in effect until they are popped off the stack with the popExpect() method.</p><p>Note that this method can not be called statically</p></p>
<ul class="tags">
<li><span class="field">return:</span> the new depth of the &quot;expected errors&quot; stack</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">int</span>
<span class="method-name">
expectError
</span>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">'*'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$code</span><span class="var-description">: a single error code or an array of error codes to expect</span> </li>
</ul>
</div>
<a name="methodgetStaticProperty" id="getStaticProperty"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getStaticProperty</span> (line <span class="line-number">213</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">If you have a class that's mostly/entirely static, and you need static</p>
<p class="description"><p>properties, you can use this method to simulate them. Eg. in your method(s) do this: $myVar = &amp;PEAR::getStaticProperty('myclass', 'myVar'); You MUST use a reference, or they will not persist!</p></p>
<ul class="tags">
<li><span class="field">return:</span> A reference to the variable. If not set it will be auto initialised to NULL.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
&amp;getStaticProperty
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$var</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$class</span><span class="var-description">: The calling classname, to prevent clashes</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$var</span><span class="var-description">: The variable to retrieve.</span> </li>
</ul>
</div>
<a name="methodisError" id="isError"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">isError</span> (line <span class="line-number">250</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Tell whether a value is a PEAR error.</p>
<ul class="tags">
<li><span class="field">return:</span> true if parameter is an error</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
isError
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$data</span><span class="var-description">: the value to test</span> </li>
<li>
<span class="var-type">int</span>
<span class="var-name">$code</span><span class="var-description">: if $data is an error object, return true only if $code is a string and $obj-&gt;getMessage() == $code or $code is an integer and $obj-&gt;getCode() == $code</span> </li>
</ul>
</div>
<a name="methodloadExtension" id="loadExtension"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">loadExtension</span> (line <span class="line-number">708</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">OS independant PHP extension load. Remember to take care on the correct extension name for case sensitive OSes.</p>
<ul class="tags">
<li><span class="field">return:</span> Success or not on the dl() call</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
loadExtension
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$ext</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$ext</span><span class="var-description">: The extension name</span> </li>
</ul>
</div>
<a name="methodpopErrorHandling" id="popErrorHandling"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">popErrorHandling</span> (line <span class="line-number">684</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Pop the last error handler used</p>
<ul class="tags">
<li><span class="field">return:</span> Always true</li>
<li><span class="field">see:</span> PEAR::pushErrorHandling</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
popErrorHandling
</span>
()
</div>
</div>
<a name="methodpopExpect" id="popExpect"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">popExpect</span> (line <span class="line-number">380</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method pops one element off the expected error codes stack.</p>
<ul class="tags">
<li><span class="field">return:</span> the list of error codes that were popped</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
popExpect
</span>
()
</div>
</div>
<a name="methodpushErrorHandling" id="pushErrorHandling"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">pushErrorHandling</span> (line <span class="line-number">653</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Push a new error handler on top of the error handler options stack. With this you can easily override the actual error handler for some code and restore it later with popErrorHandling.</p>
<ul class="tags">
<li><span class="field">return:</span> Always true</li>
<li><span class="field">see:</span> PEAR::setErrorHandling</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
pushErrorHandling
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$mode</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$mode</span><span class="var-description">: (same as setErrorHandling)</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$options</span><span class="var-description">: (same as setErrorHandling)</span> </li>
</ul>
</div>
<a name="methodraiseError" id="raiseError"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">raiseError</span> (line <span class="line-number">495</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. If the $mode and $options parameters are not specified, the object's defaults are used.</p>
<ul class="tags">
<li><span class="field">return:</span> PEAR error object</li>
<li><span class="field">since:</span> PHP 4.0.5</li>
<li><span class="field">see:</span> PEAR::setErrorHandling</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">object a</span>
<span class="method-name">
raiseError
</span>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$userinfo</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$error_class</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$skipmsg</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$message</span><span class="var-description">: a text error message or a PEAR error object</span> </li>
<li>
<span class="var-type">int</span>
<span class="var-name">$code</span><span class="var-description">: a numeric error code (it is up to your class to define these if you want to use codes)</span> </li>
<li>
<span class="var-type">int</span>
<span class="var-name">$mode</span><span class="var-description">: One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION.</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$options</span><span class="var-description">: If $mode is PEAR_ERROR_TRIGGER, this parameter specifies the PHP-internal error level (one of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR). If $mode is PEAR_ERROR_CALLBACK, this parameter specifies the callback function or method. In other error modes this parameter is ignored.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$userinfo</span><span class="var-description">: If you need to pass along for example debug information, this parameter is meant for that.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$error_class</span><span class="var-description">: The returned error object will be instantiated from this class, if specified.</span> </li>
<li>
<span class="var-type">bool</span>
<span class="var-name">$skipmsg</span><span class="var-description">: If true, raiseError will only pass error codes, the error message parameter will be dropped.</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../XML_Parser/XML_Parser.html#methodraiseError">XML_Parser::raiseError()</a>
: XML_Parser::raiseError()
</li>
</ul>
</div>
<a name="methodregisterShutdownFunc" id="registerShutdownFunc"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">registerShutdownFunc</span> (line <span class="line-number">231</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Use this function to register a shutdown method for static classes.</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">
registerShutdownFunc
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$func</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$args</span> = <span class="var-default">array()</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$func</span><span class="var-description">: The function name (or array of class/method) to call</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$args</span><span class="var-description">: The arguments to pass to the function</span> </li>
</ul>
</div>
<a name="methodsetErrorHandling" id="setErrorHandling"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setErrorHandling</span> (line <span class="line-number">306</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets how errors generated by this object should be handled.</p>
<p class="description"><p>Can be invoked both in objects and statically. If called statically, setErrorHandling sets the default behaviour for all PEAR objects. If called in an object, setErrorHandling sets the default behaviour for that object.</p></p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../SpikePHPCoverage/_PEAR_php.html#definePEAR_ERROR_CALLBACK">PEAR_ERROR_CALLBACK</a></li>
<li><span class="field">see:</span> <a href="../SpikePHPCoverage/_PEAR_php.html#definePEAR_ERROR_EXCEPTION">PEAR_ERROR_EXCEPTION</a></li>
<li><span class="field">since:</span> PHP 4.0.5</li>
<li><span class="field">see:</span> <a href="../SpikePHPCoverage/_PEAR_php.html#definePEAR_ERROR_DIE">PEAR_ERROR_DIE</a></li>
<li><span class="field">see:</span> <a href="../SpikePHPCoverage/_PEAR_php.html#definePEAR_ERROR_TRIGGER">PEAR_ERROR_TRIGGER</a></li>
<li><span class="field">see:</span> <a href="../SpikePHPCoverage/_PEAR_php.html#definePEAR_ERROR_RETURN">PEAR_ERROR_RETURN</a></li>
<li><span class="field">see:</span> <a href="../SpikePHPCoverage/_PEAR_php.html#definePEAR_ERROR_PRINT">PEAR_ERROR_PRINT</a></li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setErrorHandling
</span>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$mode</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$mode
</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$options
</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">int</span>
<span class="var-name">$mode
</span><span class="var-description">: One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT, PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE, PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION.</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$options
</span><span class="var-description">: <p>When $mode is PEAR_ERROR_TRIGGER, this is the error level (one of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).</p><p>When $mode is PEAR_ERROR_CALLBACK, this parameter is expected to be the callback function or method. A callback function is a string with the name of the function, a callback method is an array of two elements: the element at index 0 is the object, and the element at index 1 is the name of the method to call in the object.</p><p>When $mode is PEAR_ERROR_PRINT or PEAR_ERROR_DIE, this is a printf format string used when printing the error message.</p></span> </li>
</ul>
</div>
<a name="methodstaticPopErrorHandling" id="staticPopErrorHandling"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">staticPopErrorHandling</span> (line <span class="line-number">603</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
staticPopErrorHandling
</span>
()
</div>
</div>
<a name="methodstaticPushErrorHandling" id="staticPushErrorHandling"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">staticPushErrorHandling</span> (line <span class="line-number">568</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
staticPushErrorHandling
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$mode</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">null</span>])
</div>
</div>
<a name="methodthrowError" id="throwError"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">throwError</span> (line <span class="line-number">556</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Simpler form of raiseError with fewer options. In most cases message, code and userinfo are enough.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
throwError
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$code</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$userinfo</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$message</span> </li>
</ul>
</div>
<a name="method_PEAR" id="_PEAR"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">_PEAR</span> (line <span class="line-number">192</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Destructor (the emulated type of...). Does nothing right now, but is included for forward compatibility, so subclass destructors should always call it.</p>
<p class="description"><p>See the note in the class desciption about output from destructors.</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">
_PEAR
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Fri, 06 Jul 2007 12:51:37 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
</p>
</div></body>
</html>
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.