mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Initial Revision
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@185546 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sara Golemon
parent
ba1df81c88
commit
306d2335be
4 changed files with 527 additions and 0 deletions
200
reference/runkit/constants.xml
Normal file
200
reference/runkit/constants.xml
Normal file
|
|
@ -0,0 +1,200 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<section id="runkit.constants">
|
||||
&reftitle.constants;
|
||||
&extension.constants;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>RUNKIT_IMPORT_FUNCTIONS</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<function>runkit_import</function> flag
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>RUNKIT_IMPORT_CLASS_METHODS</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<function>runkit_import</function> flag
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>RUNKIT_IMPORT_CLASS_CONSTS</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<function>runkit_import</function> flag
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>RUNKIT_IMPORT_CLASS_PROPS</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<function>runkit_import</function> flag
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>RUNKIT_IMPORT_CLASSES</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<function>runkit_import</function> flag
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>RUNKIT_IMPORT_OVERRIDE</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<function>runkit_import</function> flag
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>RUNKIT_ACC_PUBLIC</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
PHP5 specific flag to <function>runkit_method_add</function>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>RUNKIT_ACC_PROTECTED</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
PHP5 specific flag to <function>runkit_method_add</function>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>RUNKIT_ACC_PRIVATE</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
PHP5 specific flag to <function>runkit_method_add</function>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>CLASSKIT_ACC_PUBLIC</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
PHP5 specific flag to <function>classkit_method_add</function>
|
||||
Only defined when classkit compatability is enabled.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>CLASSKIT_ACC_PROTECTED</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
PHP5 specific flag to <function>classkit_method_add</function>
|
||||
Only defined when classkit compatability is enabled.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>CLASSKIT_ACC_PRIVATE</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
PHP5 specific flag to <function>classkit_method_add</function>
|
||||
Only defined when classkit compatability is enabled.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>CLASSKIT_AGGREGATE_OVERRIDE</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
PHP5 specific flag to <function>classkit_import</function>
|
||||
Only defined when classkit compatability is enabled.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>RUNKIT_VERSION</constant>
|
||||
(<type>string</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Defined to the current version of the runkit package.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<constant>CLASSKIT_VERSION</constant>
|
||||
(<type>string</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
Defined to the current version of the runkit package.
|
||||
Only defined when classkit compatability is enabled.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
|
||||
<!-- 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
|
||||
-->
|
||||
114
reference/runkit/functions/runkit-class-adopt.xml
Normal file
114
reference/runkit/functions/runkit-class-adopt.xml
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.runkit-class-adopt">
|
||||
<refnamediv>
|
||||
<refname>runkit_class_adopt</refname>
|
||||
<refpurpose>
|
||||
Convert a base class to an inherited class, add ancestral methods when appropriate
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>runkit_class_adopt</methodname>
|
||||
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>parentname</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>classname</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of class to be adopted
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>parentname</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Parent class which child class is extending
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title>A <function>runkit_class_adopt</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
class myParent {
|
||||
function parentFunc() {
|
||||
echo "Parent Function Output\n";
|
||||
}
|
||||
}
|
||||
|
||||
class myChild {
|
||||
}
|
||||
|
||||
runkit_class_adopt('myChild','myParent');
|
||||
myChild::parentFunc();
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Parent Function Output
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>runkit_class_emancipate</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:"../../../../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
|
||||
-->
|
||||
105
reference/runkit/functions/runkit-class-emancipate.xml
Normal file
105
reference/runkit/functions/runkit-class-emancipate.xml
Normal file
|
|
@ -0,0 +1,105 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.runkit-class-emancipate">
|
||||
<refnamediv>
|
||||
<refname>runkit_class_emancipate</refname>
|
||||
<refpurpose>
|
||||
Convert an inherited class to a base class, removes any method whose scope is ancestral
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>runkit_class_emancipate</methodname>
|
||||
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>classname</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of class to emancipate
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title>A <function>runkit_class_emancipate</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
class myParent {
|
||||
function parentFunc () {
|
||||
echo "Parent Function Output\n";
|
||||
}
|
||||
}
|
||||
class myChild extends myParent {
|
||||
}
|
||||
|
||||
myChild::parentFunc();
|
||||
runkit_class_emancipate('myChild');
|
||||
myChild::parentFunc();
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Parent Function Output
|
||||
Fatal error: Call to undefined function: parentFunc() in example.php on line 12
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>runkit_class_adopt</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:"../../../../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
|
||||
-->
|
||||
108
reference/runkit/reference.xml
Normal file
108
reference/runkit/reference.xml
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- 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 compatable 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
|
||||
-->
|
||||
Loading…
Reference in a new issue