File: runkit-method-copy.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (134 lines) | stat: -rw-r--r-- 3,453 bytes parent folder | download
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.runkit-method-copy" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>runkit_method_copy</refname>
  <refpurpose>Copies a method from class to another</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>runkit_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>
  </methodsynopsis>
  &warn.experimental.func;
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dClass</parameter></term>
     <listitem>
      <para>
       Destination class for copied method
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dMethod</parameter></term>
     <listitem>
      <para>
       Destination method name
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sClass</parameter></term>
     <listitem>
      <para>
       Source class of the method to copy
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sMethod</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.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <!-- No changelog: it's only in PECL. -->
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>runkit_method_copy</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
class Foo {
    function example() {
        return "foo!\n";
    }
}

class Bar {
    // initially, no methods
}

// copy the example() method from the Foo class to the Bar class, as baz()
runkit_method_copy('Bar', 'baz', 'Foo', 'example');

// output copied function
echo Bar::baz();
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
foo!
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>runkit_method_add</function></member>
    <member><function>runkit_method_redefine</function></member>
    <member><function>runkit_method_remove</function></member>
    <member><function>runkit_method_rename</function></member>
    <member><function>runkit_function_copy</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
-->