doc-en/reference/uopz/functions/uopz-add-function.xml at master · php/doc-en · GitHub

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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.uopz-add-function" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>uopz_add_function</refname>
  <refpurpose>Adds non-existent function or method</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="procedural">
   <type>bool</type><methodname>uopz_add_function</methodname>
   <methodparam><type>string</type><parameter>function</parameter></methodparam>
   <methodparam><type>Closure</type><parameter>handler</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">flags</parameter><initializer>ZEND_ACC_PUBLIC</initializer></methodparam>
  </methodsynopsis>
  <methodsynopsis role="procedural">
   <type>bool</type><methodname>uopz_add_function</methodname>
   <methodparam><type>string</type><parameter>class</parameter></methodparam>
   <methodparam><type>string</type><parameter>function</parameter></methodparam>
   <methodparam><type>Closure</type><parameter>handler</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">flags</parameter><initializer>ZEND_ACC_PUBLIC</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">all</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Adds a non-existent function or method.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>class</parameter></term>
    <listitem>
     <para>
      The name of the class.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>function</parameter></term>
    <listitem>
     <para>
      The name of the function or method.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>handler</parameter></term>
    <listitem>
     <para>
      The <classname>Closure</classname> that defines the new function or method.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>flags</parameter></term>
    <listitem>
     <para>
      Flags to set for the new function or method.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>all</parameter></term>
    <listitem>
     <para>
      Whether all classes that descend from <parameter>class</parameter> will
      also be affected.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <function>uopz_add_function</function> throws a <classname>RuntimeException</classname>
   if the function or method to add already exists.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="uopz-add-function.example.basic">
   <title>Basic <function>uopz_add_function</function> Usage</title>
   <programlisting role="php">
<![CDATA[
<?php
uopz_add_function('foo', function () {echo 'bar';});
foo();
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
bar
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>uopz_del_function</function></member>
   <member><function>uopz_set_return</function></member>
  </simplelist>
 </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
-->