-
Notifications
You must be signed in to change notification settings - Fork 157
/
Copy pathfunctions.xml
1784 lines (1631 loc) · 49.3 KB
/
functions.xml
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b8f3ae7da35b99b3137ff59aa5d86110dde607f4 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<chapter xml:id="language.functions" xmlns="http://docbook.org/ns/docbook">
<title>Les fonctions</title>
<sect1 xml:id="functions.user-defined">
<title>Les fonctions définies par l'utilisateur</title>
<para>
Une fonction est définie en utilisant le mot-clé <literal>function</literal>,
un nom, une liste de paramètres (qui peuvent être vides) séparés par des virgules
(<literal>,</literal>) entre parenthèses, suivis du corps de
la fonction entre accolades, comme suit :
</para>
<example>
<title>Déclaration d'une nouvelle fonction nommée <literal>foo</literal></title>
<programlisting role="php">
<![CDATA[
<?php
function foo($arg_1, $arg_2, /* ..., */ $arg_n)
{
echo "Exemple de fonction.\n";
return $retval;
}
?>
]]>
</programlisting>
</example>
<note>
<para>
À partir de PHP 8.0.0, la liste de paramètres peut avoir une virgule finale:
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
function foo($arg_1, $arg_2,) { }
?>
]]>
</programlisting>
</informalexample>
</para>
</note>
<simpara>
Tout code PHP valide peut apparaître à l'intérieur du corps d'une fonction, même d'autres
dans une fonction et dans des définitions de
<link linkend="language.oop5.basic.class">classe</link>.
</simpara>
<para>
Les noms de fonctions suivent les mêmes règles que les autres labels en PHP.
Un nom de fonction valide commence par une lettre ou un souligné, suivi
par un nombre quelconque de lettres, de nombres ou de soulignés.
Ces règles peuvent être représentées par l'expression rationnelle suivante :
<code>^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$</code>
</para>
&tip.userlandnaming;
<simpara>
Les fonctions n'ont pas besoin d'être définies avant d'être utilisées,
<emphasis>SAUF</emphasis> lorsqu'une fonction est définie
conditionnellement, comme montré dans les deux exemples suivants.
</simpara>
<para>
Lorsqu'une fonction est définie de manière conditionnelle, comme dans
les exemples ci-dessous, leur définition doit <emphasis>précéder</emphasis>
leur utilisation.
</para>
<para>
<example>
<title>Fonctions conditionnelles</title>
<programlisting role="php">
<![CDATA[
<?php
$makefoo = true;
/* Impossible d'appeler foo() ici,
car cette fonction n'existe pas.
Mais nous pouvons utiliser bar() */
bar();
if ($makefoo) {
function foo()
{
echo "Je n'existe pas tant que le programme n'est pas passé ici.\n";
}
}
/* Maintenant, nous pouvons appeler foo()
car $makefoo est évalué à vrai */
if ($makefoo) foo();
function bar()
{
echo "J'existe dès le début du programme.\n";
}
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Fonctions dans une autre fonction</title>
<programlisting role="php">
<![CDATA[
<?php
function foo()
{
function bar()
{
echo "Je n'existe pas tant que foo() n'est pas appelé.\n";
}
}
/* Impossible d'appeler bar() ici
car il n'existe pas. */
foo();
/* Maintenant, nous pouvons appeler bar(),
car l'utilisation de foo() l'a rendue
accessible. */
bar();
?>
]]>
</programlisting>
</example>
</para>
<para>
Toutes les fonctions et classes en PHP ont une portée globale - elles
peuvent être appelées à l'extérieur d'une fonction si elles ont été définies
à l'intérieur et vice-versa.
</para>
<simpara>
PHP ne supporte pas la surcharge, la destruction et la redéfinition de
fonctions déjà déclarées.
</simpara>
<note>
<simpara>
Les noms de fonctions sont insensibles à la casse pour les caractères ASCII
<literal>A</literal> à <literal>Z</literal>,
et il est généralement admis que les fonctions doivent
être appelées avec le nom utilisé dans leur déclaration,
y compris la casse.
</simpara>
</note>
<simpara>
Les <link linkend="functions.variable-arg-list">
listes variables d'arguments de fonction</link> et les
<link linkend="functions.arguments.default">valeurs par défaut
d'arguments</link> sont supportés : voir
les fonctions de références que sont
<function>func_num_args</function>,
<function>func_get_arg</function>, et
<function>func_get_args</function> pour plus d'informations.
</simpara>
<para>
Il est possible d'appeler des fonctions récursives en PHP.
<example>
<title>Fonctions récursives</title>
<programlisting role="php">
<![CDATA[
<?php
function recursion($a)
{
if ($a < 20) {
echo "$a\n";
recursion($a + 1);
}
}
?>
]]>
</programlisting>
</example>
<note>
<simpara>
Les appels de méthodes/fonctions récursives avec 100-200 degrés de
récursivité peuvent remplir la pile et ainsi, terminer le script courant.
À noter qu'une récursion infinie est considérée comme une erreur de
programmation.
</simpara>
</note>
</para>
</sect1>
<sect1 xml:id="functions.arguments">
<title>Paramètres et arguments de fonction</title>
<simpara>
Les paramètres de la fonction sont déclarés dans la signature de la fonction.
Des informations peuvent être passées à
une fonction en utilisant une liste d'arguments, dont chaque
expression est séparée par une virgule. Les arguments seront
évalués de gauche à droite, et le résultat est assigné aux paramètres de
la fonction, avant que la fonction ne soit effectivement appelée
(évaluation <emphasis>immédiate</emphasis>).
</simpara>
<!-- Note: this paragraph feels like it should be moved to the syntax part? -->
<para>
PHP supporte le passage d'arguments par valeur (comportement par défaut), <link
linkend="functions.arguments.by-reference">le passage par référence</link>, et <link
linkend="functions.arguments.default">des valeurs d'arguments par défaut</link>.
Une <link linkend="functions.variable-arg-list">liste variable d'arguments</link>,
ainsi que les <link linkend="functions.named-arguments">Arguments Nommés</link>
sont également supportés.
</para>
<note>
<para>
À partir de PHP 7.3.0, il est possible d'avoir une virgule finale dans la liste d'arguments
pour les appels de fonction :
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$v = foo(
$arg_1,
$arg_2,
);
?>
]]>
</programlisting>
</informalexample>
</para>
</note>
<para>
À partir de PHP 8.0.0, la liste des arguments de fonction peut inclure une
virgule trainante, qui sera ignoré. Ceci est particulièrement pratique dans
les cas où la liste d'arguments est longue ou contient des noms de variables
longs, le rendant pratique pour lister les arguments verticalement.
</para>
<example>
<title>Liste des paramètres de la fonction avec une virgule finale</title>
<programlisting role="php">
<![CDATA[
<?php
function takes_many_args(
$first_arg,
$second_arg,
$a_very_long_argument_name,
$arg_with_default = 5,
$again = 'a default string', // Cette virgule trainant n'était pas permit avant 8.0.0.
)
{
// ...
}
?>
]]>
</programlisting>
</example>
<sect2 xml:id="functions.arguments.by-reference">
<title>Passage d'arguments par référence</title>
<simpara>
Par défaut, les arguments sont passés
à la fonction par valeur (aussi, changer la valeur d'un argument dans la fonction ne
change pas sa valeur à l'extérieur de la fonction). Si vous voulez que vos fonctions
puissent changer la valeur des arguments, vous devez passer ces arguments par référence.
</simpara>
<para>
Si vous voulez qu'un argument soit toujours passé
par référence, vous pouvez ajouter un '<literal>&</literal>'
devant le paramètre dans la déclaration de la fonction :
</para>
<para>
<example>
<title>Passage des arguments de fonction par référence</title>
<programlisting role="php">
<![CDATA[
<?php
function add_some_extra(&$string)
{
$string .= ', et un peu plus.';
}
$str = 'Ceci est une chaîne';
add_some_extra($str);
echo $str; // Affiche : 'Ceci est une chaîne, et un peu plus.'
?>
]]>
</programlisting>
</example>
</para>
<para>
Il est incorrect de passer une expression constante comme argument à un paramètre qui attend d'être passé par référence.
</para>
</sect2>
<sect2 xml:id="functions.arguments.default">
<title>Valeurs par défaut des paramètres</title>
<para>
Une fonction peut définir des valeurs par défaut pour les paramètres en utilisant une syntaxe similaire
à celle de l'affectation d'une variable. La valeur par défaut est utilisée uniquement lorsque l'argument du paramètre n'est
pas passé. Notez que passer &null; ne <emphasis>définit pas</emphasis>
la valeur par défaut.
</para>
<para>
<example>
<title>Valeur par défaut des arguments de fonctions</title>
<programlisting role="php">
<![CDATA[
<?php
function servir_cafe ($type = "cappuccino")
{
return "Servir un $type.\n";
}
echo servir_cafe();
echo servir_cafe(null);
echo servir_cafe("espresso");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Servir un cappuccino.
Servir un .
Servir un espresso.
]]>
</screen>
</example>
</para>
<para>
Les valeurs par défaut des paramètres peuvent être des valeurs scalaires,
des &array;s, le type spécial &null;, et à partir de PHP 8.1.0,
des objets utilisant la syntaxe <link linkend="language.oop5.basic.new">new ClassName()</link>.
</para>
<para>
<example>
<title>Utilisation de type non-scalaire comme valeur par défaut</title>
<programlisting role="php">
<![CDATA[
<?php
function servir_cafe($types = array("cappuccino"), $coffeeMaker = NULL)
{
$device = is_null($coffeeMaker) ? "les mains" : $coffeeMaker;
return "Préparation d'une tasse de ".join(", ", $types)." avec $device.\n";
}
echo servir_cafe();
echo servir_cafe(array("cappuccino", "lavazza"), "une cafetière");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Préparation d'une tasse de cappuccino avec les mains.
Préparation d'une tasse de cappuccino, lavazza avec une cafetière.
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Utilisation d'objets comme valeurs par défaut (à partir de PHP 8.1.0)</title>
<programlisting role="php">
<![CDATA[
<?php
class DefaultCoffeeMaker {
public function brew() {
return 'Faire du café.\n';
}
}
class FancyCoffeeMaker {
public function brew() {
return 'Créer un beau café rien que pour vous.\n';
}
}
function makecoffee($coffeeMaker = new DefaultCoffeeMaker)
{
return $coffeeMaker->brew();
}
echo makecoffee();
echo makecoffee(new FancyCoffeeMaker);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Faire du café.
Créer un beau café rien que pour vous.
]]>
</screen>
</example>
</para>
<simpara>
La valeur par défaut d'un argument doit
obligatoirement être une constante, et ne peut être
ni une variable, ni un membre de classe, ni un appel de fonction.
</simpara>
<para>
Notez que tous les paramètres optionnels doivent être spécifiés après les
paramètres obligatoires, sinon ils ne peuvent pas être omis dans les appels.
Considérons le code suivant :
</para>
<para>
<example>
<title>Utilisation incorrecte des paramètres de fonction par défaut</title>
<programlisting role="php">
<![CDATA[
<?php
function faireunyaourt ($container = "bol", $flavour)
{
return "Préparer un $container de yaourt à la $flavour.\n";
}
echo faireunyaourt("framboise"); // "framboise" est $container, pas $flavour
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Fatal error: Uncaught ArgumentCountError: Too few arguments
to function faireunyaourt(), 1 passed in example.php on line 42
]]>
</screen>
</example>
</para>
<para>
Maintenant comparons l'exemple précédent avec l'exemple suivant :
</para>
<para>
<example>
<title>Utilisation correcte des paramètres de fonction par défaut</title>
<programlisting role="php">
<![CDATA[
<?php
function faireunyaourt ($flavour, $container = "bol")
{
return "Préparer un $container de yaourt à la $flavour.\n";
}
echo faireunyaourt ("framboise"); // "framboise" est $flavour
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Préparer un bol de yaourt à la framboise.
]]>
</screen>
</example>
</para>
<para>
À partir de PHP 8.0.0, les <link linkend="functions.named-arguments">arguments nommés</link>
peuvent être utilisées pour passer outre plusieurs paramètres optionnels.
</para>
<para>
<example>
<title>Utilisation correcte des paramètres de fonction par défaut</title>
<programlisting role="php">
<![CDATA[
<?php
function faireunyaourt($container = "bol", $flavour = "framboise", $style = "Grec")
{
return "Préparer un $container de yaourt $style à la $flavour.\n";
}
echo faireunyaourt(style: "naturel");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Préparer un bol de yaourt naturel à la framboise.
]]>
</screen>
</example>
</para>
<para>
À partir de PHP 8.0.0, déclarer des paramètres obligatoires après des arguments optionnels est <emphasis>obsolète</emphasis>.
Ce problème peut généralement être résolu en abandonnant la valeur par défaut, puisqu'elle ne sera jamais utilisée.
Une exception à cette règle concerne les paramètres de la forme <code>Type $param = null</code>,
où le &null; par défaut rend le type implicitement nullable.
Cet usage est déprécié depuis PHP 8.4.0, et un
<link linkend="language.types.declarations.nullable">type nullable</link>
explicite doit être utilisé à la place.
<example>
<title>Déclaration des paramètres optionnels après les paramètres obligatoires</title>
<programlisting role="php">
<![CDATA[
<?php
function foo($a = [], $b) {} // Valeur par défaut non utilisée ; déconseillée à partir de PHP 8.0.0
function foo($a, $b) {} // Fonctionnellement équivalent, pas d’avertissement de dépréciation
function bar(A $a = null, $b) {} // À partir de PHP 8.1.0, $a est implicitement requis
// (car il précède un paramètre requis),
// mais implicitement nullable (déconseillé à partir de PHP 8.4.0),
// car la valeur par défaut du paramètre est null
function bar(?A $a, $b) {} // Recommandé
?>
]]>
</programlisting>
</example>
</para>
<note>
<simpara>
À partir de PHP 7.1.0, l'omission d'un paramètre qui ne spécifie pas une valeur par défaut lance
un <classname>ArgumentCountError</classname> ;
dans les versions précédentes, cela levait un avertissement.
</simpara>
</note>
<note>
<simpara>
Les arguments passés par référence peuvent avoir
une valeur par défaut.
</simpara>
</note>
</sect2>
<sect2 xml:id="functions.variable-arg-list">
<title>Liste d'argument à nombre variable</title>
<simpara>
PHP supporte les arguments à nombre variable dans les
fonctions défini par l'utilisateur en utilisant le token
<literal>...</literal>.
</simpara>
<para>
La liste des arguments peut inclure le
token <literal>...</literal> pour indiquer que cette fonction accepte
un nombre variable d'arguments. Les arguments seront passés dans la variable
fournie sous forme d'un &array;:
<example>
<title>Utilisation de <literal>...</literal> pour accéder aux arguments variables</title>
<programlisting role="php">
<![CDATA[
<?php
function sum(...$numbers) {
$acc = 0;
foreach ($numbers as $n) {
$acc += $n;
}
return $acc;
}
echo sum(1, 2, 3, 4);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
10
]]>
</screen>
</example>
</para>
<para>
<literal>...</literal> peut aussi être utilisé lors des appels de
fonctions pour extraire le &array; ou la variable
<classname>Traversable</classname> ou le littéral dans la liste d'arguments :
<example>
<title>Utilisation de <literal>...</literal> pour fournir des arguments</title>
<programlisting role="php">
<![CDATA[
<?php
function add($a, $b) {
return $a + $b;
}
echo add(...[1, 2])."\n";
$a = [1, 2];
echo add(...$a);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
3
3
]]>
</screen>
</example>
</para>
<para>
Vous pouvez spécifier des paramètres classiques avant le mot clé
<literal>...</literal>. Dans ce cas, seuls les arguments finaux
qui ne correspondent pas à un argument classique seront ajoutés
au tableau généré par <literal>...</literal>.
</para>
<para>
Il est également possible d'ajouter une
<link linkend="language.types.declarations">déclaration de type</link>
avant le jeton <literal>...</literal>. Si ceci est présent,
alors tous les arguments capturés par <literal>...</literal>
doivent correspondre au type de paramètre.
<example>
<title>Transtypage d'arguments variables</title>
<programlisting role="php">
<![CDATA[
<?php
function total_intervals($unit, DateInterval ...$intervals) {
$time = 0;
foreach ($intervals as $interval) {
$time += $interval->$unit;
}
return $time;
}
$a = new DateInterval('P1D');
$b = new DateInterval('P2D');
echo total_intervals('d', $a, $b).' jours';
// Ceci échouera, car null n'est pas un objet DateInterval.
echo total_intervals('d', null);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
3 jours
Catchable fatal error: Argument 2 passed to total_intervals() must be an instance of DateInterval, null given, called in - on line 14 and defined in - on line 2
]]>
</screen>
</example>
</para>
<para>
Pour finir, vous pouvez passer des arguments variables
<link linkend="functions.arguments.by-reference">par référence</link>
en préfixant le mot clé <literal>...</literal> d'un ET commercial
(<literal>&</literal>).
</para>
</sect2>
<sect2 xml:id="functions.named-arguments">
<title>Arguments Nommés</title>
<para>
PHP 8.0.0 introduit les arguments nommés comme extension aux paramètres
positionnels existant. Les arguments nommés permettent de passer les
arguments à une fonction en s'appuyant sur le nom du paramètre, au lieu de
la position du paramètre. Ceci documente automatiquement la signification
de l'argument, rend l'ordre des arguments indépendant et permet d'ignorer
les valeurs par défaut arbitrairement.
</para>
<para>
Les arguments nommés sont passés en préfixant la valeur avec le nom du
paramètre suivit d'un deux-points. Utiliser des mots-clés réservés comme
nom de paramètre est autorisé. Le nom du paramètre doit être un identifiant,
le spécifiant de façon dynamique n'est pas permis.
</para>
<example>
<title>Syntaxe des arguments nommés</title>
<programlisting role="php">
<![CDATA[
<?php
myFunction(paramName: $value);
array_foobar(array: $value);
// NON supporté.
function_name($variableStoringParamName: $value);
?>
]]>
</programlisting>
</example>
<example>
<title>Arguments positionnels comparés aux arguments nommés</title>
<programlisting role="php">
<![CDATA[
<?php
// Utilisant les arguments positionnels :
array_fill(0, 100, 50);
// Utilisant les arguments nommés :
array_fill(start_index: 0, count: 100, value: 50);
?>
]]>
</programlisting>
</example>
<para>
L'ordre dans lequel les arguments nommés sont passés n'importe pas.
</para>
<example>
<title>Même exemple que ci-dessus, mais avec un ordre de paramètre différent</title>
<programlisting role="php">
<![CDATA[
<?php
array_fill(value: 50, count: 100, start_index: 0);
?>
]]>
</programlisting>
</example>
<para>
Les arguments nommés peuvent être combinés avec les arguments positionnels.
Auquel cas, les arguments nommés doivent venir après les arguments positionnels.
Il est aussi possible de spécifier seulement certains des arguments optionnels
d'une fonction, peu importe leur ordre.
</para>
<example>
<title>Combiner les arguments nommés avec les arguments positionnels</title>
<programlisting role="php">
<![CDATA[
<?php
htmlspecialchars($string, double_encode: false);
// Same as
htmlspecialchars($string, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401, 'UTF-8', false);
?>
]]>
</programlisting>
</example>
<para>
Passer le même argument plusieurs fois résulte en une
<classname>Error</classname> exception.
</para>
<example>
<title>Erreur déclenchée lorsqu'un argument est passé plusieurs fois au même paramètre nommé</title>
<programlisting role="php">
<![CDATA[
<?php
function foo($param) { ... }
foo(param: 1, param: 2);
// Error: Named parameter $param overwrites previous argument
foo(1, param: 2);
// Error: Named parameter $param overwrites previous argument
?>
]]>
</programlisting>
</example>
<para>
À partir de PHP 8.1.0, il est possible d'utiliser des arguments nommés après avoir décompressé les arguments.
Un argument nommé <emphasis>ne doit pas</emphasis> écraser un argument déjà déballé.
</para>
<example>
<title>Utiliser les arguments nommés après le déballage</title>
<programlisting role="php">
<![CDATA[
<?php
function foo($a, $b, $c = 3, $d = 4) {
return $a + $b + $c + $d;
}
var_dump(foo(...[1, 2], d: 40)); // 46
var_dump(foo(...['b' => 2, 'a' => 1], d: 40)); // 46
var_dump(foo(...[1, 2], b: 20)); // Erreur fatale. Le paramètre nommé $b écrase l'argument précédent.
?>
]]>
</programlisting>
</example>
</sect2>
</sect1>
<sect1 xml:id="functions.returning-values">
<title>Les valeurs de retour</title>
<para>
Les valeurs sont renvoyées en utilisant une
instruction de retour optionnelle. Tous les types de variables
peuvent être renvoyés, tableaux et objets compris. Cela fait
que la fonction finit son exécution immédiatement et passe
le contrôle à la ligne appelante. Voir
<function>return</function>
pour plus d'informations.
</para>
<note>
<para>
Si <function>return</function>
est omis, la valeur &null; sera retournée.
</para>
</note>
<sect2>
<title>Utilisation de return</title>
<para>
<example>
<title>Utilisation de <function>return</function></title>
<programlisting role="php">
<![CDATA[
<?php
function carre($num)
{
return $num * $num;
}
echo carre(4); // Affiche '16'
?>
]]>
</programlisting>
</example>
</para>
<para>
Une fonction ne peut pas renvoyer plusieurs valeurs en même temps, mais
vous pouvez obtenir le même résultat en renvoyant un tableau.
</para>
<para>
<example>
<title>Retourner un tableau d'une fonction</title>
<programlisting role="php">
<![CDATA[
<?php
function petit_nombre()
{
return [0, 1, 2];
}
// La déconstruction d'un tableau collectera chaque membre du tableau individuellement
[$zero, $one, $two] = petit_nombre();
// Antérieur à PHP 7.1, la seule alternative équivalente est en utilisant la structure de langage list()
list ($zero, $un, $deux) = petit_nombre();
?>
]]>
</programlisting>
</example>
</para>
<para>
Pour retourner une référence d'une fonction, utilisez
l'opérateur & aussi bien dans la déclaration de la fonction que dans
l'assignation de la valeur de retour.
</para>
<para>
<example>
<title>Retourner une référence d'une fonction</title>
<programlisting role="php">
<![CDATA[
<?php
function &retourne_reference()
{
return $uneref;
}
$newref =& retourne_reference();
?>
]]>
</programlisting>
</example>
</para>
<simpara>
Pour plus d'informations sur les références, référez-vous à <link
linkend="language.references">l'explication sur les références</link>.
</simpara>
</sect2>
</sect1>
<sect1 xml:id="functions.variable-functions">
<title>Fonctions variables</title>
<para>
PHP supporte le concept de fonctions variables.
Cela signifie que si le nom d'une variable est suivi de parenthèses,
PHP recherchera une fonction de même nom et essaiera de l'exécuter.
Cela peut servir, entre autres, pour faire des fonctions de rappel, des tables de fonctions...
</para>
<para>
Les fonctions variables ne peuvent pas fonctionner avec les
éléments de langage comme les
<function>echo</function>, <function>print</function>,
<function>unset</function>, <function>isset</function>,
<function>empty</function>, <function>include</function>,
<function>require</function> etc. Vous devez utiliser votre
propre gestion de fonctions pour utiliser un de ces éléments
de langage comme fonctions variables.
</para>
<para>
<example>
<title>Exemple de fonction variable</title>
<programlisting role="php">
<![CDATA[
<?php
function foo() {
echo "dans foo()<br />\n";
}
function bar($arg = '')
{
echo "Dans bar(); l'argument était '$arg'.<br />\n";
}
// Ceci est une fonction détournée de echo
function echoit($string)
{
echo $string;
}
$func = 'foo';
$func(); // Appel foo()
$func = 'bar';
$func('test'); // Appel bar()
$func = 'echoit';
$func('test'); // Appel echoit()
?>
]]>
</programlisting>
</example>
</para>
<para>
Vous pouvez aussi appeler les méthodes d'un objet en utilisant le système des
fonctions variables.
<example>
<title>Exemple de méthode variable</title>
<programlisting role="php">
<![CDATA[
<?php
class Foo
{
function Variable()
{
$name = 'Bar';
$this->$name(); // Appelle la méthode Bar()
}
function Bar()
{
echo "C'est Bar";
}
}
$foo = new Foo();
$funcname = "Variable";
$foo->$funcname(); // Appelle $foo->Variable()
?>
]]>
</programlisting>
</example>
</para>
<para>
Lors de l'appel à des méthodes statiques, l'appel de fonction est meilleur que
l'opérateur de propriété statique :
<example>
<title>Exemple de méthode variable avec des propriétés statiques</title>
<programlisting role="php">
<![CDATA[
<?php
class Foo
{
static $variable = 'static property';
static function Variable()
{
echo 'Method Variable called';
}
}
echo Foo::$variable; // Ceci affiche 'static property'. Il est nécessaire d'avoir une $variable dans le contexte.
$variable = "Variable";
Foo::$variable(); // Ceci appelle $foo->Variable(), lisant ainsi la $variable depuis le contexte.
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>callables complexe</title>
<programlisting role="php">
<![CDATA[
<?php
class Foo
{
static function bar()
{
echo "bar\n";
}
function baz()
{
echo "baz\n";
}
}