-
Notifications
You must be signed in to change notification settings - Fork 165
Expand file tree
/
Copy pathis-callable.xml
More file actions
234 lines (211 loc) · 6.22 KB
/
is-callable.xml
File metadata and controls
234 lines (211 loc) · 6.22 KB
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 32c55286c8739fd20de9c8624473b2f3268de68e Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.is-callable" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>is_callable</refname>
<refpurpose>
Détermine si une valeur peut être appelé comme une fonction
dans la portée courante
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>is_callable</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>syntax_only</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter role="reference">callable_name</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Vérifie que <parameter>value</parameter> est un <type>callable</type>,
ou qu'il peut être appelé à l'aide de la fonction
<function>call_user_func</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
La valeur à vérifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>syntax_only</parameter></term>
<listitem>
<para>
Si l'argument <parameter>syntax_only</parameter> vaut &true;, la
fonction ne va vérifier que si <parameter>value</parameter> peut être
une fonction ou une méthode. Il rejettera toutes les valeurs
qui ne sont pas des objets <link linkend="object.invoke">invocables</link>,
des <classname>Closure</classname>, des &string;s, ou des &array;s qui n'ont pas
une structure valide pour être utilisées comme un callback. Un tableau appelable valide
contient 2 entrées : la première doit être un objet
ou une chaîne de caractères, et la seconde une chaîne de caractères.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callable_name</parameter></term>
<listitem>
<para>
Reçoit le "nom de la fonction callable", par exemple
<literal>"SomeClass::someMethod"</literal>. Notez cependant que,
malgré l'implication selon laquelle <literal>SomeClass::someMethod()</literal>
est une méthode statique callable, ce n'est pas le cas.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne &true; si <parameter>value</parameter> peut être appelé comme
une fonction, &false; sinon.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Vérification si une chaîne peut être appelée comme une fonction</title>
<programlisting role="php">
<![CDATA[
<?php
function someFunction() {}
$functionVariable = 'someFunction';
var_dump(is_callable($functionVariable, false, $callable_name));
var_dump($callable_name);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(true)
string(12) "someFunction"
]]>
</screen>
</example>
<example>
<title>Vérification si un tableau peut être appelé comme une fonction</title>
<programlisting role="php">
<![CDATA[
<?php
class someClass
{
public function someMethod() {}
}
$anObject = new SomeClass();
$methodVariable = [$anObject, 'someMethod'];
var_dump(is_callable($methodVariable, true, $callable_name));
var_dump($callable_name);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(true)
string(21) "SomeClass::someMethod"
]]>
</screen>
</example>
<example>
<title><function>is_callable</function> et les constructeurs</title>
<simpara>
Malgré le fait que les constructeurs sont les méthodes qui sont appelées lorsqu'un objet est créé,
ils ne sont pas des méthodes statiques et
<function>is_callable</function> retournera &false; pour eux. Il n'est pas
possible d'utiliser <function>is_callable</function> pour vérifier si une classe peut
être instanciée depuis la portée actuelle.
</simpara>
<programlisting role="php">
<![CDATA[
<?php
class Foo
{
public function __construct() {}
public function foo() {}
}
var_dump(
is_callable(['Foo', '__construct']),
is_callable(['Foo', 'foo'])
);
$foo = new Foo();
var_dump(is_callable([$foo, '__construct']));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(false)
bool(false)
bool(true)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<simplelist>
<member>
Un objet est tout le temps appelable s'il implémente
<link linkend="object.invoke">__invoke()</link>, et que la méthode est visible
dans la portée courante.
</member>
<member>Un nom de classe est appelable s'il implémente
<link linkend="object.callstatic">__callStatic()</link>
</member>
<member>
Si un objet implémente <link linkend="object.call">__call()</link>, alors cette fonction
retournera &true; pour n'importe quelle méthode sur cet objet, même si
la méthode n'est pas définie.
</member>
<member>
Cette fonction peut déclencher l'autochargement si appelé avec le nom
d'une classe.
</member>
</simplelist>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>call_user_func</function></member>
<member><function>function_exists</function></member>
<member><function>method_exists</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
-->