Skip to content

Commit 6a84a6b

Browse files
committed
[Sync-En] yaf: sync the whole extension with EN revision ddcf673
Mirrors php/doc-en#5809 (commit ddcf673) for reference/yaf. - Update 228 pages to the new EN revision: the many stub pages that only carried &warn.undocumented.func;, an empty <para> and a placeholder refpurpose are now fully translated, with the real signatures (union return types, optional parameters and their initializers), parameter and return sections, examples and seealso blocks. - Add 9 pages new in EN: Yaf_Dispatcher::getResponse/setResponse and the Yaf_Request_Abstract accessors (get, getCookie, getFiles, getPost, getQuery, getRaw, getRequest, isDelete, isPatch). - Drop the 17 pages removed upstream: Yaf_Application::__destruct, Yaf_Response_Abstract::__destruct and the Yaf_Request_Http / Yaf_Request_Simple accessors now documented on Yaf_Request_Abstract. - Remove the obsolete $Revision$, Reviewed and CREDITS markers, and harmonize the French wording used for the dispatcher. Comments and displayed strings inside the examples are translated and the <screen> outputs adjusted accordingly; the PHP code itself is unchanged. Fixes: #3387
1 parent 9c065ca commit 6a84a6b

301 files changed

Lines changed: 12852 additions & 6782 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

reference/yaf/appconfig.xml

Lines changed: 92 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: f4ff30a7a6a555fc825577d2cb877e3a07094d6b Maintainer: yannick Status: ready -->
3-
<!-- Reviewed: no -->
2+
<!-- EN-Revision: ddcf673c59d1708557680946fbffeee361d7fca6 Maintainer: yannick Status: ready -->
43

54
<chapter xml:id="yaf.appconfig" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
6-
<title xmlns="http://docbook.org/ns/docbook">Application Configuration</title>
5+
<title xmlns="http://docbook.org/ns/docbook">Configuration de l'application</title>
76
<para>
8-
Il faut fournir un tableau de configuration, ou un fichier
9-
au format ini de configuration (voir le chemin
10-
<classname>Yaf_Config_Ini</classname>) de la méthode
11-
<methodname>Yaf_Application::__construct</methodname>.
7+
Il faut fournir un tableau de configuration ou le chemin d'un fichier de
8+
configuration ini (voir <classname>Yaf_Config_Ini</classname>) à
9+
<methodname>Yaf_Application::__construct</methodname>.
1210
</para>
1311
<para>
14-
Yaf va fusionner automatiquement les configurations de l'application et
15-
celles de l'utilisateur. Les configurations d'application sont préfixées
16-
par "yaf." ou par "application.". Si à la fois "yaf." et "application." existent,
17-
"application." prendra l'avantage.
12+
Yaf fusionne automatiquement les configurations de l'application et celles
13+
de l'utilisateur. Les configurations de l'application ont le préfixe "yaf."
14+
ou "application.". Si "yaf." et "application." existent tous les deux,
15+
"application." est retenu en priorité.
1816
<example>
19-
<title>Exemple avec un tableau PHP</title>
17+
<title>Un exemple de tableau PHP</title>
2018
<programlisting role="php">
2119
<![CDATA[
2220
<?php
@@ -40,22 +38,52 @@ $app = new Yaf_Application($configs);
4038
</programlisting>
4139
</example>
4240
<example>
43-
<title>Exemple avec un fichier ini</title>
41+
<title>Un exemple de fichier ini</title>
4442
<programlisting role="ini">
4543
<![CDATA[
4644
[yaf]
4745
yaf.directory = APPLICATION_PATH "/application"
4846
yaf.dispatcher.catchException = 0
4947
5048
[product : yaf]
51-
; la configuration utilisateur va ici
49+
; la liste des configurations utilisateur ici
5250
]]>
5351
</programlisting>
5452
</example>
53+
<tip>
54+
<simpara>
55+
Lorsque la configuration devient volumineuse,
56+
<classname>Yaf_Config_Ini</classname>, qui analyse le fichier ini à chaque
57+
requête, représente un surcoût notable.
58+
<link xlink:href="&url.pecl.package;yaconf">Yaconf</link> analyse tous les
59+
fichiers ini d'un répertoire une seule fois au démarrage de PHP et
60+
conserve les valeurs analysées en mémoire partagée. Il faut définir
61+
<literal>yaconf.directory</literal> vers le dossier contenant la
62+
configuration, et passer le tableau retourné à
63+
<methodname>Yaf_Application::__construct</methodname> :
64+
</simpara>
65+
<programlisting role="php">
66+
<![CDATA[
67+
<?php
68+
// dans php.ini : yaconf.directory = /path/to/app/conf
69+
$app = new Yaf_Application(Yaconf::get("application"));
70+
?>
71+
]]>
72+
</programlisting>
73+
<simpara>
74+
Un fichier contenant des en-têtes <literal>[section]</literal> est exposé
75+
sous la forme d'une entrée par section (l'héritage, par exemple
76+
<literal>[product : yaf]</literal>, étant déjà résolu). Il est possible de
77+
récupérer une seule section avec un point,
78+
<literal>Yaconf::get("application.product")</literal>, et de passer ce
79+
tableau à la place ; ses clés sont exactement les entrées fusionnées de
80+
cette section.
81+
</simpara>
82+
</tip>
5583
</para>
5684
<para>
5785
<table>
58-
<title>Configuration d'application Yaf</title>
86+
<title>Configuration de l'application Yaf</title>
5987
<tgroup cols="3">
6088
<thead>
6189
<row>
@@ -161,15 +189,15 @@ yaf.dispatcher.catchException = 0
161189
</term>
162190
<listitem>
163191
<para>
164-
Le dossier de l'application ; il contient les dossiers
165-
"controllers", "views", "models" et "plugins".
192+
Le répertoire de l'application, c'est-à-dire le dossier qui contient
193+
les dossiers "controllers", "views", "models" et "plugins".
166194
</para>
167195
<para>
168196
<note>
169-
<para>
170-
Cette entrée de configuration est la seule qui n'a pas de valeur
171-
par défaut. Il faut toujours la définir manuellement.
172-
</para>
197+
<simpara>
198+
Cette entrée de configuration est la seule qui n'a pas de valeur
199+
par défaut. Il faut toujours la définir manuellement.
200+
</simpara>
173201
</note>
174202
</para>
175203
</listitem>
@@ -181,8 +209,8 @@ yaf.dispatcher.catchException = 0
181209
</term>
182210
<listitem>
183211
<para>
184-
L'extension de fichier du script PHP, utilisé dans la classe
185-
autoloading(<classname>Yaf_Loader</classname>).
212+
L'extension de fichier des scripts PHP, utilisée lors du chargement
213+
automatique des classes (<classname>Yaf_Loader</classname>).
186214
</para>
187215
</listitem>
188216
</varlistentry>
@@ -193,7 +221,7 @@ yaf.dispatcher.catchException = 0
193221
</term>
194222
<listitem>
195223
<para>
196-
L'extension du fichier de script du template de visualisation.
224+
L'extension de fichier des scripts de gabarit de vue.
197225
</para>
198226
</listitem>
199227
</varlistentry>
@@ -204,13 +232,13 @@ yaf.dispatcher.catchException = 0
204232
</term>
205233
<listitem>
206234
<para>
207-
Une liste séparée par une virgule de modules enregistrés, utilisés
208-
dans le processus de routage, et spécialement lorsqu'il y a plus de
209-
trois segments dans le PATH_INFO
235+
Une liste, séparée par des virgules, des modules enregistrés, utilisée
236+
lors du processus de routage, en particulier lorsqu'il y a plus de
237+
trois segments dans le PATH_INFO,
210238
</para>
211239
<para>
212-
Yaf doit avoir un moyen de savoir si le premier segment est un
213-
nom de module ou pas.
240+
Yaf a besoin d'un moyen de déterminer si le premier segment est un nom
241+
de module ou non.
214242
</para>
215243
</listitem>
216244
</varlistentry>
@@ -221,16 +249,17 @@ yaf.dispatcher.catchException = 0
221249
</term>
222250
<listitem>
223251
<para>
224-
Le dossier local de la bibliothèque, voir
252+
Le répertoire de la bibliothèque locale, voir
225253
<classname>Yaf_Loader</classname> et
226254
<link linkend="ini.yaf.library">yaf.library</link>.
227255
</para>
228256
<note>
229-
<para>
230-
Depuis Yaf 2.1.6, cette entrée de configuration peut être un tableau.
231-
Le chemin de la bibliothèque tente d'utiliser la valeur de <link
232-
linkend="configuration.yaf.library.directory">application.library.directory</link>
233-
</para>
257+
<simpara>
258+
À partir de Yaf 2.1.6, cette entrée de configuration peut être un
259+
tableau. Le chemin de la bibliothèque essaiera d'utiliser les
260+
éléments définis dans <link
261+
linkend="configuration.yaf.library.directory">application.library.directory</link>
262+
</simpara>
234263
</note>
235264
</listitem>
236265
</varlistentry>
@@ -242,8 +271,8 @@ yaf.dispatcher.catchException = 0
242271
<listitem>
243272
<para>
244273
Alias de <link
245-
linkend="configuration.yaf.library">application.library</link>.
246-
Introduit en Yaf 2.1.6.
274+
linkend="configuration.yaf.library">application.library</link>.
275+
Introduit en Yaf 2.1.6
247276
</para>
248277
</listitem>
249278
</varlistentry>
@@ -254,8 +283,8 @@ yaf.dispatcher.catchException = 0
254283
</term>
255284
<listitem>
256285
<para>
257-
Préfixes séparés par une virgule d'espace de noms locaux de
258-
la bibliothèque.
286+
Un préfixe, séparé par des virgules, du namespace de la bibliothèque
287+
locale.
259288
</para>
260289
<para>
261290
Introduit en Yaf 2.1.6
@@ -269,7 +298,7 @@ yaf.dispatcher.catchException = 0
269298
</term>
270299
<listitem>
271300
<para>
272-
Un chemin absolu du script de la classe Bootstrap.
301+
Un chemin absolu vers le script de la classe Bootstrap.
273302
</para>
274303
</listitem>
275304
</varlistentry>
@@ -280,11 +309,11 @@ yaf.dispatcher.catchException = 0
280309
</term>
281310
<listitem>
282311
<para>
283-
Utilisé pour supprimer un préfixe fixé d'une URI de requête
284-
dans le processus de routage. Par exemple, une requête
285-
dont l'URI est "/prefix/controller/action". Si on définit
286-
application.baseUri à "/prefix", alors seul "/controller/action"
287-
sera pris comme PATH_INFO dans le processus de routage.
312+
Utilisé pour retirer un préfixe fixe de l'URI de requête lors du
313+
processus de routage. Par exemple, si arrive une requête dont l'URI est
314+
"/prefix/controller/action", et que application.baseUri est définie à
315+
"/prefix", alors seul "/controller/action" sera pris comme PATH_INFO
316+
lors du processus de routage.
288317
</para>
289318
<para>
290319
En général, il n'est pas nécessaire de définir cette valeur.
@@ -298,8 +327,9 @@ yaf.dispatcher.catchException = 0
298327
</term>
299328
<listitem>
300329
<para>
301-
Si vaut On, Yaf lance une exception lorsqu'une erreur surviendra.
302-
Voir aussi la méthode <methodname>Yaf_Dispatcher::throwException</methodname>.
330+
Si elle est définie à On, Yaf lancera une exception lorsqu'une erreur
331+
se produit. Voir aussi
332+
<methodname>Yaf_Dispatcher::throwException</methodname>.
303333
</para>
304334
</listitem>
305335
</varlistentry>
@@ -310,9 +340,9 @@ yaf.dispatcher.catchException = 0
310340
</term>
311341
<listitem>
312342
<para>
313-
Si vaut On, Yaf transmettra les erreurs aux contrôleurs/actions,
314-
lorsqu'il rencontrera une exception non attrapable.
315-
Voir aussi la méthode <methodname>Yaf_Dispatcher::catchException</methodname>.
343+
Si elle est définie à On, Yaf redirigera vers le contrôleur/l'action
344+
Error lorsqu'il y a une exception non gérée. Voir aussi
345+
<methodname>Yaf_Dispatcher::catchException</methodname>.
316346
</para>
317347
</listitem>
318348
</varlistentry>
@@ -323,8 +353,9 @@ yaf.dispatcher.catchException = 0
323353
</term>
324354
<listitem>
325355
<para>
326-
La route par défaut, si elle n'est pas spécifiée, la route statique
327-
sera utilisée. Voir la méthode <methodname>Yaf_Router::addRoute</methodname>.
356+
La route par défaut ; si elle n'est pas spécifiée, la route Static sera
357+
utilisée par défaut. Voir :
358+
<methodname>Yaf_Router::addRoute</methodname>.
328359
</para>
329360
</listitem>
330361
</varlistentry>
@@ -335,7 +366,7 @@ yaf.dispatcher.catchException = 0
335366
</term>
336367
<listitem>
337368
<para>
338-
Le nom de module par défaut. Voir aussi la méthode
369+
Le nom du module par défaut, voir aussi
339370
<methodname>Yaf_Dispatcher::setDefaultModule</methodname>.
340371
</para>
341372
</listitem>
@@ -347,7 +378,7 @@ yaf.dispatcher.catchException = 0
347378
</term>
348379
<listitem>
349380
<para>
350-
Le nom par défaut du contrôleur. Voir aussi la méthode
381+
Le nom du contrôleur par défaut, voir aussi
351382
<methodname>Yaf_Dispatcher::setDefaultController</methodname>.
352383
</para>
353384
</listitem>
@@ -359,7 +390,7 @@ yaf.dispatcher.catchException = 0
359390
</term>
360391
<listitem>
361392
<para>
362-
Le nom par défaut de l'action. Voir aussi la méthode
393+
Le nom de l'action par défaut, voir aussi
363394
<methodname>Yaf_Dispatcher::setDefaultAction</methodname>.
364395
</para>
365396
</listitem>
@@ -372,14 +403,14 @@ yaf.dispatcher.catchException = 0
372403
</term>
373404
<listitem>
374405
<para>
375-
Définit une configuration Yaf au moment de l'exécution dans
376-
application.ini, comme ceci :
406+
Définit la configuration d'exécution de Yaf dans application.ini,
407+
comme :
377408
<link linkend="ini.yaf.lowcase-path">application.system.lowcase_path</link>
378409
<note>
379-
<para>
380-
seules les options de configuration <constant>INI_ALL</constant> peuvent
381-
être définies de cette façon.
382-
</para>
410+
<simpara>
411+
seules les configurations <constant>INI_ALL</constant> peuvent être
412+
définies de cette manière
413+
</simpara>
383414
</note>
384415
</para>
385416
</listitem>

reference/yaf/book.xml

Lines changed: 44 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,50 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: bd23019549a09eb15f5c772987c76781ab5f5f09 Maintainer: yannick Status: ready -->
2+
<!-- EN-Revision: ddcf673c59d1708557680946fbffeee361d7fca6 Maintainer: yannick Status: ready -->
33

44
<book xml:id="book.yaf" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<?phpdoc extension-membership="pecl" ?>
6-
<title>Yaf (i.e. Yet Another Framework)</title>
6+
<title>Yet Another Framework</title>
77
<titleabbrev>Yaf</titleabbrev>
8-
8+
99
<preface xml:id="intro.yaf">
1010
&reftitle.intro;
11-
<para>
12-
L'extension <literal>Yet Another Framework</literal>(<acronym>Yaf</acronym>)
13-
est un framework PHP, utilisé pour le développement d'application web.
14-
</para>
15-
<para>
16-
Un benchmark de Yaf peut être vu sur la page des <link
17-
xlink:href="&url.yaf.benchmarks;">performances Yaf</link>.
18-
</para>
19-
<para>
20-
Pour un démarrage rapide, se référer à ces <link
21-
linkend="yaf.tutorials">tutoriaux</link>.
22-
</para>
11+
<simpara>
12+
L'extension <literal>Yet Another Framework</literal>
13+
(<acronym>Yaf</acronym>) est un framework PHP utilisé pour développer
14+
des applications web.
15+
</simpara>
16+
<simpara>
17+
Contrairement aux frameworks PHP habituels, Yaf est écrit en C et compilé
18+
sous forme d'extension : les classes du framework, le chargeur automatique,
19+
le routeur et la boucle de distribution s'exécutent tous en code compilé,
20+
si bien que le coût du framework par requête se mesure en microsecondes
21+
plutôt qu'en millisecondes, et qu'aucun fichier PHP du framework n'est à
22+
charger. Il est conçu pour les applications à fort trafic où le coût
23+
d'amorçage compte, ainsi que pour les environnements d'exécution de
24+
services à longue durée de vie (tels que Swoole) où chaque requête
25+
nécessite un cycle de distribution vierge.
26+
</simpara>
27+
<simpara>
28+
Yaf implémente l'architecture <acronym>MVC</acronym> classique avec un
29+
script d'entrée unique, un fichier de configuration comportant des
30+
sections d'environnement, des points d'ancrage d'amorçage, un système de
31+
plugins doté de sept points d'ancrage de distribution, six types de routes
32+
intégrés, un chargeur automatique de style PSR-0
33+
(<classname>Yaf_Loader</classname>) et une vue légère à base de gabarits
34+
PHP (<classname>Yaf_View_Simple</classname>).
35+
</simpara>
36+
<simpara>
37+
Un benchmark simple de Yaf est disponible sur la page
38+
<link xlink:href="&url.yaf.benchmarks;">Performances de Yaf</link>. Pour un
39+
guide de démarrage rapide, se reporter à la section
40+
<link linkend="yaf.tutorials">Tutoriels</link>.
41+
</simpara>
42+
<note>
43+
<simpara>
44+
Yaf nécessite PHP 7.0 ou plus récent (la branche master de son dépôt de
45+
sources) ; une branche php5 prend en charge PHP 5.2 et plus récent.
46+
</simpara>
47+
</note>
2348
</preface>
2449

2550
&reference.yaf.setup;
@@ -57,14 +82,14 @@
5782
&reference.yaf.yaf-exception;
5883
&reference.yaf.yaf-exception-typeerror;
5984
&reference.yaf.yaf-exception-startuperror;
60-
&reference.yaf.yaf-exception-dispatchfailed;
85+
&reference.yaf.yaf-exception-dispatchfailed;
6186
&reference.yaf.yaf-exception-routerfailed;
62-
&reference.yaf.yaf-exception-loadfailed;
87+
&reference.yaf.yaf-exception-loadfailed;
6388
&reference.yaf.yaf-exception-loadfailed-module;
6489
&reference.yaf.yaf-exception-loadfailed-controller;
65-
&reference.yaf.yaf-exception-loadfailed-action;
90+
&reference.yaf.yaf-exception-loadfailed-action;
6691
&reference.yaf.yaf-exception-loadfailed-view;
67-
92+
6893
</book>
6994

7095
<!-- Keep this comment at the end of the file

0 commit comments

Comments
 (0)