From 5314e61574e6284fa50fa1489c1cb069c2886154 Mon Sep 17 00:00:00 2001
From: Sara Golemon <pollita@php.net>
Date: Sun, 1 May 2005 06:24:46 +0000
Subject: [PATCH] Initial Revision

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@185551 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../runkit/functions/runkit-function-add.xml  | 119 +++++++++++++++++
 .../runkit/functions/runkit-function-copy.xml | 111 ++++++++++++++++
 .../functions/runkit-function-redefine.xml    | 120 ++++++++++++++++++
 .../functions/runkit-function-remove.xml      |  74 +++++++++++
 .../functions/runkit-function-rename.xml      |  83 ++++++++++++
 5 files changed, 507 insertions(+)
 create mode 100644 reference/runkit/functions/runkit-function-add.xml
 create mode 100644 reference/runkit/functions/runkit-function-copy.xml
 create mode 100644 reference/runkit/functions/runkit-function-redefine.xml
 create mode 100644 reference/runkit/functions/runkit-function-remove.xml
 create mode 100644 reference/runkit/functions/runkit-function-rename.xml

diff --git a/reference/runkit/functions/runkit-function-add.xml b/reference/runkit/functions/runkit-function-add.xml
new file mode 100644
index 0000000000..03c0d164b3
--- /dev/null
+++ b/reference/runkit/functions/runkit-function-add.xml
@@ -0,0 +1,119 @@
+<?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-function-add">
+ <refnamediv>
+  <refname>runkit_function_add</refname>
+  <refpurpose>
+   Add a new function, similar to <function>create_function</function>
+  </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>runkit_function_add</methodname>
+   <methodparam><type>string</type><parameter>funcname</parameter></methodparam>
+   <methodparam><type>string</type><parameter>arglist</parameter></methodparam>
+   <methodparam><type>string</type><parameter>code</parameter></methodparam>
+  </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>funcname</parameter></term>
+     <listitem>
+      <para>
+       Name of function to be created
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>arglist</parameter></term>
+     <listitem>
+      <para>
+       Coma separated argument list
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>code</parameter></term>
+     <listitem>
+      <para>
+       Code making up the function
+      </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_function_add</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+create_function('testme','$a,$b','echo "The value of a is $a\n"; echo "The value of b is $b\n";');
+testme(1,2);
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+The value of a is 1
+The value of b is 2
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>create_function</function></member>
+    <member><function>runkit_function_redefine</function></member>
+    <member><function>runkit_function_copy</function></member>
+    <member><function>runkit_function_rename</function></member>
+    <member><function>runkit_function_remove</function></member>
+    <member><function>runkit_method_add</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
+-->
diff --git a/reference/runkit/functions/runkit-function-copy.xml b/reference/runkit/functions/runkit-function-copy.xml
new file mode 100644
index 0000000000..e07f8c4a5c
--- /dev/null
+++ b/reference/runkit/functions/runkit-function-copy.xml
@@ -0,0 +1,111 @@
+<?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-function-copy">
+ <refnamediv>
+  <refname>runkit_function_copy</refname>
+  <refpurpose>
+   Copy a function to a new function name
+  </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>runkit_function_copy</methodname>
+   <methodparam><type>string</type><parameter>funcname</parameter></methodparam>
+   <methodparam><type>string</type><parameter>targetname</parameter></methodparam>
+  </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>funcname</parameter></term>
+     <listitem>
+      <para>
+       Name of existing function
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>targetname</parameter></term>
+     <listitem>
+      <para>
+       Name of new function to copy definition to
+      </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_function_copy</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+function original() {
+  echo "In a function\n";
+}
+runkit_function_copy('original','duplicate');
+original();
+duplicate();
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+In a function
+In a function
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>runkit_function_add</function></member>
+    <member><function>runkit_function_redefine</function></member>
+    <member><function>runkit_function_rename</function></member>
+    <member><function>runkit_function_remove</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
+-->
diff --git a/reference/runkit/functions/runkit-function-redefine.xml b/reference/runkit/functions/runkit-function-redefine.xml
new file mode 100644
index 0000000000..b22daccac1
--- /dev/null
+++ b/reference/runkit/functions/runkit-function-redefine.xml
@@ -0,0 +1,120 @@
+<?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-function-redefine">
+ <refnamediv>
+  <refname>runkit_function_redefine</refname>
+  <refpurpose>
+   Replace a function definition with a new implementation
+  </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>runkit_function_redefine</methodname>
+   <methodparam><type>string</type><parameter>funcname</parameter></methodparam>
+   <methodparam><type>string</type><parameter>arglist</parameter></methodparam>
+   <methodparam><type>string</type><parameter>code</parameter></methodparam>
+  </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>funcname</parameter></term>
+     <listitem>
+      <para>
+       Name of function to redefine
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>arglist</parameter></term>
+     <listitem>
+      <para>
+       New list of arguments to be accepted by function
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>code</parameter></term>
+     <listitem>
+      <para>
+       New code implementation
+      </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_function_redefine</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+function testme() {
+  echo "Original Testme Implementation\n";
+}
+testme();
+runkit_function_redefine('testme','','echo "New Testme Implementation\n";');
+testme();
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Original Testme Implementation
+New Testme Implementation
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>runkit_function_add</function></member>
+    <member><function>runkit_function_copy</function></member>
+    <member><function>runkit_function_rename</function></member>
+    <member><function>runkit_function_remove</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
+-->
diff --git a/reference/runkit/functions/runkit-function-remove.xml b/reference/runkit/functions/runkit-function-remove.xml
new file mode 100644
index 0000000000..eb4698bee6
--- /dev/null
+++ b/reference/runkit/functions/runkit-function-remove.xml
@@ -0,0 +1,74 @@
+<?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-function-remove">
+ <refnamediv>
+  <refname>runkit_function_remove</refname>
+  <refpurpose>
+   Remove a function definition
+  </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>runkit_function_remove</methodname>
+   <methodparam><type>string</type><parameter>funcname</parameter></methodparam>
+  </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>funcname</parameter></term>
+     <listitem>
+      <para>
+       Name of function to be deleted
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>runkit_function_add</function></member>
+    <member><function>runkit_function_copy</function></member>
+    <member><function>runkit_function_redefine</function></member>
+    <member><function>runkit_function_rename</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
+-->
diff --git a/reference/runkit/functions/runkit-function-rename.xml b/reference/runkit/functions/runkit-function-rename.xml
new file mode 100644
index 0000000000..e9caa4db16
--- /dev/null
+++ b/reference/runkit/functions/runkit-function-rename.xml
@@ -0,0 +1,83 @@
+<?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-function-rename">
+ <refnamediv>
+  <refname>runkit_function_rename</refname>
+  <refpurpose>
+   Change a function's name
+  </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>runkit_function_rename</methodname>
+   <methodparam><type>string</type><parameter>funcname</parameter></methodparam>
+   <methodparam><type>string</type><parameter>newname</parameter></methodparam>
+  </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>funcname</parameter></term>
+     <listitem>
+      <para>
+       Current function name
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>newname</parameter></term>
+     <listitem>
+      <para>
+       New function name
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>runkit_function_add</function></member>
+    <member><function>runkit_function_copy</function></member>
+    <member><function>runkit_function_redefine</function></member>
+    <member><function>runkit_function_remove</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
+-->