2008-01-21 15:23:52 +00:00
|
|
|
<?xml version="1.0" encoding="utf-8"?>
|
2009-07-11 08:40:37 +00:00
|
|
|
<!-- $Revision$ -->
|
2008-01-21 21:54:18 +00:00
|
|
|
<refentry xml:id="phar.mungserver" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
2008-01-21 15:23:52 +00:00
|
|
|
<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>
|
2013-06-18 05:36:30 +00:00
|
|
|
<modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>void</type><methodname>Phar::mungServer</methodname>
|
2021-05-23 17:38:16 +00:00
|
|
|
<methodparam><type>array</type><parameter>variables</parameter></methodparam>
|
2008-01-21 15:23:52 +00:00
|
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
|
|
<function>Phar::mungServer</function> should only be called within the
|
|
|
|
stub of a phar archive.
|
|
|
|
</para>
|
|
|
|
<para>
|
2008-08-23 15:40:25 +00:00
|
|
|
Defines a list of up to 4 <varname>$_SERVER</varname> variables that should be
|
2008-01-21 15:23:52 +00:00
|
|
|
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>
|
2021-05-23 17:38:16 +00:00
|
|
|
<term><parameter>variables</parameter></term>
|
2008-01-21 15:23:52 +00:00
|
|
|
<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
|
2009-09-25 07:04:39 +00:00
|
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
2008-01-21 15:23:52 +00:00
|
|
|
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
|
|
|
|
-->
|