php-doc-en/reference/runkit/reference.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<reference id="ref.runkit">
 <title>runkit Functions</title>
 <titleabbrev>runkit</titleabbrev>

 <partintro>
  <section id="runkit.intro">
   &reftitle.intro;
   <simpara>
    The runkit extension provides means to modify constants,
    user-defined functions, and user-defined classes.
    It also provides for custom superglobal variables
    and embeddable sub-interpreters via sandboxing.
   </simpara>

   <simpara>
    &pecl.info;
    <ulink url="&url.pecl.package;runkit">&url.pecl.package;runkit</ulink>.
   </simpara>

   <simpara>
    This package is meant as a feature added replacement for the
    <ulink url="&url.pecl.package;classkit">classkit</ulink> package.
    When compiled with the <literal>--enable-runkit=classkit</literal>
    option to ./configure, it will export classkit compatible function definitions
    and constants.
   </simpara>
  </section>

  <section id="runkit.requirements">
   &reftitle.required;
   <simpara>
    <emphasis>Modifying Constants, Functions, Classes, and Methods</emphasis>
    works with all releases of PHP4 and PHP5.  No special requirements are necessary.
   </simpara>

   <simpara>
    <emphasis>Custom Superglobals</emphasis> are only available in PHP 4.2.0 or later.
   </simpara>

   <simpara>
    <emphasis>Sandboxing</emphasis> requires PHP 5.1.0 or later, or
    PHP 5.0.0 with a special TSRM patch applied.
    Regardless of which version of PHP is in use it must be compiled with the
    <literal>--enable-maintainer-zts</literal> option.
    See the <literal>README</literal> file in the runkit package for additional information.
   </simpara>
  </section>

  <section id="runkit.superglobal">
   <title>Custom Superglobals</title>

   <simpara>
    The <literal>runkit.superglobal</literal> ini option may be set to a
    coma-separated list of variable names to be treated as superglobals.
    This value should be set in the systemwide php.ini file, but may work
    in perdir configuration contexts depending on your SAPI.
   </simpara>

   <example>
    <title>Custom Superglobals with runkit.superglobal=_FOO,_BAR in php.ini</title>
    <programlisting role="php">
<![CDATA[
<?php
function show_values() {
  echo "Foo is $_FOO\n";
  echo "Bar is $_BAR\n";
  echo "Baz is $_BAZ\n";
}

$_FOO = 'foo';
$_BAR = 'bar';
$_BAZ = 'baz';

/* Displays foo and bar, but not baz */
show_values();
?>
]]>
    </programlisting>
   </example>
  </section>

 </partintro>
 &reference.runkit.functions;
</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:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->