File: info.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (1171 lines) | stat: -rw-r--r-- 35,389 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
<?xml version="1.0" encoding="utf-8"?>
 <reference id="ref.info">
  <title>PHP options &amp; information</title>
  <titleabbrev>PHP options/info</titleabbrev>
  
  <refentry id="function.assert">
   <refnamediv>
    <refname>assert</refname>
    <refpurpose>Checks if assertion is &false;</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>assert</methodname>
      <methodparam><type>string|bool</type><parameter>assertion</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>assert</function> will check the given 
     <parameter>assertion</parameter> and take appropriate 
     action if its result is &false;.
    </para>
    <para>
     If the <parameter>assertion</parameter> is given as a string it
     will be evaluated as PHP code by <function>assert</function>.
     The advantages of a string <parameter>assertion</parameter> 
     are less overhead when assertion checking is off and messages
     containing the <parameter>assertion</parameter> expression when
     an assertion failes.
    </para>
    <para>
     Assertion should be used as a debugging feature only. You may
     use them for sanity-checks that test for conditions that should
     always be &true; and that indicate some programming errors if not
     or to check for the presence of certain features like extension
     functions or certain system limits and features.
    </para>
    <para>
     Assertions should not be used for normal runtime operations 
     like input parameter checks. As a rule of thumb your code
     should always be able to work correct if assertion checking
     is not activated.
    </para>
    <para>
     The behavior of <function>assert</function> may be configured
     by <function>assert_options</function> or by .ini-settings 
     described in that functions manual page.
    </para>
   </refsect1>
  </refentry> 

  <refentry id="function.assert-options">
   <refnamediv>
    <refname>assert_options</refname>
    <refpurpose>Set/get the various assert flags</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>mixed</type><methodname>assert_options</methodname>
      <methodparam><type>int</type><parameter>what</parameter></methodparam>
      <methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam>
     </methodsynopsis>
    <para>
     Using <function>assert_options</function> you may set the various
     <function>assert</function> control options or just query their
     current settings.
    </para>
    <table>
     <title>assert options</title>
     <tgroup cols="4">
      <thead>
       <row>
				<entry>option</entry>
				<entry>ini-parameter</entry>
				<entry>default</entry>
				<entry>description</entry>
       </row>
      </thead>
      <tbody>
       <row>
				<entry>ASSERT_ACTIVE</entry>
				<entry>assert.active</entry>
				<entry>1</entry>
				<entry>enable <function>assert</function> evaluation</entry>
       </row>
       <row>
				<entry>ASSERT_WARNING</entry>
				<entry>assert.warning</entry>
				<entry>1</entry>
				<entry>issue a PHP warning for each failed assertion</entry>
       </row>
       <row>
				<entry>ASSERT_BAIL</entry>
				<entry>assert.bail</entry>
				<entry>0</entry>
				<entry>terminate execution on failed assertions</entry>
       </row>
       <row>
				<entry>ASSERT_QUIET_EVAL</entry>
				<entry>assert.quiet_eval</entry>
				<entry>0</entry>
				<entry>
				 disable error_reporting during assertion expression
				 evaluation
				</entry>
       </row>
       <row>
				<entry>ASSERT_CALLBACK</entry>
				<entry>assert_callback</entry>
				<entry>(&null;)</entry>
				<entry>user function to call on failed assertions</entry>
       </row>
      </tbody>    
     </tgroup>
    </table>
    <para>
     <function>assert_options</function> will return the original
     setting of any option or &false; on errors.
    </para>
   </refsect1>
  </refentry> 

  <refentry id="function.extension-loaded">
   <refnamediv>
    <refname>extension_loaded</refname>
    <refpurpose>find out whether an extension is loaded</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>extension_loaded</methodname>
      <methodparam><type>string</type><parameter>name</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     Returns &true; if the extension identified by
     <parameter>name</parameter> is loaded. You can see the names of
     various extensions by using <function>phpinfo</function>.
    </simpara>
    <para>
     See also <function>phpinfo</function>.
     <note>
      <para>
       This function was added in 3.0.10.
      </para>
     </note>
    </para>
   </refsect1>
  </refentry>
  
  <refentry id="function.dl">
   <refnamediv>
    <refname>dl</refname>
    <refpurpose>load a PHP extension at runtime</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>dl</methodname>
      <methodparam><type>string</type><parameter>library</parameter></methodparam>
     </methodsynopsis>
    <para>
     Loads the PHP extension defined in
     <parameter>library</parameter>.  See also the <link
			linkend="ini.extension-dir">extension_dir</link> configuration
     directive.
    </para>
   </refsect1>
  </refentry>
  
  <refentry id="function.getenv">
   <refnamediv>
    <refname>getenv</refname>
    <refpurpose>Get the value of an environment variable</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>getenv</methodname>
      <methodparam><type>string</type><parameter>varname</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the value of the environment variable
     <parameter>varname</parameter>, or &false; on an error.

     <informalexample>
      <programlisting>
$ip = getenv ("REMOTE_ADDR"); // get the ip number of the user 
      </programlisting>
     </informalexample>
    </para>
    <para>
     You can see a list of all the environmental variables by using
     <function>phpinfo</function>. You can find out what many of them
     mean by taking a look at the <ulink url="&url.cgispecs;">CGI
			specification</ulink>, specifically the <ulink
			url="&url.cgispec;">page on
			environmental variables</ulink>.
     <note>
      <para>
       This function does not work in ISAPI mode.
      </para>
     </note>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.get-cfg-var">
   <refnamediv>
    <refname>get_cfg_var</refname>
    <refpurpose>
     Get the value of a PHP configuration option.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>get_cfg_var</methodname>
      <methodparam><type>string</type><parameter>varname</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     Returns the current value of the PHP configuration variable
     specified by <parameter>varname</parameter>, or &false; if an error
     occurs.
    </simpara>
    <simpara>
     It will not return configuration information set when the PHP was
     compiled, or read from an Apache configuration file (using the
     php3_configuration_option directives).
    </simpara>
    <simpara>
     To check whether the system is using a <link
			linkend="configuration.file">configuration file</link>, try
     retrieving the value of the cfg_file_path configuration
     setting. If this is available, a configuration file is being
     used.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.get-current-user">
   <refnamediv>
    <refname>get_current_user</refname>
    <refpurpose>
     Get the name of the owner of the current PHP script.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>get_current_user</methodname>
      <void/>
     </methodsynopsis>
    <simpara>
     Returns the name of the owner of the current PHP script.
    </simpara>
    <simpara>
     See also <function>getmyuid</function>,
     <function>getmypid</function>, <function>getmyinode</function>,
     and <function>getlastmod</function>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.get-magic-quotes-gpc">
   <refnamediv>
    <refname>get_magic_quotes_gpc</refname>
    <refpurpose>
     Get the current active configuration setting of magic quotes gpc.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>long</type><methodname>get_magic_quotes_gpc</methodname>
      <void/>
     </methodsynopsis>
    <simpara>
     Returns the current active configuration setting of 
     <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link>.
     (0 for off, 1 for on).
    </simpara>
    <simpara>
     See also <function>get_magic_quotes_runtime</function>,
     <function>set_magic_quotes_runtime</function>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.get-magic-quotes-runtime">
   <refnamediv>
    <refname>get_magic_quotes_runtime</refname>
    <refpurpose>
     Get the current active configuration setting of
     magic_quotes_runtime.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>long</type><methodname>get_magic_quotes_runtime</methodname>
      <void/>
     </methodsynopsis>
    <simpara>
     Returns the current active configuration setting of 
     <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>.
     (0 for off, 1 for on).
    </simpara>
    <simpara>
     See also <function>get_magic_quotes_gpc</function>,
     <function>set_magic_quotes_runtime</function>.
    </simpara>
   </refsect1>
  </refentry>
  
  <refentry id="function.getlastmod">
   <refnamediv>
    <refname>getlastmod</refname>
    <refpurpose>Get time of last page modification.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>getlastmod</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Returns the time of the last modification of the current
     page. The value returned is a Unix timestamp, suitable for
     feeding to <function>date</function>. Returns &false; on error.
     <example>
      <title>getlastmod() example</title>
      <programlisting role="php">
// outputs e.g. 'Last modified: March 04 1998 20:43:59.'
echo "Last modified: ".date ("F d Y H:i:s.", getlastmod());
      </programlisting>
     </example>
    </para>
    <para>
     See alse <function>date</function>,
     <function>getmyuid</function>,
     <function>get_current_user</function>,
     <function>getmyinode</function>, and
     <function>getmypid</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.getmyinode">
   <refnamediv>
    <refname>getmyinode</refname>
    <refpurpose>Get the inode of the current script.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>getmyinode</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Returns the current script's inode, or &false; on error.
    </para>
    <para>
     See also <function>getmyuid</function>,
     <function>get_current_user</function>,
     <function>getmypid</function>, and
     <function>getlastmod</function>.
    </para>
    <note>
     <simpara>
			This function is not supported on Windows systems.
     </simpara>
    </note>
   </refsect1>
  </refentry>

  <refentry id="function.getmypid">
   <refnamediv>
    <refname>getmypid</refname>
    <refpurpose>Get PHP's process ID.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>getmypid</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Returns the current PHP process ID, or &false; on error.
    </para>
    <warning>
     <para>
      Process IDs are not unique, thus they are a weak entropy 
      source. We recommend against relying on pids in 
      security-dependent contexts.
     </para>
    </warning>
    <para>
     See also <function>getmyuid</function>,
     <function>get_current_user</function>,
     <function>getmyinode</function>, and
     <function>getlastmod</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.getmyuid">
   <refnamediv>
    <refname>getmyuid</refname>
    <refpurpose>Get PHP script owner's UID.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>getmyuid</methodname>
      <void/>
     </methodsynopsis>
    <simpara>
     Returns the user ID of the current script, or &false; on error.
    </simpara>
    <simpara>
     See also <function>getmypid</function>,
     <function>get_current_user</function>,
     <function>getmyinode</function>, and
     <function>getlastmod</function>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.getrusage">
   <refnamediv>
    <refname>getrusage</refname>
    <refpurpose>Get the current resource usages.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>getrusage</methodname>
      <methodparam choice="opt"><type>int</type><parameter>who</parameter></methodparam>
     </methodsynopsis>
    <para>
     This is an interface to getrusage(2). It returns an associative
     array containing the data returned from the system call. If who
     is 1, getrusage will be called with RUSAGE_CHILDREN.
    </para>
    <para>
     All entries are accessible by using their documented field names.
     <example>
      <title>Getrusage Example</title>
      <programlisting role="php">
$dat = getrusage();
echo $dat["ru_nswap"];         # number of swaps
echo $dat["ru_majflt"];        # number of page faults
echo $dat["ru_utime.tv_sec"];  # user time used (seconds)
echo $dat["ru_utime.tv_usec"]; # user time used (microseconds)
      </programlisting>
     </example>
     See your system's man page on getrusage(2) for more details. 
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ini-alter">
   <refnamediv>
    <refname>ini_alter</refname>
    <refpurpose>Change the value of a configuration option</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>ini_alter</methodname>
      <methodparam><type>string</type><parameter>varname</parameter></methodparam>
      <methodparam><type>string</type><parameter>newvalue</parameter></methodparam>
     </methodsynopsis>
    <para>
     Changes the value of a configuration option, returns
     &false; on failure, and the previous value of the
     configuration option on success.
    </para>
    <note>
     <para>
      This is an alias of <function>ini_set</function>
     </para>
    </note>
    <para>
     See also <function>ini_get</function>,
     <function>ini_restore</function>,
     <function>ini_set</function>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ini-get">
   <refnamediv>
    <refname>ini_get</refname>
    <refpurpose>Get the value of a configuration option</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>ini_get</methodname>
      <methodparam><type>string</type><parameter>varname</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the value of the configuration option on success,
     &false; on failure.
    </para>
    <para>
     See also <function>ini_alter</function>,
     <function>ini_restore</function>,
     <function>ini_set</function>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ini-restore">
   <refnamediv>
    <refname>ini_restore</refname>
    <refpurpose>Restore the value of a configuration option</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>ini_restore</methodname>
      <methodparam><type>string</type><parameter>varname</parameter></methodparam>
     </methodsynopsis>
    <para>
     Restores a given configuration option to its original value.
    </para>
    <para>
     See also <function>ini_alter</function>,
     <function>ini_get</function>,
     <function>ini_set</function>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ini-set">
   <refnamediv>
    <refname>ini_set</refname>
    <refpurpose>Set the value of a configuration option</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>ini_set</methodname>
      <methodparam><type>string</type><parameter>varname</parameter></methodparam>
      <methodparam><type>string</type><parameter>newvalue</parameter></methodparam>
     </methodsynopsis>
    <para>
     Sets the value of the given configuration option. Returns the old
     value on success, &false; on failure.
    </para>
    <para>
     See also <function>ini_alter</function>,
     <function>ini_get</function>,
     <function>ini_restore</function>
    </para>
   </refsect1>
  </refentry>
  
  <refentry id="function.phpcredits">
   <refnamediv>
    <refname>phpcredits</refname>
    <refpurpose>Prints out the credits for PHP.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>phpcredits</methodname>
      <methodparam><type>int</type><parameter>flag</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function prints out the credits listing the PHP developers,
     modules, etc. It generates the appropriate HTML codes to insert
     the information in a page. A parameter indicating what will be
     printed (a pre-defined constant flag, see table below) needs
     to be passed. For example to print the general credits, you will
     use somewhere in your code:
     <informalexample>
      <programlisting role="php">
...
phpcredits(CREDITS_GENERAL);
...
      </programlisting>
     </informalexample>
     And if you want to print the core developers and the documentation
     group, in a page of its own, you will use:
     <informalexample>
      <programlisting role="php">
&lt;?php
phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE);
?&gt;  
      </programlisting>
     </informalexample>
     And if you feel like embedding all the credits in your page, then
     code like the one below will do it:
     <informalexample>
      <programlisting role="php">
&lt;html&gt;
 &lt;head&gt;
  &lt;title&gt;My credits page&lt;/title&gt;
 &lt;/head&gt;
 &lt;body&gt;
  &lt;?php
	// some code of your own
	phpcredits(CREDITS_ALL + CREDITS_FULLPAGE);
	// some more code
	?&gt;
 &lt;/body&gt;
&lt;/html&gt;
      </programlisting>
     </informalexample>
    </para>
    <para>
    </para>
    <para>
		 <table>
      <title>Pre-defined <function>phpcredits</function> flags</title>
      <tgroup cols="2">
       <thead>
				<row>
				 <entry>name</entry>
				 <entry>description</entry>
				</row>
       </thead>
       <tbody>
				<row>
				 <entry>CREDITS_ALL</entry>
				 <entry>
					All the credits, equivalent to using: CREDITS_DOCS + CREDITS_GENERAL + 
					CREDITS_GROUP + CREDITS_MODULES + CREDITS_FULLPAGE. It generates a
					complete stand-alone HTML page with the appropriate tags.
				 </entry>
				</row>
				<row>
				 <entry>CREDITS_DOCS</entry>
				 <entry>The credits for the documentation team</entry>
				</row>
				<row>
				 <entry>CREDITS_FULLPAGE</entry>
				 <entry>
					Usually used in combination with the other flags.
					Indicates that the a complete stand-alone HTML page
					needs to be printed including the information indicated
					by the other flags.
				 </entry>
				</row>
				<row>
				 <entry>CREDITS_GENERAL</entry>
				 <entry>
					General credits: Language design and concept, PHP 4.0 authors
					and SAPI module.
				 </entry>
				</row>
				<row>
				 <entry>CREDITS_GROUP</entry>
				 <entry>A list of the core developers</entry>
				</row>
				<row>
				 <entry>CREDITS_MODULES</entry>
				 <entry>A list of the extension modules for PHP, and their authors</entry>
				</row>
				<row>
				 <entry>CREDITS_SAPI</entry>
				 <entry>A list of the server API modules for PHP, and their authors</entry>
				</row>
       </tbody>
      </tgroup>
     </table>
    </para>
    <para>
     See also <function>phpinfo</function>,
     <function>phpversion</function>,
     <function>php_logo_guid</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.phpinfo">
   <refnamediv>
    <refname>phpinfo</refname>
    <refpurpose>Output lots of PHP information.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>phpinfo</methodname>
      <methodparam choice="opt"><type>int</type><parameter>what</parameter></methodparam>
     </methodsynopsis>
    <para>
     Outputs a large amount of information about the current state of
     PHP. This includes information about PHP compilation options and
     extensions, the PHP version, server information and environment
     (if compiled as a module), the PHP environment, OS version
     information, paths, master and local values of configuration
     options, HTTP headers, and the PHP License.
    </para>
	  <para>
		 The output may be customized by passing one or more of the
     following values ored together in the optional parameter
     <parameter>what</parameter>. 
		 <itemizedlist>
		  <listitem><simpara>INFO_GENERAL</simpara></listitem>
		  <listitem><simpara>INFO_CREDITS</simpara></listitem>
		  <listitem><simpara>INFO_CONFIGURATION</simpara></listitem>
		  <listitem><simpara>INFO_MODULES</simpara></listitem>
		  <listitem><simpara>INFO_ENVIRONMENT</simpara></listitem>
		  <listitem><simpara>INFO_VARIABLES</simpara></listitem>
		  <listitem><simpara>INFO_LICENSE</simpara></listitem>
		  <listitem><simpara>INFO_ALL</simpara></listitem>
		 </itemizedlist>
	  </para>
    <para>
     See also <function>phpversion</function>,
     <function>phpcredits</function>,
     <function>php_logo_guid</function>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.phpversion">
   <refnamediv>
    <refname>phpversion</refname>
    <refpurpose>Get the current PHP version.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>phpversion</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Returns a string containing the version of the currently running
     PHP parser.
     <example>
      <title>phpversion() example</title>
      <programlisting role="php">
// prints e.g. 'Current PHP version: 3.0rel-dev'
echo "Current PHP version: ".phpversion();
      </programlisting>
     </example>
    </para>
    <para>
     See also <function>phpinfo</function>, 
     <function>phpcredits</function>,
     <function>php_logo_guid</function>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.php-logo-guid">
   <refnamediv>
    <refname>php_logo_guid</refname>
    <refpurpose>Get the logo guid</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>php_logo_guid</methodname>
      <void/>
     </methodsynopsis>
    <para>
     <note>
      <para>
       This funcionality was added in PHP 4 Beta 4.
      </para>
     </note>
    </para>
    <para>
     See also <function>phpinfo</function>.
     <function>phpversion</function>,
     <function>phpcredits</function>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.php-sapi-name">
   <refnamediv>
    <refname>php_sapi_name</refname>
    <refpurpose>
     Returns the type of interface between web server and PHP
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>php_sapi_name</methodname>
      <void/>
     </methodsynopsis>
    <simpara>
     <function>php_sapi_name</function> returns a lowercase string which
     describes the type of interface between web server and PHP
     (Server API, SAPI). In CGI PHP, this string is "cgi", in
     mod_php for Apache, this string is "apache" and so on.
    </simpara>
    <para>
     <example>
      <title><function>php_sapi_name</function> Example</title>
      <programlisting role="php">
$sapi_type = php_sapi_name();
if ($sapi_type == "cgi")
  print "You are using CGI PHP\n";
else
  print "You are not using CGI PHP\n";
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.php-uname">
   <refnamediv>
    <refname>php_uname</refname>
    <refpurpose>
     Returns information about the operating system PHP was built on
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>php_uname</methodname>
      <void/>
     </methodsynopsis>
    <simpara>
     <function>php_uname</function> returns a string with a description
     of the operating system PHP is built on.
    </simpara>
    <para>
     <example>
      <title><function>php_uname</function> Example</title>
      <programlisting role="php">
if (substr(php_uname(), 0, 7) == "Windows") {
  die("Sorry, this script doesn't run on Windows.\n");
}
			</programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.putenv">
   <refnamediv>
    <refname>putenv</refname>
    <refpurpose>Set the value of an environment variable.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>putenv</methodname>
      <methodparam><type>string</type><parameter>setting</parameter></methodparam>
     </methodsynopsis>
    <para>
     Adds <parameter>setting</parameter> to the server environment.
    </para>
    <para>
     <example>
      <title>Setting an Environment Variable</title>
      <programlisting role="php">
putenv ("UNIQID=$uniqid");
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.set-magic-quotes-runtime">
   <refnamediv>
    <refname>set_magic_quotes_runtime</refname>
    <refpurpose>
     Set the current active configuration setting of
     magic_quotes_runtime.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>long</type><methodname>set_magic_quotes_runtime</methodname>
      <methodparam><type>int</type><parameter>new_setting</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     Set the current active configuration setting of <link
			linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>.
     (0 for off, 1 for on)
    </simpara>
    <simpara>
     See also <function>get_magic_quotes_gpc</function>,
     <function>get_magic_quotes_runtime</function>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.set-time-limit">
   <refnamediv>
    <refname>set_time_limit</refname>
    <refpurpose>limit the maximum execution time</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>set_time_limit</methodname>
      <methodparam><type>int</type><parameter>seconds</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     Set the number of seconds a script is allowed to run.  If this is
     reached, the script returns a fatal error.  The default limit is
     30 seconds or, if it exists, the max_execution_time value defined
     in the <link linkend="configuration.file">configuration
			file</link>.  If seconds is set to zero, no time limit is
     imposed.
    </simpara>
    <simpara>
     When called, <function>set_time_limit</function> restarts the
     timeout counter from zero. In other words, if the timeout is the
     default 30 seconds, and 25 seconds into script execution a call
     such as set_time_limit(20) is made, the script will run for a
     total of 45 seconds before timing out.
    </simpara>
    <simpara>
     Note that <function>set_time_limit</function> has no effect when
     PHP is running in safe mode. There is no workaround other than
     turning off safe mode or changing the time limit in the <link
			linkend="configuration.file">configuration file</link>.
    </simpara>
   </refsect1>
  </refentry>

  <refentry id="function.zend-logo-guid">
   <refnamediv>
    <refname>zend_logo_guid</refname>
    <refpurpose>Get the zend guid</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>zend_logo_guid</methodname>
      <void/>
     </methodsynopsis>
    <para>
     <note>
      <para>
       This funcionality was added in PHP 4 Beta 4.
      </para>
     </note>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.get-loaded-extensions">
   <refnamediv>
    <refname>get_loaded_extensions</refname>
    <refpurpose>
     Returns an array with the names of all modules compiled and
     loaded
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>get_loaded_extensions</methodname>
      <void/>
     </methodsynopsis>
    <para>
     This function returns the names of all the modules compiled and
     loaded in the PHP interpreter.
    </para>
    <para>
     For example the line below
     <informalexample>
      <programlisting>
print_r (get_loaded_extensions());
      </programlisting>
     </informalexample>
     will print a list like:
     <informalexample>
      <programlisting>
Array
(
    [0] =&gt; xml
    [1] =&gt; wddx
    [2] =&gt; standard
	  [3] =&gt; session
	  [4] =&gt; posix
	  [5] =&gt; pgsql
	  [6] =&gt; pcre
	  [7] =&gt; gd
	  [8] =&gt; ftp
	  [9] =&gt; db
	  [10] =&gt; Calendar
	  [11] =&gt; bcmath
)
      </programlisting>
     </informalexample>
    </para>
    <para>
     See also: <function>get_extension_funcs</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.get-extension-funcs">
   <refnamediv>
    <refname>get_extension_funcs</refname>
    <refpurpose>
     Returns an array with the names of the functions of a module
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>get_extension_funcs</methodname>
      <methodparam><type>string</type><parameter>module_name</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function returns the names of all the functions defined in
     the module indicated by <parameter>module_name</parameter>.
    </para>
    <para>
     For example the lines below
     <informalexample>
      <programlisting>
print_r (get_extension_funcs (&quot;xml&quot;));
print_r (get_extension_funcs (&quot;gd&quot;));
			</programlisting>
     </informalexample>
     will print a list of the functions in the modules
     <varname>xml</varname> and <varname>gd</varname> respectively.
    </para>
    <para>
     See also: <function>get_loaded_extensions</function>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.get-required-files">
   <refnamediv>
    <refname>get_required_files</refname>
    <refpurpose>
     Returns an array with the names of the files require_once()'d in
     a script
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>get_required_files</methodname>
      <void/>
     </methodsynopsis>
    <para>
     This function returns an associtative array of the names of all
     the files that have been loaded into a script using
     <function>require_once</function>. The indexes of the array are
     the file names as used in the <function>require_once</function>
     without the &quot;.php&quot; extension.
    </para>
    <para>
     The example below
     <example>
      <title>Printing the required and included files</title>
      <programlisting>
&lt;?php

require_once (&quot;local.php&quot;);
require_once (&quot;../inc/global.php&quot;);

for ($i=1; $i&lt;5; $i++)
  include &quot;util&quot;.$i.&quot;php&quot;;

  echo &quot;Required_once files\n&quot;;
  print_r (get_required_files());

  echo &quot;Included_once files\n&quot;;
  print_r (get_included_files());
?&gt;
      </programlisting>
     </example>
     will generate the following output:
     <informalexample>
      <programlisting>
Required_once files
Array
(
  [local] =&gt; local.php 
  [../inc/global] =&gt; /full/path/to/inc/global.php
)

Included_once files
Array
(
    [util1] =&gt; util1.php 
    [util2] =&gt; util2.php 
    [util3] =&gt; util3.php 
    [util4] =&gt; util4.php 
)
      </programlisting>
     </informalexample>
    </para>
    <para>
     <note>
      <para>
       As of PHP 4.0.1pl2 this function assumes that the
       <varname>required_once</varname> files end in the extension
       &quot;.php&quot;, other extensions do not work.
      </para>
     </note>
    </para>
    <para>
     See also: <function>require_once</function>,
     <function>include_once</function>,
     <function>get_included_files</function>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.get-included-files">
   <refnamediv>
    <refname>get_included_files</refname>
    <refpurpose>
     Returns an array with the names of the files include_once()'d in
     a script
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>get_included_files</methodname>
      <void/>
     </methodsynopsis>
    <para>
     This function returns an associtative array of the names of all
     the files that have been loaded into a script using
     <function>include_once</function>. The indexes of the array are
     the file names as used in the <function>include_once</function>
     without the &quot;.php&quot; extension.
    </para>
    <para>
     <note>
      <para>
       As of PHP 4.0.1pl2 this function assumes that the
       <varname>include_once</varname> files end in the extension
       &quot;.php&quot;, other extensions do not work.
      </para>
     </note>
    </para>
    <para>
     See also: <function>require_once</function>,
     <function>include_once</function>,
     <function>get_required_files</function>
    </para>
   </refsect1>
  </refentry>

 </reference>

 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
 sgml-omittag:t
 sgml-shorttag:t
 sgml-minimize-attributes:nil
 sgml-always-quote-attributes:t
 sgml-indent-step:1
 sgml-indent-data:t
indent-tabs-mode:nil
 sgml-parent-document:nil
 sgml-default-dtd-file:"../../manual.ced"
 sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil
 End:
 -->