1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.runkit7-method-add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>runkit7_method_add</refname>
<refpurpose>Dynamically adds a new method to a given class</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>runkit7_method_add</methodname>
<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>
<methodparam choice="opt"><type>string</type><parameter>return_type</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_strict</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>runkit7_method_add</methodname>
<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>
<methodparam choice="opt"><type>string</type><parameter>return_type</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_strict</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>class_name</parameter></term>
<listitem>
<para>
The class to which this method will be added
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>method_name</parameter></term>
<listitem>
<para>
The name of the method to add
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>argument_list</parameter></term>
<listitem>
<para>
Comma-delimited list of arguments for the newly-created method
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>code</parameter></term>
<listitem>
<para>
The code to be evaluated when <parameter>method_name</parameter>
is called
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>closure</parameter></term>
<listitem>
<para>
A <classname>closure</classname> that defines the method.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
The type of method to create, can be
<constant>RUNKIT7_ACC_PUBLIC</constant>,
<constant>RUNKIT7_ACC_PROTECTED</constant> or
<constant>RUNKIT7_ACC_PRIVATE</constant> optionally combined via bitwise OR with
<constant>RUNKIT7_ACC_STATIC</constant>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>doc_comment</parameter></term>
<listitem>
<para>
The doc comment of the method.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>return_type</parameter></term>
<listitem>
<para>
The return type of the method.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>is_strict</parameter></term>
<listitem>
<para>
Whether the method behaves as if it were declared in a file with <literal>strict_types=1</literal>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>runkit7_method_add</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
class Example {
function foo() {
echo "foo!\n";
}
}
// create an Example object
$e = new Example();
// Add a new public method
runkit7_method_add(
'Example',
'add',
'$num1, $num2',
'return $num1 + $num2;',
RUNKIT7_ACC_PUBLIC
);
// add 12 + 4
echo $e->add(12, 4);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
16
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>runkit7_method_copy</function></member>
<member><function>runkit7_method_redefine</function></member>
<member><function>runkit7_method_remove</function></member>
<member><function>runkit7_method_rename</function></member>
<member><function>runkit7_function_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:"~/.phpdoc/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
-->
|
