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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 288721 $ -->
<refentry xml:id="phar.mungserver" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Phar::mungServer</refname>
<refpurpose>Defines a list of up to 4 $_SERVER variables that should be modified for execution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>Phar::mungServer</methodname>
<methodparam><type>array</type><parameter>munglist</parameter></methodparam>
</methodsynopsis>
<para>
<function>Phar::mungServer</function> should only be called within the
stub of a phar archive.
</para>
<para>
Defines a list of up to 4 <varname>$_SERVER</varname> variables that should be
modified for execution.
Variables that can be modified to remove traces of phar execution are
<literal>REQUEST_URI</literal>, <literal>PHP_SELF</literal>,
<literal>SCRIPT_NAME</literal> and <literal>SCRIPT_FILENAME</literal>.
</para>
<para>
On its own, this method does nothing. Only when combined with
<function>Phar::webPhar</function> does it take effect, and only when the requested
file is a PHP file to be parsed. Note that the
<literal>PATH_INFO</literal> and <literal>PATH_TRANSLATED</literal> variables
are always modified.
</para>
<para>
The original values of variables that are modified are stored in the SERVER
array with <literal>PHAR_</literal> prepended, so for instance
<literal>SCRIPT_NAME</literal> would be saved as <literal>PHAR_SCRIPT_NAME</literal>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>munglist</parameter></term>
<listitem>
<para>
an array containing as string indices any of
<literal>REQUEST_URI</literal>, <literal>PHP_SELF</literal>,
<literal>SCRIPT_NAME</literal> and <literal>SCRIPT_FILENAME</literal>.
Other values trigger an exception, and <function>Phar::mungServer</function>
is case-sensitive.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
No return.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>UnexpectedValueException</classname> if any problems are
found with the passed in data.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>Phar::mungServer</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// example stub
Phar::mungServer(array('REQUEST_URI'));
Phar::webPhar();
__HALT_COMPILER();
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::webPhar</function></member>
<member><function>Phar::setStub</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
