sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 08:28:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update runkit7 function documentation, names

Browse source 
Closes GH-1194.
This commit is contained in:
Tyson Andre 2021-12-12 10:17:01 -05:00 committed by GitHub
parent 8d226f128f
commit 917c06eac8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 71 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
reference/runkit7/functions/runkit7-constant-add.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_constant_add</methodname>
<methodparam><type>string</type><parameter>constname</parameter></methodparam>
<methodparam><type>string</type><parameter>constant_name</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>newVisibility</parameter></methodparam>
</methodsynopsis>
@ -23,7 +23,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>constname</parameter></term>
<term><parameter>constant_name</parameter></term>
<listitem>
<para>
Name of constant to declare. Either a string to indicate a global constant,

8
reference/runkit7/functions/runkit7-constant-redefine.xml
View file

@ -11,9 +11,9 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_constant_redefine</methodname>
<methodparam><type>string</type><parameter>constname</parameter></methodparam>
<methodparam><type>string</type><parameter>constant_name</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>newVisibility</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>new_visibility</parameter></methodparam>
</methodsynopsis>
<para>
@ -24,7 +24,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>constname</parameter></term>
<term><parameter>constant_name</parameter></term>
<listitem>
<para>
Constant to redefine. Either the name of a global constant,
@ -41,7 +41,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newVisibility</parameter></term>
<term><parameter>new_visibility</parameter></term>
<listitem>
<para>
The new visibility of the constant, for class constants.

4
reference/runkit7/functions/runkit7-constant-remove.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_constant_remove</methodname>
<methodparam><type>string</type><parameter>constname</parameter></methodparam>
<methodparam><type>string</type><parameter>constant_name</parameter></methodparam>
</methodsynopsis>
</refsect1>
@ -21,7 +21,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>constname</parameter></term>
<term><parameter>constant_name</parameter></term>
<listitem>
<para>
Name of the constant to remove. Either the name of a global constant,

10
reference/runkit7/functions/runkit7-function-add.xml
View file

@ -13,8 +13,8 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_function_add</methodname>
<methodparam><type>string</type><parameter>funcname</parameter></methodparam>
<methodparam><type>string</type><parameter>arglist</parameter></methodparam>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
<methodparam><type>string</type><parameter>argument_list</parameter></methodparam>
<methodparam><type>string</type><parameter>code</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>return_by_reference</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>doc_comment</parameter><initializer>&null;</initializer></methodparam>
@ -23,7 +23,7 @@
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>runkit7_function_add</methodname>
<methodparam><type>string</type><parameter>funcname</parameter></methodparam>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
<methodparam><type>Closure</type><parameter>closure</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>doc_comment</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>return_type</parameter></methodparam>
@ -35,7 +35,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>funcname</parameter></term>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
Name of the function to be created
@ -43,7 +43,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arglist</parameter></term>
<term><parameter>argument_list</parameter></term>
<listitem>
<para>
Comma separated argument list

8
reference/runkit7/functions/runkit7-function-copy.xml
View file

@ -13,8 +13,8 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_function_copy</methodname>
<methodparam><type>string</type><parameter>funcname</parameter></methodparam>
<methodparam><type>string</type><parameter>targetname</parameter></methodparam>
<methodparam><type>string</type><parameter>source_name</parameter></methodparam>
<methodparam><type>string</type><parameter>target_name</parameter></methodparam>
</methodsynopsis>
</refsect1>
@ -22,7 +22,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>funcname</parameter></term>
<term><parameter>source_name</parameter></term>
<listitem>
<para>
Name of the existing function
@ -30,7 +30,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>targetname</parameter></term>
<term><parameter>target_name</parameter></term>
<listitem>
<para>
Name of the new function to copy the definition to

10
reference/runkit7/functions/runkit7-function-redefine.xml
View file

@ -13,8 +13,8 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_function_redefine</methodname>
<methodparam><type>string</type><parameter>funcname</parameter></methodparam>
<methodparam><type>string</type><parameter>arglist</parameter></methodparam>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
<methodparam><type>string</type><parameter>argument_list</parameter></methodparam>
<methodparam><type>string</type><parameter>code</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>return_by_reference</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>doc_comment</parameter><initializer>&null;</initializer></methodparam>
@ -23,7 +23,7 @@
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>runkit7_function_redefine</methodname>
<methodparam><type>string</type><parameter>funcname</parameter></methodparam>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
<methodparam><type>Closure</type><parameter>closure</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>doc_comment</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>return_type</parameter></methodparam>
@ -38,7 +38,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>funcname</parameter></term>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
Name of function to redefine
@ -46,7 +46,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arglist</parameter></term>
<term><parameter>argument_list</parameter></term>
<listitem>
<para>
New list of arguments to be accepted by function

4
reference/runkit7/functions/runkit7-function-remove.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_function_remove</methodname>
<methodparam><type>string</type><parameter>funcname</parameter></methodparam>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
</methodsynopsis>
&note.runkit.internal-override;
@ -24,7 +24,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>funcname</parameter></term>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
Name of the function to be deleted

8
reference/runkit7/functions/runkit7-function-rename.xml
View file

@ -13,8 +13,8 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_function_rename</methodname>
<methodparam><type>string</type><parameter>funcname</parameter></methodparam>
<methodparam><type>string</type><parameter>newname</parameter></methodparam>
<methodparam><type>string</type><parameter>source_name</parameter></methodparam>
<methodparam><type>string</type><parameter>target_name</parameter></methodparam>
</methodsynopsis>
&note.runkit.internal-override;
@ -25,7 +25,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>funcname</parameter></term>
<term><parameter>source_name</parameter></term>
<listitem>
<para>
Current function name
@ -33,7 +33,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newname</parameter></term>
<term><parameter>target_name</parameter></term>
<listitem>
<para>
New function name

6
reference/runkit7/functions/runkit7-import.xml
View file

@ -9,6 +9,12 @@
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<warning xmlns="http://docbook.org/ns/docbook">
<simpara>This feature has been <emphasis>removed</emphasis> in PECL runkit7 4.0.0.</simpara>
</warning>
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>

18
reference/runkit7/functions/runkit7-method-add.xml
View file

@ -11,9 +11,9 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_method_add</methodname>
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
<methodparam><type>string</type><parameter>methodname</parameter></methodparam>
<methodparam><type>string</type><parameter>args</parameter></methodparam>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam><type>string</type><parameter>method_name</parameter></methodparam>
<methodparam><type>string</type><parameter>argument_list</parameter></methodparam>
<methodparam><type>string</type><parameter>code</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>RUNKIT7_ACC_PUBLIC</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>doc_comment</parameter><initializer>&null;</initializer></methodparam>
@ -22,8 +22,8 @@
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>runkit7_method_add</methodname>
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
<methodparam><type>string</type><parameter>methodname</parameter></methodparam>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam><type>string</type><parameter>method_name</parameter></methodparam>
<methodparam><type>Closure</type><parameter>closure</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>RUNKIT7_ACC_PUBLIC</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>doc_comment</parameter><initializer>&null;</initializer></methodparam>
@ -35,7 +35,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>classname</parameter></term>
<term><parameter>class_name</parameter></term>
<listitem>
<para>
The class to which this method will be added
@ -43,7 +43,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>methodname</parameter></term>
<term><parameter>method_name</parameter></term>
<listitem>
<para>
The name of the method to add
@ -51,7 +51,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<term><parameter>argument_list</parameter></term>
<listitem>
<para>
Comma-delimited list of arguments for the newly-created method
@ -62,7 +62,7 @@
<term><parameter>code</parameter></term>
<listitem>
<para>
The code to be evaluated when <parameter>methodname</parameter>
The code to be evaluated when <parameter>method_name</parameter>
is called
</para>
</listitem>

18
reference/runkit7/functions/runkit7-method-copy.xml
View file

@ -11,10 +11,10 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_method_copy</methodname>
<methodparam><type>string</type><parameter>dClass</parameter></methodparam>
<methodparam><type>string</type><parameter>dMethod</parameter></methodparam>
<methodparam><type>string</type><parameter>sClass</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>sMethod</parameter></methodparam>
<methodparam><type>string</type><parameter>destination_class</parameter></methodparam>
<methodparam><type>string</type><parameter>destination_method_name</parameter></methodparam>
<methodparam><type>string</type><parameter>source_class</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>source_method_name</parameter></methodparam>
</methodsynopsis>
</refsect1>
@ -22,7 +22,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>dClass</parameter></term>
<term><parameter>destination_class</parameter></term>
<listitem>
<para>
Destination class for copied method
@ -30,7 +30,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dMethod</parameter></term>
<term><parameter>destination_method_name</parameter></term>
<listitem>
<para>
Destination method name
@ -38,7 +38,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sClass</parameter></term>
<term><parameter>source_class</parameter></term>
<listitem>
<para>
Source class of the method to copy
@ -46,11 +46,11 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sMethod</parameter></term>
<term><parameter>source_method_name</parameter></term>
<listitem>
<para>
Name of the method to copy from the source class. If this parameter is
omitted, the value of <parameter>dMethod</parameter> is assumed.
omitted, the value of <parameter>destination_method_name</parameter> is assumed.
</para>
</listitem>
</varlistentry>

18
reference/runkit7/functions/runkit7-method-redefine.xml
View file

@ -11,9 +11,9 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_method_redefine</methodname>
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
<methodparam><type>string</type><parameter>methodname</parameter></methodparam>
<methodparam><type>string</type><parameter>args</parameter></methodparam>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam><type>string</type><parameter>method_name</parameter></methodparam>
<methodparam><type>string</type><parameter>argument_list</parameter></methodparam>
<methodparam><type>string</type><parameter>code</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>RUNKIT7_ACC_PUBLIC</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>doc_comment</parameter><initializer>&null;</initializer></methodparam>
@ -22,8 +22,8 @@
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>runkit7_method_redefine</methodname>
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
<methodparam><type>string</type><parameter>methodname</parameter></methodparam>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam><type>string</type><parameter>method_name</parameter></methodparam>
<methodparam><type>Closure</type><parameter>closure</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>RUNKIT7_ACC_PUBLIC</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>doc_comment</parameter><initializer>&null;</initializer></methodparam>
@ -36,7 +36,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>classname</parameter></term>
<term><parameter>class_name</parameter></term>
<listitem>
<para>
The class in which to redefine the method
@ -44,7 +44,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>methodname</parameter></term>
<term><parameter>method_name</parameter></term>
<listitem>
<para>
The name of the method to redefine
@ -52,7 +52,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<term><parameter>argument_list</parameter></term>
<listitem>
<para>
Comma-delimited list of arguments for the redefined method
@ -63,7 +63,7 @@
<term><parameter>code</parameter></term>
<listitem>
<para>
The new code to be evaluated when <parameter>methodname</parameter>
The new code to be evaluated when <parameter>method_name</parameter>
is called
</para>
</listitem>

8
reference/runkit7/functions/runkit7-method-remove.xml
View file

@ -11,8 +11,8 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_method_remove</methodname>
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
<methodparam><type>string</type><parameter>methodname</parameter></methodparam>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam><type>string</type><parameter>method_name</parameter></methodparam>
</methodsynopsis>
&note.runkit.selfmanipulation;
</refsect1>
@ -21,7 +21,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>classname</parameter></term>
<term><parameter>class_name</parameter></term>
<listitem>
<para>
The class in which to remove the method
@ -29,7 +29,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>methodname</parameter></term>
<term><parameter>method_name</parameter></term>
<listitem>
<para>
The name of the method to remove

12
reference/runkit7/functions/runkit7-method-rename.xml
View file

@ -11,9 +11,9 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_method_rename</methodname>
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
<methodparam><type>string</type><parameter>methodname</parameter></methodparam>
<methodparam><type>string</type><parameter>newname</parameter></methodparam>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam><type>string</type><parameter>source_method_name</parameter></methodparam>
<methodparam><type>string</type><parameter>target_method_name</parameter></methodparam>
</methodsynopsis>
&note.runkit.selfmanipulation;
</refsect1>
@ -22,7 +22,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>classname</parameter></term>
<term><parameter>class_name</parameter></term>
<listitem>
<para>
The class in which to rename the method
@ -30,7 +30,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>methodname</parameter></term>
<term><parameter>source_method_name</parameter></term>
<listitem>
<para>
The name of the method to rename
@ -38,7 +38,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newname</parameter></term>
<term><parameter>target_method_name</parameter></term>
<listitem>
<para>
The new name to give to the renamed method