File: language-snippets.ent

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 (77 lines) | stat: -rw-r--r-- 3,488 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
<!-- $Revision: 1.1 $ -->

<!ENTITY warn.experimental '<warning><simpara>This extension is
<emphasis>EXPERIMENTAL</emphasis>. The behaviour of this extension,
including the names of its functions, and anything else documented
about this extension may change in a future release of PHP without
notice.  Be warned and use this extension at your own
risk.</simpara></warning>'>

<!ENTITY warn.experimental.func '<warning><simpara>This function is
<emphasis>EXPERIMENTAL</emphasis>. The behaviour of this function, the
name of this function, and anything else documented about this
function may change in a future release of PHP without notice.  Be
warned and use this function at your own risk.</simpara></warning>'>

<!ENTITY warn.undocumented.func '<warning><simpara>This function is
currently not documented, only the argument list is
available.</simpara></warning>'>

<!ENTITY tip.ob-capture '<tip><simpara>As with anything that outputs
its result directly to the browser, you can use the <link
linkend="ref.outcontrol">output-control functions</link> to capture
the output of this function, and save it - for example - in a
<type>string</type>.</simpara></tip>'>

<!ENTITY tip.fopen-wrapper '<tip><simpara>You can use a URL as a
filename with this function if the "fopen wrappers" have been enabled.
See <function>fopen</function> for more details.</simpara></tip>'>

<!ENTITY return.success 'Returns &true; on success, &false; on failure.'>

<!ENTITY return.falseproblem '<warning><simpara>This function may
return &false;, but may also return a value evaluating to &false; in a
simple if statement. Please use <link
linkend="language.operators.comparison">the === operator</link> for
testing the return value of this function.</simpara></warning>'>    

<!-- Various notes -->
<!ENTITY note.not-bin-safe '<warning><simpara>This function
is not (yet) binary safe!</simpara></warning>'>

<!ENTITY note.bin-safe '<note><simpara>This function is
binary-safe.</simpara></note>'>

<!ENTITY note.no-windows '<note><simpara>This function is not
implemented on Windows platforms.</simpara></note>'>

<!ENTITY note.func-callback '<note><simpara>Instead of a function name, an
array containing an object reference and a method name can also be
supplied.</simpara></note>'>

<!-- Notes for safe-mode limited functions: -->
<!ENTITY note.sm.disabled '<note><simpara>&sm.disabled;</simpara></note>'>

<!ENTITY note.sm.uidcheck '<note><simpara>When <link 
linkend="features.safe-mode">safe mode</link> is enabled, PHP checks whether 
the file(s)/directories you are about to operate on have the same UID as the 
script that is being executed.</simpara></note>'>

<!ENTITY note.sm.uidcheck.dir '<note><simpara>When <link 
linkend="features.safe-mode">safe mode</link> is enabled, PHP checks whether 
the directory in which you are about to operate has the same UID as the 
script that is being executed.</simpara></note>'>

<!-- Common pieces in features/safe-mode.xml 
     Jade doesn't allow in-line entities, so I put them here... Though they 
     should have been inline in safe-mode.xml -->
<!ENTITY sm.uidcheck 'Checks whether the file(s)/directories you are 
about to operate on have the same UID as the script that is being
executed.'>

<!ENTITY sm.uidcheck.dir 'Checks whether the directory in which
you are about to operate has the same UID as the script that is being
executed.'>

<!ENTITY sm.disabled 'This function is disabled in <link 
linkend="features.safe-mode">safe mode</link>.'>